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

Class /purchased_product

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

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
poid PIN_FLD_BASE_PRODUCT_OBJ
decimal PIN_FLD_CYCLE_DISCOUNT
decimal PIN_FLD_CYCLE_DISC_AMT
decimal PIN_FLD_CYCLE_FEE_AMT
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
int PIN_FLD_CALENDAR_DOM
int PIN_FLD_FLAGS
int PIN_FLD_MMC_TYPE
poid PIN_FLD_OFFERING_OVERRIDE_VALUES_OBJ
array PIN_FLD_CYCLE_FEES
timestamp
timestamp
timestamp
timestamp
enum
int
timestamp
string
poid PIN_FLD_PLAN_OBJ
poid PIN_FLD_PRODUCT_OBJ
decimal PIN_FLD_PURCHASE_DISCOUNT
decimal PIN_FLD_PURCHASE_DISC_AMT
decimal PIN_FLD_PURCHASE_FEE_AMT
timestamp PIN_FLD_PURCHASE_END_T
timestamp PIN_FLD_PURCHASE_START_T
decimal PIN_FLD_QUANTITY
poid PIN_FLD_SERVICE_OBJ
poid PIN_FLD_SPONSOR_OBJ
enum PIN_FLD_STATUS
int PIN_FLD_STATUS_FLAGS
decimal PIN_FLD_USAGE_DISCOUNT
timestamp PIN_FLD_USAGE_END_T
timestamp PIN_FLD_USAGE_START_T
int PIN_FLD_CYCLE_FEE_FLAGS
enum PIN_FLD_OBJECT_CACHE_TYPE
timestamp PIN_FLD_INSTANTIATED_T
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
poid PIN_FLD_OVERRIDDEN_OBJ
string PIN_FLD_PRICE_LIST_NAME
enum PIN_FLD_MODE
int PIN_FLD_RENEWAL_MODE
int PIN_FLD_GRACE_PERIOD
int PIN_FLD_RETRY_COUNT
timestamp PIN_FLD_NEXT_RETRY_T
timestamp PIN_FLD_LAST_NOTIFICATION_T
string PIN_FLD_LAST_NOTIFICATION_OFFSET
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 product instance.

Notes

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

Links

poid PIN_FLD_BASE_PRODUCT_OBJ

Link to the base product object.

Notes

  • Can be specified on object creation
  • Can be modified

Links

decimal PIN_FLD_CYCLE_DISCOUNT

Percentage discount for cycle fees. Stored as fractional discount between 0 and 1.

Notes

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

Links

decimal PIN_FLD_CYCLE_DISC_AMT

Fixed amount discount for cycle fees. Amount is in primary currency of account. Amount is subtracted from cycle fee event but discount will at most reduce cost of cycle fee to zero.

Notes

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

Links

decimal PIN_FLD_CYCLE_FEE_AMT

Cycle fee (both forward and arrears) be applied for this product. Amount specified here will override the price specified in the /rate object

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 charging cycle fees for product. Product remains active in account but cycle fees are waived after this date. Zero means do not stop charging cycle fees.

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 charging cycle fees for product. Product can be active in account but cycle fees are waived until 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 product.

Notes

  • Can be specified on object creation
  • Can be modified

Links

string PIN_FLD_NODE_LOCATION

Only used for backward compatibility. Of the form deal-id~prod-id, where deal id & prod-id are two unique string identifiers formed using Hostname#PID/TID #Date-TimeStamp.Millisecond-timestamp. The field uniquely identifies a product 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
  • 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

int PIN_FLD_CALENDAR_DOM

Offer purchase on specific day of month

Notes

  • Can be specified on object creation
  • Can be modified

Links

int PIN_FLD_FLAGS

Internal state flags for tracking delayed fees that have been charged.

Notes

  • Can be specified on object creation
  • Can be modified

Links

int PIN_FLD_MMC_TYPE

Only kept for backward compatibility. Type of multi-month cycle currently in progress. Legal values are None (0), Monthly (1), Bimonthly (2), Quarterly (3), Semiannual (6), Annual (12).

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 product.

Notes

  • Can be specified on object creation
  • Can be modified

Links

array PIN_FLD_CYCLE_FEES

Array of cycle fees dates for each rate plan

Notes

  • Can be specified on object creation
  • Can be modified

Links

timestamp PIN_FLD_CHARGED_FROM_T

Start date that the cycle fee should be charged.

Notes

Links

timestamp PIN_FLD_CHARGED_TO_T

End date that the cycle fee should be charged.

Notes

Links

timestamp PIN_FLD_CYCLE_FEE_START_T

Start date of the cycle, similar to actg_last_t for montly cycles

Notes

Links

timestamp PIN_FLD_CYCLE_FEE_END_T

End date of the cycle, similar to actg_next_t for montly cycles

Notes

Links

enum PIN_FLD_UNIT

Unit of Measure for Cycle forward events. Days/Weeks/Months/Years.

Notes

Links

int PIN_FLD_COUNT

Frequency/count of accounting cycles of cycle events

Notes

Links

timestamp PIN_FLD_LAST_NOTIFICATION_T

The last time this object was processed/checked for subscription renewal due notification.

Notes

Links

string PIN_FLD_LAST_NOTIFICATION_OFFSET

The offset with which the last time this object was processed/checked for subscription renewal due notification.

Notes

Links

poid PIN_FLD_PLAN_OBJ

Link to plan object that was purchased containing this product. NULL means product was purchased at deal level only. If the product 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_PRODUCT_OBJ

Link to product object that is represented by this element.

Notes

  • Can be specified on object creation
  • Can be modified

Links

decimal PIN_FLD_PURCHASE_DISCOUNT

Percentage discount for purchase and cancellation fees. Stored as fractional discount between 0 and 1.

Notes

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

Links

decimal PIN_FLD_PURCHASE_DISC_AMT

Fixed amount discount for purchase and cancellation fees. Amount is in primary currency of account. Amount is subtracted from event but discount will at most reduce cost of cycle fee to zero.

Notes

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

Links

decimal PIN_FLD_PURCHASE_FEE_AMT

Purchase fee be applied for this product. Amount specified here will override the price specified in the /rate object

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_END_T

Date when the product 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 when the product is valid for use. Purchase fees are applied on this date.

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 product owned. Quantity is used in assessing purchase, cycle and cancellation fees.

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 product. NULL means the product is owned by the account, not by a specific service object.

Notes

  • Can be specified on object creation
  • Can be modified

Links

poid PIN_FLD_SPONSOR_OBJ

Link to sponsorship group for this product. NULL means product is not sponsored.

Notes

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

Links

enum PIN_FLD_STATUS

Status of this product. Legal values are NOT_SET(0), ACTIVE(1), INACTIVE(2), CANCELLED(3). Only active products are assessed for cycle fees and participate in usage rating. For delayed usage events, Cancelled products are also considered.

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 product 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

decimal PIN_FLD_USAGE_DISCOUNT

Percentage discount for usage events rated by this product. Stored as fractional discount between 0 and 1. There is no fixed amount discount for usage because different types of usage may be rated by one product.

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_END_T

Date that this product stops rating usage events. Product may remain active in account, but usage rates from this product will not be used past 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 product begins rating usage events. Before this date, product may be active in account but no usage rates from the product will be used to rate usage events.

Notes

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

Links

int PIN_FLD_CYCLE_FEE_FLAGS

Internal flags for tracking cycle forward fees. Each cycle forward category has its own bit. Initially all flags will be zero. As soon as some of the cycle forward category will be applied for the first time the corresponding flag will be set to 1.

Notes

  • Can be specified on object creation
  • Can be 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 products that have the first usage attribute for Purchase, this field will be set with actual purchase time and will be used to filter the products 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_PURCHASE_START_DETAILS

For the products 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 products 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 products 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 products, 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 products, 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

poid PIN_FLD_OVERRIDDEN_OBJ

Poid of base purchased product.

Notes

  • Can be specified on object creation
  • Can be modified

Links

string PIN_FLD_PRICE_LIST_NAME

Price list name associated with this offering.

Notes

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

Links

enum PIN_FLD_MODE

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

Notes

  • Can be specified on object creation
  • Can be modified

Links

int PIN_FLD_RENEWAL_MODE

Renewal of offer based on renewal mode during product re-activation

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

int PIN_FLD_RETRY_COUNT

Retry count to keep track of failed number of attempts for subscription

Notes

  • Can be specified on object creation
  • Can be modified

Links

timestamp PIN_FLD_NEXT_RETRY_T

The date to accept next retry during rental failure.

Notes

  • Can be specified on object creation
  • Can be modified

Links

timestamp PIN_FLD_LAST_NOTIFICATION_T

The last time this object was processed/checked for product expiry notification.

Notes

  • Can be specified on object creation
  • Can be modified

Links

string PIN_FLD_LAST_NOTIFICATION_OFFSET

The offset with which the last time this object was processed/checked for product expiry notification.

Notes

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

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_product purchased_product_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
poid PIN_FLD_BASE_PRODUCT_OBJ base_product_obj*
decimal PIN_FLD_CYCLE_DISCOUNT cycle_discount
decimal PIN_FLD_CYCLE_DISC_AMT cycle_disc_amt
decimal PIN_FLD_CYCLE_FEE_AMT cycle_fee_amt
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
int PIN_FLD_CALENDAR_DOM calendar_dom
int PIN_FLD_FLAGS flags
int PIN_FLD_MMC_TYPE mmc_type
poid PIN_FLD_OFFERING_OVERRIDE_VALUES_OBJ offering_override_values_obj*
array PIN_FLD_CYCLE_FEES purchased_product_cycle_fees_t
timestamp
PIN_FLD_CHARGED_FROM_T
 		charged_from_t
timestamp
PIN_FLD_CHARGED_TO_T
 		charged_to_t
timestamp
PIN_FLD_CYCLE_FEE_START_T
 		cycle_fee_start_t
timestamp
PIN_FLD_CYCLE_FEE_END_T
 		cycle_fee_end_t
enum
PIN_FLD_UNIT
 		unit
int
PIN_FLD_COUNT
 		count
timestamp
PIN_FLD_LAST_NOTIFICATION_T
 		last_notification_t
string
PIN_FLD_LAST_NOTIFICATION_OFFSET
 		last_notification_offset
poid PIN_FLD_PLAN_OBJ plan_obj*
poid PIN_FLD_PRODUCT_OBJ product_obj*
decimal PIN_FLD_PURCHASE_DISCOUNT purchase_discount
decimal PIN_FLD_PURCHASE_DISC_AMT purchase_disc_amt
decimal PIN_FLD_PURCHASE_FEE_AMT purchase_fee_amt
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*
poid PIN_FLD_SPONSOR_OBJ sponsor_obj*
enum PIN_FLD_STATUS status
int PIN_FLD_STATUS_FLAGS status_flags
decimal PIN_FLD_USAGE_DISCOUNT usage_discount
timestamp PIN_FLD_USAGE_END_T usage_end_t
timestamp PIN_FLD_USAGE_START_T usage_start_t
int PIN_FLD_CYCLE_FEE_FLAGS cycle_fee_flags
enum PIN_FLD_OBJECT_CACHE_TYPE object_cache_type
timestamp PIN_FLD_INSTANTIATED_T instantiated_t
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
poid PIN_FLD_OVERRIDDEN_OBJ overridden_obj*
string PIN_FLD_PRICE_LIST_NAME price_list_name
enum PIN_FLD_MODE purchase_mode
int PIN_FLD_RENEWAL_MODE renewal_mode
int PIN_FLD_GRACE_PERIOD grace_period
int PIN_FLD_RETRY_COUNT retry_count
timestamp PIN_FLD_NEXT_RETRY_T next_retry_t
timestamp PIN_FLD_LAST_NOTIFICATION_T last_notification_t
string PIN_FLD_LAST_NOTIFICATION_OFFSET last_notification_offset
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