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

Class /deal

A deal is a package of related products. Packaging products into deals simplifies the price list as it is presented to the customer. A product may appear in multiple deals. Deals may be used to apply special discounts to products and also to restrict the start and end dates for the products. For example, you might offer a reduced monthly fee for a product if purchased by a certain date. Using deals adds flexibility to your pricing structure without requiring you to redefine rates and products. An account may own only one deal whose purchase level is set to 'all accounts and no services'. Also, a deal must contain only products that confirm to the deal's purchase level. See also /plan and /product definitions.

Notes

  • This object can be read by the owner or any billing group leader who is an ancestor of the owner.
  • This object can be modified only by 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
string PIN_FLD_DESCR
timestamp PIN_FLD_END_T
int PIN_FLD_FLAGS
string PIN_FLD_NAME
string PIN_FLD_CODE
string PIN_FLD_PERMITTED
array PIN_FLD_PRODUCTS
decimal
timestamp
int
timestamp
int
poid
decimal
timestamp
int
timestamp
int
decimal
enum
int
decimal
timestamp
int
timestamp
int
enum
int
int
int
poid
array PIN_FLD_DISCOUNTS
timestamp
int
timestamp
int
poid
timestamp
int
timestamp
int
decimal
enum
int
timestamp
int
timestamp
int
enum
int
timestamp PIN_FLD_START_T
poid PIN_FLD_SUBSCRIPTION_TERMS_OBJ
poid PIN_FLD_ATTRIBUTE_OBJ


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 account object for which this object was created.

Notes

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

Links

string PIN_FLD_DESCR

Deal description.

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

timestamp PIN_FLD_END_T

Non inclusive end time of the valid period for this deal.

Notes

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

Links

int PIN_FLD_FLAGS

This field stores (i) The deal customization information in the 21 and 22 bits. (ii) The on demand billing information in the bit 23. (iii)The grouping of resources information in bit 24.

Notes

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

Links

string PIN_FLD_NAME

User defined name for the deal. The Pricing Tool relies on this name being unique across all deals.

Notes

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

Links

string PIN_FLD_CODE

User defined code for the deal. The Pricing Tool relies on this name being unique across all deals.Relevant if PDC is enabled

Notes

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

Links

string PIN_FLD_PERMITTED

This is the purchase level of the deal. It can be one of 'single service' (a service type string) or 'all services' (/service) or 'all accounts and services' (*) or 'all accounts and no services' (/account). Subtypes of a service are implicitly included.

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

array PIN_FLD_PRODUCTS

Array of products that are used to compose the deal. Array element id is not significant.

Notes

  • Can be specified on object creation
  • Can be modified

Links

decimal PIN_FLD_CYCLE_DISCOUNT

Discount applied to cycle rates of the product (0.0 <= discount <= 1.0). For example, a 25% discount is represented in the field as 0.25.

Notes

Links

timestamp PIN_FLD_CYCLE_END_T

Not Used

Notes

Links

int PIN_FLD_CYCLE_END_DETAILS

Assess cycle fees only up to the time specified in the field. Expressed as mode, unit and offset. The lower 8 bits hold mode to indicate end never or relative end, next 4 bits hold unit and next 20 bits hold offset which is relative to purchase start.

Notes

Links

timestamp PIN_FLD_CYCLE_START_T

Not used.

Notes

Links

int PIN_FLD_CYCLE_START_DETAILS

Assess cycle fees only from the time specified in the field. Expressed as mode, unit and offset. The lower 8 bits hold mode to indicate start first usage/relative or immediately, next 4 bits hold unit and 20 bits hold offset which is relative to deal purchase time.

Notes

Links

poid PIN_FLD_PRODUCT_OBJ

Link to the product object included in this deal.

Notes

Links

decimal PIN_FLD_PURCHASE_DISCOUNT

Discount applied to purchase and cancel rates of the product (0.0 <= discount <= 1.0). For example, a 25% discount is represented in the field as 0.25.

Notes

Links

timestamp PIN_FLD_PURCHASE_END_T

Not used.

Notes

Links

int PIN_FLD_PURCHASE_END_DETAILS

The product expires at the time specified in the field. Expressed as mode, unit and offset.The lower 8 bits hold mode to indicate end never or relative end, next 4 bits hold unit and next 20 bits hold offset which is relative to purchase start.

Notes

Links

timestamp PIN_FLD_PURCHASE_START_T

Not used.

Notes

Links

int PIN_FLD_PURCHASE_START_DETAILS

Product is active only from the time specified in the field. Expressed as mode, unit and offsetThe lower 8 bits hold mode to indicate start first usage/relative start or start immediately, next 4 bits to hold unit and next 20 bits hold offset which is relative to purchase start.

Notes

Links

decimal PIN_FLD_QUANTITY

Number of instances of the product allocated to the user when purchasing the deal. For example, you might offer two email products as part of deal each product allocating 50MB disk space to the user.

Notes

Links

enum PIN_FLD_STATUS

Initial status of the product when purchased. Legal values are ACTIVE (1) and INACTIVE (2).

Notes

Links

int PIN_FLD_STATUS_FLAGS

Customer-definable reason code if the product status is set to INACTIVE.

Notes

Links

decimal PIN_FLD_USAGE_DISCOUNT

Discount applied to usage rates of the product (0.0 <= discount <= 1.0). For example, a 25% discount is represented in the field as 0.25.

Notes

Links

timestamp PIN_FLD_USAGE_END_T

Not Used.

Notes

Links

int PIN_FLD_USAGE_END_DETAILS

Product is eligible to be used for rating events only up to the time specified in this field. Expressed as mode, unit and offset. The lower 8 bits hold mode to indicate end is end never or relative, next 4 bits hold unit and next 20 bits hold offset which is relative to purchase start.

Notes

Links

timestamp PIN_FLD_USAGE_START_T

Not used.

Notes

Links

int PIN_FLD_USAGE_START_DETAILS

Product is eligible to be used for rating events only from the time specified in this field. Expressed as mode, unit and offset. The lower 8 bits hold mode to indicate start first usage/relative/immediately, next 4 bits hold unit and next 20 bits hold offset which is relative to purchase start.

Notes

Links

enum PIN_FLD_MODE

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

Notes

Links

int PIN_FLD_GRACE_PERIOD

Grace period defined with this offering

Notes

Links

int PIN_FLD_RENEWAL_MODE

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

Notes

Links

int PIN_FLD_FLAGS

The prorate options at PRODUCT LevelValues: 0 - Default System Configuration, 1 - 30-Day Proration, 2 - No of Days in Month

Notes

Links

poid PIN_FLD_BASE_PRODUCT_OBJ

Link to the base product object.

Notes

Links

array PIN_FLD_DISCOUNTS

Array of discounts that are used to compose the deal. Array element id is not significant.

Notes

  • Can be specified on object creation
  • Can be modified

Links

timestamp PIN_FLD_CYCLE_END_T

Not used.

Notes

Links

int PIN_FLD_CYCLE_END_DETAILS

Assess cycle fees only up to the time specified in the field. Expressed as mode, unit and offset. The lower 8 bits hold mode to indicate end never or relative end, next 4 bits hold unit and next 20 bits hold offset which is relative to purchase start.

Notes

Links

timestamp PIN_FLD_CYCLE_START_T

Not used.

Notes

Links

int PIN_FLD_CYCLE_START_DETAILS

Assess cycle fees only from the time specified in the field. Expressed as mode, unit and offset. The lower 8 bits hold mode to indicate start first usage/relative or immediately, next 4 bits hold unit and 20 bits hold offset which is relative to deal purchase time.

Notes

Links

poid PIN_FLD_DISCOUNT_OBJ

Link to the discount object included in this deal.

Notes

Links

timestamp PIN_FLD_PURCHASE_END_T

Not used.

Notes

Links

int PIN_FLD_PURCHASE_END_DETAILS

The product expires at the time specified in the field. Expressed as mode, unit and offset.The lower 8 bits hold mode to indicate end never or relative end, next 4 bits hold unit and next 20 bits hold offset which is relative to purchase start.

Notes

Links

timestamp PIN_FLD_PURCHASE_START_T

Not used.

Notes

Links

int PIN_FLD_PURCHASE_START_DETAILS

Product is active only from the time specified in the field. Expressed as mode, unit and offset. The lower 8 bits hold mode to indicate start first usage/relative start or start immediately, next 4 bits to hold unit and next 20 bits hold offset which is relative to purchase start.

Notes

Links

decimal PIN_FLD_QUANTITY

Number of instances of the discount allocated to the user when purchasing the deal.

Notes

Links

enum PIN_FLD_STATUS

Initial status of the product when purchased. Legal values are ACTIVE (1) and INACTIVE (2).

Notes

Links

int PIN_FLD_STATUS_FLAGS

Customer-definable reason code if the product status is set to INACTIVE.

Notes

Links

timestamp PIN_FLD_USAGE_END_T

Not used.

Notes

Links

int PIN_FLD_USAGE_END_DETAILS

Product is eligible to be used for rating events only up to the time specified in this field. Expressed as mode, unit and offset.The lower 8 bits hold mode to indicate end is end never or relative, next 4 bits hold unit and next 20 bits hold offset which is relative to purchase start.

Notes

Links

timestamp PIN_FLD_USAGE_START_T

Not used.

Notes

Links

int PIN_FLD_USAGE_START_DETAILS

Product is eligible to be used for rating events only from the time specified in this field. Expressed as mode, unit and offset. The lower 8 bits hold mode to indicate start first usage/relative/immediately, next 4 bits hold unit and next 20 bits hold offset which is relative to purchase start.

Notes

Links

enum PIN_FLD_MODE

Mode of purchase product/discountValues: 0 - DEFAULT, 1 - Append_Tariff, 2 - Append_Allowance, 3 - Overwrite

Notes

Links

int PIN_FLD_GRACE_PERIOD

Grace period defined with this offering

Notes

Links

timestamp PIN_FLD_START_T

Inclusive start time of the valid period for this deal.

Notes

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

Links

poid PIN_FLD_SUBSCRIPTION_TERMS_OBJ

Link to the subscription_terms 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_ATTRIBUTE_OBJ

POID of the offer attribute group object.

Notes

  • Can be specified on object creation
  • Can be modified

Links



SQL Mapping


Type Field Name Table Column Name
base-class /deal deal_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*
string PIN_FLD_DESCR descr
timestamp PIN_FLD_END_T end_t
int PIN_FLD_FLAGS flags
string PIN_FLD_NAME name
string PIN_FLD_CODE code
string PIN_FLD_PERMITTED permitted
array PIN_FLD_PRODUCTS deal_products_t
decimal
PIN_FLD_CYCLE_DISCOUNT
 		cycle_discount
timestamp
PIN_FLD_CYCLE_END_T
 		cycle_end_t
int
PIN_FLD_CYCLE_END_DETAILS
 		cycle_end_details
timestamp
PIN_FLD_CYCLE_START_T
 		cycle_start_t
int
PIN_FLD_CYCLE_START_DETAILS
 		cycle_start_details
poid
PIN_FLD_PRODUCT_OBJ
 		product_obj*
decimal
PIN_FLD_PURCHASE_DISCOUNT
 		purchase_discount
timestamp
PIN_FLD_PURCHASE_END_T
 		purchase_end_t
int
PIN_FLD_PURCHASE_END_DETAILS
 		purchase_end_details
timestamp
PIN_FLD_PURCHASE_START_T
 		purchase_start_t
int
PIN_FLD_PURCHASE_START_DETAILS
 		purchase_start_details
decimal
PIN_FLD_QUANTITY
 		quantity
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
int
PIN_FLD_USAGE_END_DETAILS
 		usage_end_details
timestamp
PIN_FLD_USAGE_START_T
 		usage_start_t
int
PIN_FLD_USAGE_START_DETAILS
 		usage_start_details
enum
PIN_FLD_MODE
 		purchase_mode
int
PIN_FLD_GRACE_PERIOD
 		grace_period
int
PIN_FLD_RENEWAL_MODE
 		renewal_mode
int
PIN_FLD_FLAGS
 		flags
poid
PIN_FLD_BASE_PRODUCT_OBJ
 		base_product_obj*
array PIN_FLD_DISCOUNTS deal_discounts_t
timestamp
PIN_FLD_CYCLE_END_T
 		cycle_end_t
int
PIN_FLD_CYCLE_END_DETAILS
 		cycle_end_details
timestamp
PIN_FLD_CYCLE_START_T
 		cycle_start_t
int
PIN_FLD_CYCLE_START_DETAILS
 		cycle_start_details
poid
PIN_FLD_DISCOUNT_OBJ
 		discount_obj*
timestamp
PIN_FLD_PURCHASE_END_T
 		purchase_end_t
int
PIN_FLD_PURCHASE_END_DETAILS
 		purchase_end_details
timestamp
PIN_FLD_PURCHASE_START_T
 		purchase_start_t
int
PIN_FLD_PURCHASE_START_DETAILS
 		purchase_start_details
decimal
PIN_FLD_QUANTITY
 		quantity
enum
PIN_FLD_STATUS
 		status
int
PIN_FLD_STATUS_FLAGS
 		status_flags
timestamp
PIN_FLD_USAGE_END_T
 		usage_end_t
int
PIN_FLD_USAGE_END_DETAILS
 		usage_end_details
timestamp
PIN_FLD_USAGE_START_T
 		usage_start_t
int
PIN_FLD_USAGE_START_DETAILS
 		usage_start_details
enum
PIN_FLD_MODE
 		purchase_mode
int
PIN_FLD_GRACE_PERIOD
 		grace_period
timestamp PIN_FLD_START_T start_t
poid PIN_FLD_SUBSCRIPTION_TERMS_OBJ subscription_terms_obj*
poid PIN_FLD_ATTRIBUTE_OBJ attribute_obj*
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