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

Class /purchased_discount

Object contains information about the subscription discounts owned by the account. This includes account level discounts as well as service level discounts.

Notes

  • The system will assign poid ids above 1000 to objects of this class. The range below this is reserved for creating objects with well-known poid ids.
  • 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_CYCLE_END_T
timestamp PIN_FLD_CYCLE_START_T
poid PIN_FLD_DEAL_OBJ
string PIN_FLD_NODE_LOCATION
string PIN_FLD_DESCR
int PIN_FLD_PACKAGE_ID
poid PIN_FLD_PLAN_OBJ
poid PIN_FLD_DISCOUNT_OBJ
timestamp PIN_FLD_PURCHASE_END_T
timestamp PIN_FLD_PURCHASE_START_T
decimal PIN_FLD_QUANTITY
poid PIN_FLD_SERVICE_OBJ
enum PIN_FLD_STATUS
int PIN_FLD_STATUS_FLAGS
timestamp PIN_FLD_USAGE_END_T
timestamp PIN_FLD_USAGE_START_T
enum PIN_FLD_OBJECT_CACHE_TYPE
timestamp PIN_FLD_INSTANTIATED_T
int PIN_FLD_FLAGS
int PIN_FLD_PURCHASE_START_DETAILS
int PIN_FLD_CYCLE_START_DETAILS
int PIN_FLD_USAGE_START_DETAILS
int PIN_FLD_PURCHASE_END_DETAILS
int PIN_FLD_CYCLE_END_DETAILS
int PIN_FLD_USAGE_END_DETAILS
string PIN_FLD_STR_VAL
enum PIN_FLD_MODE
poid PIN_FLD_OFFERING_OVERRIDE_VALUES_OBJ
int PIN_FLD_GRACE_PERIOD
string PIN_FLD_UNIQUE_ID


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

Link to the /account object.

Notes

  • Required on object creation
  • Cannot be modified

Links

timestamp PIN_FLD_EFFECTIVE_T

Effective time of modification of this discount instance.

Notes

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

Links

timestamp PIN_FLD_CYCLE_END_T

Date to stop discounting cycle events with this discount instance. Discount can be active in account, but this discount instance will not be used for cycle events after this date

Notes

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

Links

timestamp PIN_FLD_CYCLE_START_T

Date to start discounting cycle events with this discount instance. Discount can be active in account, but this discount instance will not be used for cycle events before this date.

Notes

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

Links

poid PIN_FLD_DEAL_OBJ

Link to deal object that was purchased containing this discount.

Notes

  • Can be specified on object creation
  • Can be modified

Links

string PIN_FLD_NODE_LOCATION

Only used for backward compatability. Of the form deal-id~discount-id, where deal id & discount-id are two unique string identifiers formed using Hostname#PID/TID #Date-TimeStamp.Millisecond-timestamp. The field uniquely identifies a discount instance in an account.

Notes

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

Links

string PIN_FLD_DESCR

Notes

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

Links

int PIN_FLD_PACKAGE_ID

This field is common for all product/discount instances purchased as part of deal or plan purchase. In case of deal purchase, all products/discounts within the deal will have the same package id. In case of plan purchase, all the products/discounts within the plan, will share the same package id.

Notes

  • Can be specified on object creation
  • Can be modified

Links

poid PIN_FLD_PLAN_OBJ

Link to plan object that was purchased containing this discount. NULL means discount was purchased at deal level only. If the discount is associated with any promotion, this field will refer to purchased bundle object.

Notes

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

Links

poid PIN_FLD_DISCOUNT_OBJ

Link to discount object that is represented by this element.

Notes

  • Can be specified on object creation
  • Can be modified

Links

timestamp PIN_FLD_PURCHASE_END_T

Date when the discount is no longer valid for use.

Notes

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

Links

timestamp PIN_FLD_PURCHASE_START_T

Date from which the discount is valid for use.

Notes

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

Links

decimal PIN_FLD_QUANTITY

Quantity of discount owned. Quantity is used in assessing purchase, cycle and cancellation event.

Notes

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

Links

poid PIN_FLD_SERVICE_OBJ

Link to service object that owns this discount. NULL means the discount is owned by the account, not by a specific service object.

Notes

  • Can be specified on object creation
  • Can be modified

Links

enum PIN_FLD_STATUS

Status of this discount. Legal values are NOT_SET(0), ACTIVE(1), INACTIVE(2), CANCELLED(3).

Notes

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

Links

int PIN_FLD_STATUS_FLAGS

Modifier flags for discount status. Used to track states of PENDING during provisioning workflow. Flags are customer-definable.

Notes

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

Links

timestamp PIN_FLD_USAGE_END_T

Date that this discount stops discounting usage events. Discount may remain active in account, but usage events will not be discounted using this instance after this date

Notes

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

Links

timestamp PIN_FLD_USAGE_START_T

Date that this discount begins discounting usage events. Before this date, discount may be active in account but no usage events will be discounted using this instance

Notes

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

Links

enum PIN_FLD_OBJECT_CACHE_TYPE

Stores the cache residency distinction value for an object instance. Possible values are DEFAULT(0), REALTIME(1) and BATCH(2).

Notes

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

Links

timestamp PIN_FLD_INSTANTIATED_T

For the discounts that have the first usage attribute for Purchase, this field will be set with actual purchase time and will be used to filter the discounts for events prior to their subscription (for backdated/future dated scenarios).

Notes

  • Can be specified on object creation
  • Can be modified

Links

int PIN_FLD_FLAGS

Internal state flags to set first usage flag, deal resource grant as group and discount validity rounding flag.

Notes

  • Can be specified on object creation
  • Can be modified

Links

int PIN_FLD_PURCHASE_START_DETAILS

For the discounts whose purchase start is set for first usage it will be encoded with mode(first usage), unit and offset. Mode will be lower order 8 bits , unit will be 4 bits and offset will be 20 bits. The possible mode values are first usage and unit can be Seconds=1, Minutes=2, Hours=3, Days=4, Months=5 and Accounting Cycles=8.

Notes

  • Can be specified on object creation
  • Can be modified

Links

int PIN_FLD_CYCLE_START_DETAILS

For the discounts whose cycle start is set for first usage it will be encoded with mode(first usage), unit and offset. Mode will be lower order 8 bits , unit will be 4 bits and offset will be 20 bits. The possible mode values are first usage and unit can be Seconds=1, Minutes=2, Hours=3, Days=4, Months=5 and Accounting Cycles=8.

Notes

  • Can be specified on object creation
  • Can be modified

Links

int PIN_FLD_USAGE_START_DETAILS

For the discounts whose usage start is set for first usage it will be encoded with mode(first usage), unit and offset mode will be lower order 8 bits , unit will be 4 bits and offset will be 20 bits,the possible mode values are first usage and unit can be Seconds=1, Minutes=2, Hours=3, Days=4, Months=5 and Accounting Cycles=8.

Notes

  • Can be specified on object creation
  • Can be modified

Links

int PIN_FLD_PURCHASE_END_DETAILS

For the discounts, if purchase start is set for first usage this field will be encoded with with mode, unit and offset. For relative end dates mode will be lower order 8 bits, unit will be 4 bits and offset will be 20 bits. The possible mode values are never, relative to start date and unit can be Seconds=1, Minutes=2, Hours=3, Days=4, Months=5 and Accounting Cycles=8.

Notes

  • Can be specified on object creation
  • Can be modified

Links

int PIN_FLD_CYCLE_END_DETAILS

For the discounts, if cycle start is set for first usage this field will be encoded with with mode, unit and offset. For relative end dates mode will be lower order 8 bits, unit will be 4 bits and offset will be 20 bits. The possible mode values are never, relative to start date and unit can be Seconds=1, Minutes=2, Hours=3, Days=4, Months=5 and Accounting Cycles=8.

Notes

  • Can be specified on object creation
  • Can be modified

Links

int PIN_FLD_USAGE_END_DETAILS

For the discounts, if usage start is set for first usage this field will be encoded with with mode, unit and offset. For relative end dates mode will be lower order 8 bits, unit will be 4 bits and offset will be 20 bits. The possible mode values are never, relative to start date and unit can be Seconds=1, Minutes=2, Hours=3, Days=4, Months=5 and Accounting Cycles=8.

Notes

  • Can be specified on object creation
  • Can be modified

Links

string PIN_FLD_STR_VAL

This field will carry the information of inactivation and reactivation timestamps.It will be in follwoing format<type>#<timeStamp1,timestamp2,...Here type specifies 1 meaning activation, or 2 meaning inactivationIf type is 1 timestamp 1 is activation time and timestamp 2is inactivation and so on. If type is 2 it signifies timestamp1 is inactivation and timestamp2 is activation and so on.

Notes

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

Links

enum PIN_FLD_MODE

Mode of purchase discount Values: 0 - DEFAULT, 1 - Longest Date, 2 - Extend, 3 - Overwrite

Notes

  • Can be specified on object creation
  • Can be modified

Links

poid PIN_FLD_OFFERING_OVERRIDE_VALUES_OBJ

Link to the offering override object for this discount.

Notes

  • Can be specified on object creation
  • Can be modified

Links

int PIN_FLD_GRACE_PERIOD

Grace period defined with this offering

Notes

  • Can be specified on object creation
  • Can be modified

Links

string PIN_FLD_UNIQUE_ID

It is a unique identifier which is used as external id

Notes

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

Links



SQL Mapping


Type Field Name Table Column Name
base-class /purchased_discount purchased_discount_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_CYCLE_END_T cycle_end_t
timestamp PIN_FLD_CYCLE_START_T cycle_start_t
poid PIN_FLD_DEAL_OBJ deal_obj*
string PIN_FLD_NODE_LOCATION node_location
string PIN_FLD_DESCR descr
int PIN_FLD_PACKAGE_ID package_id
poid PIN_FLD_PLAN_OBJ plan_obj*
poid PIN_FLD_DISCOUNT_OBJ discount_obj*
timestamp PIN_FLD_PURCHASE_END_T purchase_end_t
timestamp PIN_FLD_PURCHASE_START_T purchase_start_t
decimal PIN_FLD_QUANTITY quantity
poid PIN_FLD_SERVICE_OBJ service_obj*
enum PIN_FLD_STATUS status
int PIN_FLD_STATUS_FLAGS status_flags
timestamp PIN_FLD_USAGE_END_T usage_end_t
timestamp PIN_FLD_USAGE_START_T usage_start_t
enum PIN_FLD_OBJECT_CACHE_TYPE object_cache_type
timestamp PIN_FLD_INSTANTIATED_T instantiated_t
int PIN_FLD_FLAGS flags
int PIN_FLD_PURCHASE_START_DETAILS purchase_start_details
int PIN_FLD_CYCLE_START_DETAILS cycle_start_details
int PIN_FLD_USAGE_START_DETAILS usage_start_details
int PIN_FLD_PURCHASE_END_DETAILS purchase_end_details
int PIN_FLD_CYCLE_END_DETAILS cycle_end_details
int PIN_FLD_USAGE_END_DETAILS usage_end_details
string PIN_FLD_STR_VAL str_val
enum PIN_FLD_MODE purchase_mode
poid PIN_FLD_OFFERING_OVERRIDE_VALUES_OBJ offering_override_values_obj*
int PIN_FLD_GRACE_PERIOD grace_period
string PIN_FLD_UNIQUE_ID unique_id
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