Copyright © 2024, Oracle and/or its affiliates.
Field Index SQL Mapping

Class /subscriber_contract

Stores /subscriber_contract contract objects

Notes

  • This object can be read by the owner or any billing group leader within the brand who is an ancestor of the owner.
  • This object can be modified by the owner or any billing group leader within the brand who is an ancestor of the owner.
  • This object can be created by anyone.

Links



Field Index

Type Field Name
poid PIN_FLD_POID
timestamp PIN_FLD_CREATED_T
timestamp PIN_FLD_MOD_T
string PIN_FLD_READ_ACCESS
string PIN_FLD_WRITE_ACCESS
string PIN_FLD_CREATE_ACCESS
poid PIN_FLD_ACCOUNT_OBJ
timestamp PIN_FLD_EFFECTIVE_T
timestamp PIN_FLD_CONTRACT_START_T
timestamp PIN_FLD_CONTRACT_END_T
timestamp PIN_FLD_EFFECTIVE_END_T
string PIN_FLD_DESCR
int PIN_FLD_EARLY_TERMINATION_ALLOWED
int PIN_FLD_RENEW_FLAGS
string PIN_FLD_SUBSCRIPTION_TERMS_NAME
poid PIN_FLD_SUBSCRIPTION_TERMS_OBJ
poid PIN_FLD_PLAN_CONTRACT_OBJ
poid PIN_FLD_GROUP_CONTRACT_OBJ
poid PIN_FLD_PRICING_OBJ
poid PIN_FLD_AUTO_RENEW_PRICING_OBJ
poid PIN_FLD_AUTO_RENEW_SUBS_TERMS_OBJ
timestamp PIN_FLD_TERMINATION_GRACE_START_T
timestamp PIN_FLD_TERMINATION_GRACE_END_T
int PIN_FLD_PACKAGE_ID
enum PIN_FLD_STATUS
int PIN_FLD_CONTRACT_FLAGS
int PIN_FLD_STATUS_FLAGS
enum PIN_FLD_PENALTY_OPTIONS
decimal PIN_FLD_PENALTY_AMOUNT
poid PIN_FLD_PREV_CONTRACT_OBJ
timestamp PIN_FLD_PREV_CONTRACT_START_T
timestamp PIN_FLD_PREV_CONTRACT_END_T
poid PIN_FLD_NEXT_CONTRACT_OBJ
timestamp PIN_FLD_NEXT_CONTRACT_START_T
timestamp PIN_FLD_NEXT_CONTRACT_END_T
timestamp PIN_FLD_MINIMUM_CONTRACT_END_T


Field Details

poid PIN_FLD_POID

Object Identifier for an instance of this class. Portal object ids have four pieces of information: database number, class type, sequence id, revision.

Notes

  • System defined on object creation
  • Can be modified only by System

Links

timestamp PIN_FLD_CREATED_T

Time the object was created.

Notes

  • System defined on object creation
  • Can be modified only by System

Links

timestamp PIN_FLD_MOD_T

Time the object was last modified.

Notes

  • System defined on object creation
  • Can be modified only by System

Links

string PIN_FLD_READ_ACCESS

Read Access level for object. Valid values are S(Self), G(Global), L(BrandLineage), B(BrandGroup), A(Ancestral).

Notes

  • System defined on object creation
  • Can be modified only by System
  • Maximum length is 255 bytes

Links

string PIN_FLD_WRITE_ACCESS

Write Access level for object. Valid values are S(Self), G(Global), L(BrandLineage), B(BrandGroup), A(Ancestral).

Notes

  • System defined on object creation
  • Can be modified only by System
  • Maximum length is 255 bytes

Links

string PIN_FLD_CREATE_ACCESS

Create Access level for object. Valid values are O(BrandOwner), R(Root), N(Any).

Notes

  • System defined on object creation
  • Can be modified only by System
  • Maximum length is 255 bytes

Links

poid PIN_FLD_ACCOUNT_OBJ

Subscriber Account object associated with this object

Notes

  • Required on object creation
  • Can be modified

Links

timestamp PIN_FLD_EFFECTIVE_T

Effective time of modification of the contract.

Notes

  • Required on object creation
  • Can be modified

Links

timestamp PIN_FLD_CONTRACT_START_T

Start time of the contract

Notes

  • Required on object creation
  • Can be modified

Links

timestamp PIN_FLD_CONTRACT_END_T

Time when the contract will end (0=contract has no defined end date)

Notes

  • Can be specified on object creation
  • Can be modified

Links

timestamp PIN_FLD_EFFECTIVE_END_T

Time when contract actually ended. This is different from contract_end_t upon early termination of the contract

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

string PIN_FLD_DESCR

User-defined description of the subscriber_contract.

Notes

  • Can be specified on object creation
  • Can be modified
  • Maximum length is 255 bytes

Links

int PIN_FLD_EARLY_TERMINATION_ALLOWED

Specifies whether early termination allowed or not allowed

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

int PIN_FLD_RENEW_FLAGS

Renewal flags(0=renewal disabled, 1=renewal enabled,2=evergreen)

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

string PIN_FLD_SUBSCRIPTION_TERMS_NAME

Subscription Terms Name .

Notes

  • Required on object creation
  • Can be modified
  • Maximum length is 60 bytes

Links

poid PIN_FLD_SUBSCRIPTION_TERMS_OBJ

Subscription_terms object associated with this subscriber_contract

Notes

  • Required on object creation
  • Can be modified

Links

poid PIN_FLD_PLAN_CONTRACT_OBJ

Contract associated with the Plan.

Notes

  • Can be specified on object creation
  • Can be modified

Links

poid PIN_FLD_GROUP_CONTRACT_OBJ

Contract associated with the group.

Notes

  • Can be specified on object creation
  • Can be modified

Links

poid PIN_FLD_PRICING_OBJ

Plan or Deal associated with the contract.

Notes

  • Can be specified on object creation
  • Can be modified

Links

poid PIN_FLD_AUTO_RENEW_PRICING_OBJ

Plan or Deal used when auto renew.

Notes

  • Can be specified on object creation
  • Can be modified

Links

poid PIN_FLD_AUTO_RENEW_SUBS_TERMS_OBJ

Subscription_terms used when auto renew.

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

timestamp PIN_FLD_TERMINATION_GRACE_START_T

Termination Grace Start time

Notes

  • Can be specified on object creation
  • Can be modified

Links

timestamp PIN_FLD_TERMINATION_GRACE_END_T

Termination Grace End time

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

int PIN_FLD_PACKAGE_ID

Package ID is same for all the purchased_products and purchased_discounts for the subscriber contract

Notes

  • Required on object creation
  • Can be modified

Links

enum PIN_FLD_STATUS

Contract status (1=active, 2=suspended, 3=finished, 4=closed, 5=grace period, 6=cancelled)

Notes

  • Can be specified on object creation
  • Can be modified

Links

int PIN_FLD_CONTRACT_FLAGS

Flags for contract features (0=PIN_CONTRACT_REVENUE_DISTRIBUTION_DISABLED, 1=PIN_CONTRACT_REVENUE_DISTRIBUTION_ENABLED)

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

int PIN_FLD_STATUS_FLAGS

For error handling, indicates that an error occurred (1=PIN_CONTRACT_ERROR)

Notes

  • Can be specified on object creation
  • Can be modified

Links

enum PIN_FLD_PENALTY_OPTIONS

penalty options. At the time of contract termination how the penalty charges should be calculatedPossible values are 0 - Apply Fixed penalty charge configured as penalty amount, 1 - Calculate proration of penalty amount based on number of FULL MONTHS completed of the contract 2 - Calculate based on remaining contract balance 3 - Calculated based on remaining contract balance and fixed penalty charge configured 4 - Calculated based on remaining contract balance and prorated penalty charge configured

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

decimal PIN_FLD_PENALTY_AMOUNT

penalty fees. At early terimation time, penalty charges are computed based on penalty options and penalty fees

Notes

  • Can be specified on object creation
  • Can be modified

Links

poid PIN_FLD_PREV_CONTRACT_OBJ

Previous contract object, either the previous phase of the current, or a different contract.

Notes

  • Can be specified on object creation
  • Can be modified

Links

timestamp PIN_FLD_PREV_CONTRACT_START_T

Previous contract start time

Notes

  • Can be specified on object creation
  • Can be modified

Links

timestamp PIN_FLD_PREV_CONTRACT_END_T

Previous contract end time

Notes

  • Can be specified on object creation
  • Can be modified

Links

poid PIN_FLD_NEXT_CONTRACT_OBJ

Next contract object, either the next phase of the current, or a different contract.

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

timestamp PIN_FLD_NEXT_CONTRACT_START_T

Next contract start time

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

timestamp PIN_FLD_NEXT_CONTRACT_END_T

Next contract end time

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

timestamp PIN_FLD_MINIMUM_CONTRACT_END_T

Time at which the Minimum period ends for the contract

Notes

  • Can be specified on object creation
  • Can be modified

Links



SQL Mapping


Type Field Name Table Column Name
base-class /subscriber_contract subscriber_contract_t
poid PIN_FLD_POID poid*
timestamp PIN_FLD_CREATED_T created_t
timestamp PIN_FLD_MOD_T mod_t
string PIN_FLD_READ_ACCESS read_access
string PIN_FLD_WRITE_ACCESS wrtie_access
string PIN_FLD_CREATE_ACCESS create_access
poid PIN_FLD_ACCOUNT_OBJ account_obj*
timestamp PIN_FLD_EFFECTIVE_T effective_t
timestamp PIN_FLD_CONTRACT_START_T contract_start_t
timestamp PIN_FLD_CONTRACT_END_T contract_end_t
timestamp PIN_FLD_EFFECTIVE_END_T effective_end_t
string PIN_FLD_DESCR descr
int PIN_FLD_EARLY_TERMINATION_ALLOWED early_termination_allowed
int PIN_FLD_RENEW_FLAGS renew_flags
string PIN_FLD_SUBSCRIPTION_TERMS_NAME subscription_terms_name
poid PIN_FLD_SUBSCRIPTION_TERMS_OBJ subscription_terms_obj*
poid PIN_FLD_PLAN_CONTRACT_OBJ plan_contract_obj*
poid PIN_FLD_GROUP_CONTRACT_OBJ group_contract_obj*
poid PIN_FLD_PRICING_OBJ pricing_obj*
poid PIN_FLD_AUTO_RENEW_PRICING_OBJ auto_renew_pricing_obj*
poid PIN_FLD_AUTO_RENEW_SUBS_TERMS_OBJ auto_renew_subs_terms_obj*
timestamp PIN_FLD_TERMINATION_GRACE_START_T termination_grace_start_t
timestamp PIN_FLD_TERMINATION_GRACE_END_T termination_grace_end_t
int PIN_FLD_PACKAGE_ID package_id
enum PIN_FLD_STATUS status
int PIN_FLD_CONTRACT_FLAGS contract_flags
int PIN_FLD_STATUS_FLAGS status_flags
enum PIN_FLD_PENALTY_OPTIONS penalty_options
decimal PIN_FLD_PENALTY_AMOUNT penalty_amount
poid PIN_FLD_PREV_CONTRACT_OBJ prev_contract_obj*
timestamp PIN_FLD_PREV_CONTRACT_START_T prev_contract_start_t
timestamp PIN_FLD_PREV_CONTRACT_END_T prev_contract_end_t
poid PIN_FLD_NEXT_CONTRACT_OBJ next_contract_obj*
timestamp PIN_FLD_NEXT_CONTRACT_START_T next_contract_start_t
timestamp PIN_FLD_NEXT_CONTRACT_END_T next_contract_end_t
timestamp PIN_FLD_MINIMUM_CONTRACT_END_T minimum_contract_end_t
Column names marked with * are actually column prefixes. For poid type fields, the column prefix is used to create the columns poid_id0, poid_db and poid_type if the prefix is "poid". For PIN_FLD_POID in the base table, an additional column named poid_rev is created to hold the poid revision. For buffer fields, two columns are created - one in the containing table and one in the buffer table. For example if the prefix is "buf", then the column name in the buffer table is buffer_buf and the column name in the containing table is buffer_size.

Field Index This Class