Get a subscription product
get
/crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}
Request
Path Parameters
-
SubscriptionProductPuid(required): string
The public unique identifier of the subscription product.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : subscriptionProducts-item-response
Type:
Show Source
object
-
AccountingRuleId: integer
(int64)
Title:
Accounting Rule
The unique identifier of the accounting rule. -
AccountingRuleName: string
Title:
Accounting Rule
The name of the accounting rule. -
AlignBillingFrom: string
(date)
Title:
Align Billing From
The from date of the billing alignment. -
AmendCreditMethod: string
Title:
Amendment Credit Method
Maximum Length:30
The method used to amend the credit. -
AmendCreditMethodName: string
The name of the method used to amend the credit .
-
AmendDescription: string
Title:
Amendment Description
Maximum Length:2000
A brief description of the amended credit. -
AmendEffectiveDate: string
(date)
Title:
Amendment Effective Date
The date when the amended credit becomes effective. -
AmendReason: string
Title:
Amendment Reason
Maximum Length:30
The reason why the credit was amended. -
AmendReasonName: string
The name of the amend reason.
-
associatedAsset: array
Associated Assets
Title:
Associated Assets
The associated assets resource is used to view, create, update, and delete the assets linked to a subscription product of subscription type. -
AutoExtendFlag: boolean
Indicates if the product should be auto extended.
-
BalanceRegisterId: integer
(int64)
The ID of the balance register associated with the product.
-
BalanceRegisterNumber: string
Title:
Register Number
Read Only:true
Maximum Length:255
The number of the balance register associated with the product. -
BillingDateCode: string
Title:
Billing Date
Maximum Length:30
The code indicating the billing date. -
BillingDateName: string
The name of the billing date.
-
BillingFrequency: string
Title:
Billing Frequency
Maximum Length:30
The billing frequency. -
BillingFrequencyName: string
Title:
Billing Frequency
The name of the billing frequency. -
BillingOffsetDays: integer
(int64)
Title:
Billing Offset Days
The billing offset days. -
billLines: array
Bill Lines
Title:
Bill Lines
The bill lines resource is used to view, create, update, and delete the subscription bill line details, such as charge period, date bill from, date billed to, amount, recurring flag, invoice text, usage quantity, and usage flags. -
BillOnDay: number
Title:
Bill on Day
The day on which the product should be billed. -
BillToAccountDescription: string
A brief description of the bill-to account.
-
BillToAccountId: integer
(int64)
Title:
Billing Account
The unique identifier of the bill-to account. -
BillToAccountNumber: string
Title:
Billing Account
Maximum Length:30
The account number of the bill-to account. -
BillToAddress: string
Title:
Bill-to Address
The bill-to address. -
BillToContactId: integer
(int64)
Title:
Bill-to Contact
The bill-to contact ID of the subscription product. -
BillToContactName: string
Title:
Bill-to Contact
The bill-to contact name of the subscription product. -
BillToContactNumber: string
The bill-to contact number of the subscription product.
-
BillToPartyId: integer
(int64)
Title:
Bill-to Customer
The bill-to customer ID of the subscription product. -
BillToPartyName: string
Title:
Bill-to Customer
Read Only:true
Maximum Length:360
The bill-to customer name of the subscription product. -
BillToPartyNumber: string
Read Only:
true
Maximum Length:30
The bill-to customer number of the subscription product. -
BillToSiteNumber: string
Title:
Bill-to Site Number
The bill-to site number of the subscription product. -
BillToSiteUseId: integer
(int64)
Title:
Bill-to Site
The unique identifier of the bill-to site use. -
CalculatedCreditAmount: number
Title:
Calculated Credit Amount
The calculated credit amount of the subscription product. -
CancelDescription: string
Title:
Cancellation Description
Maximum Length:2000
The cancellation reason description of the subscription product. -
CanceledAmount: number
Title:
Canceled Amount
The transaction amount that was canceled. -
CanceledDate: string
(date)
Title:
Product Canceled Date
The date when the product was canceled. -
CancelReason: string
Title:
Cancellation Reason
Maximum Length:30
The reason why the product was canceled. -
charges: array
Charges
Title:
Charges
The charges resource is used to view, create, update, and delete the subscription charge details, such as charge name, charge definition, price type, price periodicity, and tiered flag. -
ChurnPredictionTrend: integer
(int32)
The churn prediction trend.
-
ChurnProbability: number
Title:
Churn Probability
The probability of churn associated with the product. -
CloseCreditMethod: string
Title:
Close Credit Method
Maximum Length:30
The method used to close the credit. -
ClosedAmount: number
Title:
Closed Amount
The amount at which the transaction was closed. -
ClosedDate: string
(date)
Title:
Product Close Date
The date when the product was closed. -
CloseDescription: string
Title:
Close Description
Maximum Length:2000
The close reason description of the subscription product. -
CloseReason: string
Title:
Product Close Reason
Maximum Length:30
The reason why the product was closed. -
CorpCurrencyCode: string
Maximum Length:
15
The corporate currency code associated with the product. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. -
CoverageName: string
Title:
Template Name
The name of the coverage associated with the product. -
CoverageScheduleId: integer
(int64)
Coverage Scheduled
-
coveredLevels: array
Covered Levels
Title:
Covered Levels
The covered levels resource is used to create, view, update, or delete the subscription covered levels details, such as subscription ID, subscription product ID, covered asset and its associated details. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the subscription product. -
CreationDate: string
(date-time)
Read Only:
true
The date when the subscription was created. -
creditCards: array
Credit Cards
Title:
Credit Cards
The credit cards resource is used to view, create, and update the credit cards associated with a subscription. -
CreditedAmount: number
Title:
Credited Amount
The amount credited to a account. -
CurcyConvRateType: string
Maximum Length:
30
The currency conversion rate type associated with the product. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. -
Currency: string
Maximum Length:
15
The currency associated with the subscription product. -
CustomerTrxTypeSequenceId: integer
(int64)
The customer transaction type sequence ID of the subscription product.
-
DefaultRevenueAction: string
Maximum Length:
30
The revenue management rule of the subscription product used during the amendment. -
DefinitionOrganizationId: integer
(int64)
The unique identifier of the item master organization.
-
Description: string
Title:
Product Description
A brief description of the subscription product. -
DisplaySequence: number
Title:
Display Sequence
The display sequence of the subscription product. -
DocumentTypeId: integer
(int64)
Title:
Document Type
Default Value:10
TheuUnique identifier of a source document type in Oracle Revenue Management Cloud. -
DropAllowanceFlag: string
Title:
No Allowance
Maximum Length:1
Indicates whether allowances alone are dropped for a subscription product. -
DropOneTimeChargeFlag: boolean
Title:
Don't copy one-time charges
Maximum Length:1
Indicates whether one time charges have to be removed when the product is changed. -
Duration: integer
Title:
Duration
Product Duration -
EarlyTerminationFee: number
Title:
Early Termination Fee
Read Only:true
The early termination fee. -
EarlyTerminationPenalty: string
Title:
Early Termination Penalty
Maximum Length:30
The early termination penalty. -
EarlyTerminationPenaltyName: string
The name of the early termination penalty.
-
EnablePricingTermsFlag: boolean
Title:
Enable pricing term
Maximum Length:1
Indicates whether the pricing terms are enabled or not. -
EnableProrateByDay: boolean
Title:
Prorate by day
Maximum Length:1
Indicates whether proration by day is enabled or not. -
EnableUpfrontBillingFlag: boolean
Title:
Bill immediately
Maximum Length:1
Indicates whether billing is done upfront or not. -
EndDate: string
(date)
Title:
Product End Date
The date when the subscriptions ends. -
EntitlementPlanId: integer
(int64)
The ID of the entitlement plan associated with the product.
-
EntitlementPlanNumber: string
Title:
Number
The number of the entitlement plan associated with the product. -
EntitlementType: string
Title:
Entitlement Type
Maximum Length:30
The type of the entitlement associated with the product. -
EstimatedTax: number
Title:
Estimated Tax
The estimated tax on the product. -
ExemptCertificateNumber: string
Title:
Tax Exemption Certificate Number
Maximum Length:80
The number of the exempt certificate. -
ExemptReason: string
Title:
Exemption Reason
Maximum Length:30
The reason for the tax exemption. -
ExternalAssetKey: string
Maximum Length:
120
The external asset key -
ExternalParentAssetKey: string
Maximum Length:
120
The external parent asset key -
ExternalPriceListId: string
Maximum Length:
120
The unique identifier of the external price list. -
ExternalRootAssetKey: string
Maximum Length:
120
The external root asset key -
flexFields: array
Descriptive Flexfields
Title:
Descriptive Flexfields
The descriptive flexfields resource is used to view, create, update, and delete a descriptive flexfield. -
GenerateBillFullPeriodFlag: boolean
Title:
Generate billing schedule for full period
Maximum Length:1
Generate Bill Full Period Flag -
GenerateBillingSchedule: string
Title:
Generate billing schedule for full period
Maximum Length:80
Indicates whether the billing schedule is to be generated or not. -
GracePeriod: integer
(int64)
Title:
Grace Period in Days
The grace period. -
InterfaceOffsetDays: integer
(int32)
Title:
Billing Interface Offset Days
The number of days that the interface needs to be offset for. -
InventoryItemId: integer
(int64)
The unique identifier of the inventory item.
-
InvoicedAmount: number
Title:
Invoiced Amount
The amount specified in the invoice. -
InvoiceText: string
Title:
Invoice Text
Maximum Length:2000
The text in the billing invoice. -
InvoicingRuleId: integer
(int64)
Title:
Invoicing Rule
The unique identifier of the invoicing rule. -
InvoicingRuleName: string
Title:
Invoicing Rule
The name of the invoicing rule. -
ItemUnitOfMeasure: string
Title:
Pricing UOM Code
Maximum Length:15
The unit of measure used to measure the items. -
LastUpdateDate: string
(date-time)
Title:
Line Last Update Date
Read Only:true
The date when the subscription was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the subscription product. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of the user who last updated the subscription product. -
LineNumber: string
Title:
Product Line Number
Maximum Length:300
The line number of the product. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MonthlyRecurringRevenue: number
Title:
MRR
The monthly recurring revenue associated with the product. -
negotiatedEntitlementPlanCommitments: array
Subscription Entitlement Plan Commitments
Title:
Subscription Entitlement Plan Commitments
The subscription entitlement plan commitments resource is used to create a negotiated entitlement plan based on commitments. These records can be created only for those balance codes which have the commitments flag enabled. -
negotiatedEntitlementPlanDetails: array
Subscription Entitlement Plan Details
Title:
Subscription Entitlement Plan Details
The subscription entitlement plan details resource is used to view, create, update, and delete an entitlement plan detail. -
negotiatedEntitlementPlanEstimates: array
Subscription Entitlement Plan Estimates
Title:
Subscription Entitlement Plan Estimates
The subscription entitlement plan estimates resource is used to create a negotiated entitlement plan based on estimates. These records can be created only for those balance codes which have the estimates flag enabled. -
NextBillStartDate: string
(date)
Next Bill Start Date
-
NextPricingDate: string
(date)
The date when the next pricing will occur.
-
OrderFulfillLineId: integer
(int64)
The ID of the sales order fulfillment line associated with the subscription product.
-
OrderFulfillLineNumber: integer
(int32)
The number of the sales order fulfillment line associated with the subscription product.
-
OutputTaxClassification: string
Maximum Length:
50
The tax classification to use when calculating the output tax. -
OverrideCreditAmount: number
Title:
Override Credit Amount
The override credit amount of the subscription product. -
PaymentMethod: string
Title:
Payment Method
Maximum Length:30
The unique identifier of the payment method. -
PaymentMethodName: string
Title:
Payment Method Name
The name of the payment method. -
PaymentTermsId: integer
(int64)
Title:
Payment Terms
The unique identifier of the payment terms. -
PaymentTermsName: string
Title:
Payment Terms
The name of the payment terms. -
PenaltyChargeName: string
The penalty charge name.
-
PenaltyValue: number
Title:
Penalty Value
The penalty value. -
PendingActivationFlag: boolean
Title:
Pending activation
Maximum Length:1
Indicates whether the activation of the subscription product is pending or not. -
Period: string
Title:
Period
The period for which the product has been subscribed. -
PmProgramId: integer
(int64)
Title:
Preventive Maintenance Program ID
Read Only:true
The identifier of the preventive maintenance program. -
PONumber: string
Title:
PO Number
Maximum Length:50
The number of the purchase order. -
PrePaymentNumber: integer
(int64)
Title:
Prepayment Number
The prepayment number. -
PriceAdjustmentBasis: string
Title:
Price Adjustment Basis
Maximum Length:30
The basis on the which the price is adjusted. -
PriceAdjustmentPercent: number
Title:
Price Adjustment Value
The price adjustment percent. -
PriceAdjustmentType: string
Title:
Price Adjustment Type
Maximum Length:30
The type of the price adjustment. -
PriceAsOf: string
(date)
Title:
Price as of Date
The price of the product as of a certain date. -
PriceListId: integer
(int64)
The unique identifier of the price list.
-
PriceListName: string
Maximum Length:
120
The name of the price list. -
PriceTransactionOn: string
(date)
The date when the price transaction occurred.
-
PricingError: string
Maximum Length:
2000
The pricing error associated with the product. -
PricingTermsAdjustmentPCT: number
Title:
Pricing Term Adjustment Percentage
The adjustment in the pricing terms. -
PricingTermsDuration: number
Title:
Pricing Term Duration
The duration for which the pricing terms last. -
PricingTermsPeriod: string
Title:
Pricing Term
Maximum Length:15
The period for which the pricing terms last. -
PricingTermsPricingMethod: string
Title:
Pricing Method
Maximum Length:30
The method used to set the terms of the product pricing. -
PricingTermsStartDate: string
(date)
Title:
Starting On
The date when the pricing terms starts. -
PrimaryPartyId: integer
(int64)
Read Only:
true
The primary party ID of the subscription product. -
ProductChangeReason: string
Title:
Change Reason
Maximum Length:300
The reason for the product change. -
ProductChangeSchedule: string
Title:
Apply Change
Maximum Length:30
The product change schedule is applicable on RENEWAL, ANNIVERSARY or SPECIFIC_DATE. -
ProductChangeScheduleFrom: string
(date)
Title:
Product Change Schedule Effective Date
The date from which the product change schedule is applicable. -
ProductFiscClassification: string
Maximum Length:
30
The product fiscal classification. -
ProductName: string
Title:
Product Name
Maximum Length:300
The name of the product. -
ProgramCode: string
Title:
Program Code
Read Only:true
Maximum Length:30
The code of the preventive maintenance program. -
ProgramName: string
Title:
Program Name
Read Only:true
Maximum Length:120
The name of the preventive maintenance program. -
ProgramOrganizationId: integer
Title:
Organization
Read Only:true
The organization identifier of the preventive maintenance program. -
Quantity: number
Title:
Quantity
The quantity of the product. -
RatePlanDocument: string
(byte)
The JSON representing the rate plan.
-
RatePlanDocumentId: integer
(int64)
The identifier of the rate plan document.
-
RatePlanId: integer
(int64)
The unique identifier of the rate plan.
-
RatePlanName: string
Title:
Rate Plan
The name of the rate plan. -
RatePlanNumber: string
The number of the rate plan.
-
RelatedInventoryItemId: integer
(int64)
Title:
Related Inventory Item ID
The unique identifier of the item associated to the replacement subscription product. -
RelatedProductDescription: string
Title:
Description
The description of the replacement subscription product. -
RelatedProductName: string
Title:
Product Name
Maximum Length:300
The name of the replacement subscription product. -
relationships: array
Relationships
Title:
Relationships
The relationships resource is used to view, create, update, and delete the subscription product relationships details, such as relationship type, source subscription product PUID, and target subscription product PUID. -
RenewalDuration: integer
(int64)
Title:
Renewal Duration
The subscription product level renewal duration override that will be used while renewing through automatic or manual renewal. -
RenewalDurationPeriod: string
Title:
Renewal Period
Maximum Length:30
The code of the subscription product level renewal duration period override that will be used while renewing through automatic or manual renewal. -
RenewalDurationPeriodName: string
Title:
Renewal Period
The name of the subscription product level renewal duration period override that will be used while renewing through automatic or manual renewal. -
RenewalPaymentMethod: string
Title:
Renewal Payment Method
Maximum Length:30
The internal code for the renewal payment method used in the subscription product. -
RenewalPaymentMethodName: string
Title:
Renewal Payment Method Name
The method of payment for renewed subscription product. The payment method could be a purchase order, wire, or credit card. -
RenewalPoNumber: string
Title:
Product Renewal PO Number
Maximum Length:50
The purchase order number of the renewed subscription product. -
RenewalType: string
Title:
Product Renewal Type
Maximum Length:30
The type of subscription renewal. -
RenewalWireNumber: string
Title:
Product Renewal Wire Number
Maximum Length:30
The wire number that identifies the electronic funds transfer used to pay for a renewed subscription product. -
RenewedDate: string
(date)
Title:
Renewed On
The date when the product was renewed. -
RenewPerpetuallyFlag: boolean
Title:
Renew forever
Maximum Length:1
Indicates whether the subscription product should be renewed forever. -
RepriceFlag: boolean
Indicates whether the subscription product should be repriced or not. If passed as 'true', the subscription product and its associated covered levels will be repriced.
-
RequestedAlignBillingDate: string
(date)
Title:
Requested Align Billing From
The requested align billing date for the product. -
RequestedEntitlementPlanId: integer
(int64)
The ID of the requested entitlement plan associated with the product.
-
RequestedEntitlementPlanNumber: string
Title:
Entitlement Plan Number
The number of the requested entitlement plan associated with the product. -
RequestedProgramId: integer
(int64)
Title:
Requested Preventive Maintenance Program ID
Read Only:true
The unique identifier of the requested preventive maintenance program. -
RequestedRatePlanId: integer
(int64)
The unique identifier of the requested rate plan.
-
RequestedRatePlanNumber: string
The alternate unique identifier of the requested rate plan.
-
ResumeDate: string
(date)
The date when the product should be resumed.
-
ResumeDuration: integer
The duration after which the the product should be resumed.
-
ResumePeriod: string
The period of time after which the product will resume.
-
RevenueOption: string
Maximum Length:
30
Revenue Option -
salesCredits: array
Sales Credits
Title:
Sales Credits
The sales credits resource to view, create, update, and delete the sales credits defined for a subscription or a subscription product. -
SalesOrderId: integer
(int64)
The ID of the sales order associated with the subscription product.
-
SalesOrderLineNumber: string
Title:
Sales Order Line Number
Maximum Length:100
Sales Order Line Number -
SalesOrderNumber: string
Title:
Sales Order Number
Maximum Length:200
The number of the sales order associated with the subscription product. -
SalesProductType: string
Title:
Type
Maximum Length:30
The type of the sales product. -
serviceResources: array
Service Resources
Title:
Service Resources
The service resources resouce is used to view, create, update, and delete the service identifier for a subscription product. -
ShipToAccountDescription: string
The ship-to account description of the subscription product.
-
ShipToAccountId: integer
(int64)
Title:
Ship-to Account
The ship-to account ID of the subscription product. -
ShipToAccountNumber: string
Title:
Ship-to Account
The ship-to account number of the subscription product. -
ShipToContactId: integer
(int64)
Title:
Ship-to Contact
The ship-to contact ID of the subscription product. -
ShipToContactName: string
Title:
Ship-to Contact
The ship-to contact name of the subscription product. -
ShipToContactNumber: string
The ship-to contact number of the subscription product.
-
ShipToContactPartyId: integer
Read Only:
true
The ship-to contact party ID of the subscription product. -
ShipToPartyId: integer
(int64)
Title:
Ship-to Party
The unique identifier of the ship-to party. -
ShipToPartyName: string
Title:
Ship-to Party
The name of the ship-to party. -
ShipToPartyNumber: string
Title:
Ship-to Party Number
Read Only:true
Maximum Length:30
The ship-to party number of the subscription product. -
ShipToPartySiteId: integer
(int64)
Title:
Ship-to Site
The unique identifier of the ship-to party site. -
ShipToPartySiteName: string
Title:
Ship-to Site
The name of the ship-to party site. -
ShipToPartySiteNumber: string
Title:
Ship-to Site Number
The ship-to party site number of the subscription product. -
SourceKey: string
Maximum Length:
120
The identifier of the product in the source system. -
SourceLineKey: string
Maximum Length:
120
The source line key -
SourceLineNumber: string
Maximum Length:
120
The source line number -
SourceNumber: string
Maximum Length:
120
The alternate identifier of the product in the source system. -
SourceSystem: string
Maximum Length:
30
The reference of the product in the source system. -
StartDate: string
(date)
Title:
Product Start Date
The date when the subscriptions starts. -
Status: string
Title:
Status
Maximum Length:30
Default Value:DRAFT
The status of the subscription product. -
StatusMeaning: string
Title:
Product Status
Read Only:true
Maximum Length:80
The meaning of the product status. -
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionNumber: string
Title:
Subscription Number
Maximum Length:120
Default Value:Subscriptions.SubscriptionNumber
The subscription number of the product. -
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
-
SubscriptionProductPuid: string
Title:
Subscription Product Number
Maximum Length:120
The public unique identifier of the subscription product. -
SummarizedBillingFlag: boolean
Title:
Summarized billing
Maximum Length:1
Indicates whether the billing is to be summarized. -
SuspendCreditMethod: string
Title:
Suspend Credit Method
Maximum Length:30
Indicates if the credit method has to be suspended. -
SuspendedDate: string
(date)
Title:
Suspend Date
The date when the product was suspended. -
SuspendReason: string
Title:
Suspend Reason
Maximum Length:30
The reason to suspend the product. -
TaxClassificationMeaning: string
Read Only:
true
The meaning of the tax classification. -
TaxError: string
Maximum Length:
2000
The tax error, if any, in the calculated amount. -
TaxExemptionHandling: string
Maximum Length:
30
The tax exemption handling. -
TaxExemptionHandlingName: string
The tax exemption handling name.
-
TcvWithTotalUsageCharge: number
Title:
TCV with Total Usage Charge
Read Only:true
Tcv With Total Usage Charge -
TotalContractValue: number
Title:
Product Contract Value
The value of the total contract. -
TotalUsageCharge: number
Title:
Total Usage Charges
Read Only:true
Total Usage Charge -
TransactionTypeName: string
Title:
Transaction Type
Maximum Length:30
The name of the transaction type. -
UnitPrice: number
The price of the unit.
-
UsageInvoiceLayoutTemplate: string
Title:
Usage Events Invoice Template
Maximum Length:200
The layout template of the usage invoice. -
WarehouseId: integer
(int64)
Title:
Warehouse
The warehouse ID associated with the subscription product. -
WareHouseName: string
Title:
Warehouse
The warehouse name of the subscription product. -
WireNumber: string
Title:
Wire Number
Maximum Length:30
The wire number.
Nested Schema : Associated Assets
Type:
array
Title:
Associated Assets
The associated assets resource is used to view, create, update, and delete the assets linked to a subscription product of subscription type.
Show Source
Nested Schema : Bill Lines
Type:
array
Title:
Bill Lines
The bill lines resource is used to view, create, update, and delete the subscription bill line details, such as charge period, date bill from, date billed to, amount, recurring flag, invoice text, usage quantity, and usage flags.
Show Source
Nested Schema : Charges
Type:
array
Title:
Charges
The charges resource is used to view, create, update, and delete the subscription charge details, such as charge name, charge definition, price type, price periodicity, and tiered flag.
Show Source
Nested Schema : Covered Levels
Type:
array
Title:
Covered Levels
The covered levels resource is used to create, view, update, or delete the subscription covered levels details, such as subscription ID, subscription product ID, covered asset and its associated details.
Show Source
Nested Schema : Credit Cards
Type:
array
Title:
Credit Cards
The credit cards resource is used to view, create, and update the credit cards associated with a subscription.
Show Source
Nested Schema : Descriptive Flexfields
Type:
array
Title:
Descriptive Flexfields
The descriptive flexfields resource is used to view, create, update, and delete a descriptive flexfield.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Subscription Entitlement Plan Commitments
Type:
array
Title:
Subscription Entitlement Plan Commitments
The subscription entitlement plan commitments resource is used to create a negotiated entitlement plan based on commitments. These records can be created only for those balance codes which have the commitments flag enabled.
Show Source
Nested Schema : Subscription Entitlement Plan Details
Type:
array
Title:
Subscription Entitlement Plan Details
The subscription entitlement plan details resource is used to view, create, update, and delete an entitlement plan detail.
Show Source
Nested Schema : Subscription Entitlement Plan Estimates
Type:
array
Title:
Subscription Entitlement Plan Estimates
The subscription entitlement plan estimates resource is used to create a negotiated entitlement plan based on estimates. These records can be created only for those balance codes which have the estimates flag enabled.
Show Source
Nested Schema : Relationships
Type:
array
Title:
Relationships
The relationships resource is used to view, create, update, and delete the subscription product relationships details, such as relationship type, source subscription product PUID, and target subscription product PUID.
Show Source
Nested Schema : Sales Credits
Type:
array
Title:
Sales Credits
The sales credits resource to view, create, update, and delete the sales credits defined for a subscription or a subscription product.
Show Source
Nested Schema : Service Resources
Type:
array
Title:
Service Resources
The service resources resouce is used to view, create, update, and delete the service identifier for a subscription product.
Show Source
Nested Schema : subscriptionProducts-associatedAsset-item-response
Type:
Show Source
object
-
AssetId: integer
(int64)
The unique identifier of the asset.
-
AssetName: string
Title:
Asset Name
The name of the asset. -
AssetSerialNumber: string
Title:
Asset Serial Number
The serial number of the asset. -
AssociatedAssetId: integer
(int64)
The unique identifier of the associated asset.
-
AssociatedAssetPuid: string
Maximum Length:
120
The PUID of the associated asset. -
CorpCurrencyCode: string
Maximum Length:
15
The corporate currency code. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the associated asset. -
CreationDate: string
(date-time)
Read Only:
true
The date when the associated asset was created. -
CurcyConvRateType: string
Maximum Length:
30
The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CurrencyCode: string
Maximum Length:
15
The currency code such as USD or INR. -
InventoryItemId: integer
The unique identifier of the inventory item.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the associated asset was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the associated asset. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the associated asset. -
LineNumber: integer
(int64)
Title:
Number
The line number of the associated asset. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProductName: string
Title:
Product Name
The name of the product. -
Quantity: number
Title:
Quantity
The quantity of the associated asset. -
SourceKey: string
Maximum Length:
120
The source key of the associated asset. -
SourceLineKey: string
Maximum Length:
120
The source line key of the associated asset. -
SourceLineNumber: string
Maximum Length:
120
The source line number of the associated asset. -
SourceNumber: string
Maximum Length:
120
The source number of the associated asset. -
SourceSystem: string
Maximum Length:
30
The source system of the associated asset. -
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscurption product.
-
UnitOfMeasure: string
Title:
UOM
The unit of measure of the associated asset. -
UnitOfMeasureCode: string
Title:
UOM
The unit of measure code of the associated asset.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : subscriptionProducts-billLines-item-response
Type:
Show Source
object
-
Amount: number
Title:
Amount
The amount for which the bill is generated. -
billAdjustments: array
Bill Adjustments
Title:
Bill Adjustments
The bill adjustments resource is used to view, create, update, and delete the subscription bill adjustment details, such as adjustment name, adjustment value, adjustment type, reason, and effectivity. -
BillingPeriod: number
Title:
Sequence
The period for which the bill is generated. -
BillLineId: integer
(int64)
The unique identifier of the bill line.
-
BillLinePuid: string
Maximum Length:
120
The public unique identifier of the bill line. -
BusinessUnitId: integer
The ID of the business unit associated with the bill line.
-
ChargeDefinition: string
Maximum Length:
30
The definition that indicates the purpose of the charge. -
ChargeId: integer
(int64)
The unique identifier of the charge.
-
ChargeName: string
Title:
Charge Name
Maximum Length:120
The name of the charge associated with the bill line. -
ChargePeriod: number
Title:
Period
The usage period that was charged. -
ChargePeriodFactor: number
The change period factor associated with the bill line.
-
ChargePuid: string
Read Only:
true
The public unique identifier of the charge. -
CoveredLevelId: integer
(int64)
The unique identifier of the covered level.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the billing line. -
CreationDate: string
(date-time)
Read Only:
true
The date when the billing line was created. -
CreditMemoAmount: number
The amount for the credit memo.
-
CreditMemoFlag: string
Indicates if there is a credit memo associated with the bill line.
-
CreditMemoReason: string
The reason to raise the credit memo.
-
CreditMemoReasonCode: string
Maximum Length:
30
The code of the credit memo reason code. -
CustomerTrxTypeSequenceId: integer
(int64)
Customer Transaction Type Sequence Id
-
DateBilledFrom: string
(date)
Title:
Bill-from Date
The date from which the bill was generated. -
DateBilledTo: string
(date)
Title:
Bill-to Date
The date up to which the bill is generated. -
DateToInterface: string
(date)
Title:
Interface Date
The date to interface for the bill line. -
InterfacedFlag: boolean
Title:
Interfaced
Maximum Length:1
Default Value:false
Indicates whether the bill line is interfaced or not. -
InvoiceBillLineId: integer
(int64)
The unique identifier of the invoice bill line.
-
InvoiceDate: string
(date)
The date when the invoice was raised.
-
InvoiceText: string
Title:
Invoice Text
Maximum Length:240
The text in the bill line invoice. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the billing line was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the billing line. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of the user who last updated the billing line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ListPrice: number
The list price of the product associated with the bill line.
-
MilestoneEventId: integer
(int64)
The ID of the milestone event associated with the bill line.
-
MilestoneEventName: string
The name of the milestone event associated with the bill line.
-
NewCreditMemoPUID: string
The unique public identifier of the new credit memo.
-
PricedQuantity: number
The quantity for which the bill line was charged.
-
PricingError: string
Maximum Length:
1000
The error in pricing, if any. -
RecurringFlag: boolean
Maximum Length:
1
Indicates whether the line is recurring or not. -
RetrieveInvoiceFlag: boolean
Title:
Retrieve Invoice from Receivables
Maximum Length:1
Retrieve Invoice Flag -
RevenueLineId: integer
(int64)
The unique identifier of the revenue line.
-
RevenueOption: string
Title:
Revenue Accounting Option
Maximum Length:30
Revenue Option -
RevenuePeriod: string
Title:
Revenue Effectivity Periods
Maximum Length:30
Revenue Period -
SentDate: string
(date)
Title:
Sent Date
The date invoice information is sent to receivables. -
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
-
SummarizedBillLineId: integer
Title:
Summarized Bill Line ID
Summarized Bill Line ID -
TransactionAmount: number
Title:
Invoice Amount
The amount for which the transaction occurred. -
TransactionClass: string
Title:
Transaction Class
Maximum Length:30
The class of the transaction. -
TransactionClassMeaning: string
Title:
Class
The meaning of transaction class lookup. -
TransactionDate: string
(date)
Title:
Invoice Date
The date when the transaction occurred. -
TransactionNumber: string
Title:
Invoice Number
Maximum Length:30
The number of the transaction. -
TransactionTax: number
Title:
Tax
The tax levied on the transaction. -
TransactionTypeName: string
The transaction type name of the subscription bill line.
-
TruedUpYn: string
Maximum Length:
3
Indicates if the bill line has a trueup period. -
TrxId: integer
(int64)
The AR transaction ID.
-
TrxLineId: integer
(int64)
The AR transaction line ID.
-
UsageAcquiredFlag: boolean
Maximum Length:
1
Indicates whether the usage has been acquired or not. -
UsageCaptureDate: string
(date)
The date when the usage was captured.
-
UsageChargeType: string
Title:
Usage Charge Type
Maximum Length:30
The type of usage charge. -
UsageChargeTypeName: string
The name of the usage charge type.
-
UsageFlag: boolean
Maximum Length:
1
Indicates whether the line is a usage line or not. -
UsagePricedFlag: boolean
Maximum Length:
1
Indicates whether the usage line has been priced or not. -
UsageQuantity: number
Title:
Usage Quantity
The quantity of the usage.
Nested Schema : Bill Adjustments
Type:
array
Title:
Bill Adjustments
The bill adjustments resource is used to view, create, update, and delete the subscription bill adjustment details, such as adjustment name, adjustment value, adjustment type, reason, and effectivity.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-billLines-billAdjustments-item-response
Type:
Show Source
object
-
AdjustmentBasis: string
Title:
Basis
Maximum Length:30
The basis on which the bill is adjusted. -
AdjustmentName: string
Title:
Adjustment
Maximum Length:120
The name of the bill adjustment. -
AdjustmentReasonCode: string
Maximum Length:
30
The code of the adjustment reason. -
AdjustmentType: string
Title:
Type
Maximum Length:30
The type of the bill adjustment. -
AdjustmentValue: number
Title:
Value
The value by which the bill is adjusted. -
AutoAdjustmentFlag: boolean
Maximum Length:
3
Indicates whether the adjustment is automatic or not. -
BasisEnableFlag: boolean
Indicates if the base has been enabled for the bill adjustment.
-
BillAdjustmentId: integer
(int64)
The unique identifier of the bill adjustment.
-
BillAdjustmentPuid: string
Maximum Length:
120
The public unique identifier of the bill adjustment. -
BillLineId: integer
(int64)
The unique identifier of the bill line.
-
ChargeAdjustmentId: integer
(int64)
The unique identifier of the charge adjustment.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the bill adjustment. -
CreationDate: string
(date-time)
Read Only:
true
The date when the bill adjustment was created. -
CurrencyCode: string
The current code used for the bill adjustment.
-
Effectivity: string
Maximum Length:
30
The effectivity of the bill adjustment. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the bill adjustment was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the bill adjustment. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of the user who last updated the bill adjustment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NumberOfPeriods: number
The number of periods
-
PeriodFrom: number
The period from which the bill was adjusted.
-
PeriodUntil: number
The period until which the bill is adjusted.
-
Reason: string
Title:
Reason Details
Maximum Length:120
The reason why the bill is adjusted. -
RevenueAdjustmentFromDate: string
(date)
Title:
Revenue Effective Start Date
Revenue Adjustment From Date -
RevenueAdjustmentToDate: string
(date)
Title:
Revenue Effective End Date
Revenue Adjustment To Date -
RevenueOption: string
Title:
Revenue Accounting Option
Maximum Length:30
Revenue Option -
RevenuePeriod: string
Title:
Revenue Effectivity Periods
Maximum Length:30
Revenue Period -
SequenceNumber: number
Title:
Sequence
The sequence number of the bill adjustment. -
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-charges-item-response
Type:
Show Source
object
-
adjustments: array
Adjustments
Title:
Adjustments
The adjustments resource is used to view, create, update, and delete the subscription charge adjustment details, such as adjustment name, adjustment type, adjustment value, adjustment reason, and effectivity. -
AggregationMethod: string
Maximum Length:
30
The aggregation method used for the charges. -
Allowance: number
Title:
Allowance
The allowance part of the charge. -
AssetMeterYn: boolean
Maximum Length:
1
The flag whether it is an asset meter or not. -
BillingFreq: string
Maximum Length:
30
Billing Frequency -
BillingFreqName: string
Title:
Billing Frequency
Maximum Length:255
Billing Frequency Name -
BillLineId: integer
(int64)
The unique identifier of the bill line.
-
BlockSize: number
Title:
Block Size
The block size of the charge. -
ChargeDefinition: string
Title:
Charge Name
Maximum Length:30
The definition that indicates the purpose of the charge. -
ChargeDefinitionName: string
The name of the charge definition.
-
ChargeId: integer
(int64)
The unique identifier of the charge.
-
chargeMilestoneEvents: array
Charge Milestone Events
Title:
Charge Milestone Events
The charge milestone events resource is used to view, create, update, and delete the milestone events associated with a charge of a subscription. -
ChargeName: string
Title:
Charge Name
Maximum Length:120
The name of the charge. -
ChargePeriodCode: string
Maximum Length:
30
The code of the charge period associated with the charge. -
ChargePuid: string
Maximum Length:
120
The public unique identifier of the charge. -
chargeTiers: array
Charge Tiers
Title:
Charge Tiers
The charge tiers resource is used to view, create, update, and delete the subscription charge tier details, such as tier from, tier to, and list price. -
CoveredLevelId: integer
(int64)
The unique identifier of the covered level.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the charge. -
CreationDate: string
(date-time)
Read Only:
true
The date when the charge was created. -
EnableProration: string
Maximum Length:
1
Indicates whether proration is enabled or not. -
EstimatedAmount: number
Title:
Estimated Amount
The estimated amount of the charges. -
EstimatedMethodName: string
Title:
Estimation Method
The method used to estimate the amount. -
EstimatedQuantity: number
Title:
Estimated Quantity
The estimated quantity for the charge. -
EstimationMethod: string
Title:
Estimation Method
Maximum Length:30
The method used to estimate the amount. -
ExternalKey: string
Maximum Length:
120
The external key used to measure the charge. -
ExternalParentKey: string
Maximum Length:
120
The external parent key. -
InitialMeterReadingId: integer
(int64)
The initial meter reading identifier value.
-
InvoicingRuleId: integer
(int64)
The ID of the invoice rule.
-
InvoicingRuleName: string
Title:
Invoicing Rule
The name of the invoice rule. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the charge was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the charge. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of the user who last updated the charge. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MeterDefinitionId: integer
(int64)
The unique identifier of the meter definition associated with the charges.
-
MeterId: integer
(int64)
The unique identifier of the meter associated with the charges.
-
MilestoneBillingFlag: boolean
Indicates whether the billing is impacted by milestone events or not.
-
MilestoneRevenueFlag: boolean
Indicates whether the revenue is impacted by milestone events or not.
-
MilestoneTemplateId: integer
(int64)
The ID of the milestone event associated with a charge.
-
MilestoneTemplateName: string
Maximum Length:
120
The name of the milestone template associated with a charge. -
MinimumAmount: number
Title:
Minimum Amount
The minimum amount to be charged. -
MinimumQuantity: number
Title:
Minimum Quantity
The minimum quantity that is allowed. -
PeriodicBillingFlag: boolean
Maximum Length:
1
Indicates whether periodic billing is allowed or not. -
PeriodicRevenueFlag: boolean
Title:
Enable Periodic Revenue Recognition
Maximum Length:1
Indicates the periodic revenue recognition of one-time charges. -
PrePaymentNumber: integer
(int64)
Title:
Prepayment Number
The prepayment number for the charge. -
PricePeriodicity: string
Title:
Periodicity
Maximum Length:30
The price periodicity for the charge. Indicates the frequency when the charge has to be applied. -
PricePeriodicityName: string
The name of the price periodicity.
-
PriceType: string
Maximum Length:
30
The price type associated with the charge. -
QuotedTcv: number
The quoted TCV of the charge.
-
RecurringPricePeriodicityCode: string
Maximum Length:
30
The recurring price periodicity code of the charge. -
RollupFlag: boolean
Maximum Length:
1
Indicates if the charge needs to be rolled up. -
SequenceNumber: integer
(int32)
The sequence number for the charge.
-
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
-
TieredFlag: boolean
Maximum Length:
3
Indicates whether the charge has tiers. -
TierType: string
Title:
Tier Type
Maximum Length:30
The type of the charge tier. -
TrueUpPeriod: string
Title:
True Up Period
Maximum Length:30
Default Value:ORA_OSS_USAGE_BILLING_PERIOD
The identifier of the trueup period. -
TrueUpPeriodName: string
Title:
True Up Period
The name of the trueup period. -
UnitListPrice: number
Title:
List Price
The price of the unit list. -
UsagePriceLockFlag: boolean
Maximum Length:
3
Indicates whether the usage price is locked or not. -
UsageUnitOfMeasure: string
Maximum Length:
3
The usage unit of measure of the charge.
Nested Schema : Adjustments
Type:
array
Title:
Adjustments
The adjustments resource is used to view, create, update, and delete the subscription charge adjustment details, such as adjustment name, adjustment type, adjustment value, adjustment reason, and effectivity.
Show Source
Nested Schema : Charge Milestone Events
Type:
array
Title:
Charge Milestone Events
The charge milestone events resource is used to view, create, update, and delete the milestone events associated with a charge of a subscription.
Show Source
Nested Schema : Charge Tiers
Type:
array
Title:
Charge Tiers
The charge tiers resource is used to view, create, update, and delete the subscription charge tier details, such as tier from, tier to, and list price.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-charges-adjustments-item-response
Type:
Show Source
object
-
AdjustmentBasis: string
Title:
Basis
Maximum Length:30
The basis of the adjustment. -
AdjustmentName: string
Title:
Adjustment
Maximum Length:120
The name of the adjustment. -
AdjustmentReasonCode: string
Title:
Reason
Maximum Length:30
The code of the adjustment reason. -
AdjustmentReasonMeaning: string
Title:
Reason
The translated adjustment reason. -
AdjustmentType: string
Title:
Type
Maximum Length:30
The type of the adjustment. -
AdjustmentValue: number
Title:
Value
The value of the adjustment. -
AutoAdjustmentFlag: boolean
Maximum Length:
3
Indicates whether the adjustment is automatic or not. -
ChargeAdjustmentId: integer
(int64)
The unique identifier of the charge adjustment.
-
ChargeAdjustmentPuid: string
Maximum Length:
120
The public unique identifier of the charge adjustment. -
ChargeId: integer
(int64)
The unique identifier of the charge.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the adjustment. -
CreationDate: string
(date-time)
Read Only:
true
The date when the adjustment was created. -
Effectivity: string
Title:
Effectivity
Maximum Length:30
The adjustment effectivity -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the adjustment was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the adjustment. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of the user who last updated the adjustment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NumberOfPeriods: number
The number of periods
-
ObjectVersionNumber: integer
(int32)
The number used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
-
PeriodFrom: number
The period from which the adjustment was initiated.
-
PeriodUntil: number
The period until which the adjustment is initiated.
-
Reason: string
Title:
Reason Description
Maximum Length:120
The reason for the adjustment. -
SequenceNumber: integer
(int32)
Title:
Sequence
The sequence number of the adjustment. -
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-charges-chargeMilestoneEvents-item-response
Type:
Show Source
object
-
BillingOffset: number
The billing offset associated with a milestone event.
-
BillLineId: integer
(int64)
The bill line ID associated with the milestone event.
-
ChargeId: integer
(int64)
The charge ID with which the milestone event is associated.
-
ChargePuid: string
Maximum Length:
120
Default Value:Charges.ChargePuid
The PUID of the charge to which the milestone event is associated. -
CompletionDate: string
(date)
The completion date of the milestone event.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The login of the user who created the milestone event. -
CreationDate: string
(date-time)
Read Only:
true
The date on which the milestone event was created. -
EventId: integer
(int64)
The ID of the milestone event.
-
EventSource: string
Maximum Length:
30
The source of the milestone event. -
EventSourceReference: string
Maximum Length:
120
The source reference of the milestone event. -
EventType: string
Maximum Length:
30
The type of the milestone event. -
ExpectedCompletionDate: string
(date)
The expected completion date of a milestone event.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date of which the milestone event was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who updated the milestone event the last. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login which updated the milestone event the last. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MilestoneComment: string
Maximum Length:
300
The milestone event comment. -
MilestoneName: string
Maximum Length:
30
The name of the milestone event. -
MilestonePuid: string
Maximum Length:
120
The milestone event PUID. -
ObjectVersionNumber: integer
(int32)
The object version number of the milestone event.
-
Percentage: number
The percentage associated with a milestone event.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-charges-chargeTiers-item-response
Type:
Show Source
object
-
AdditionalNumberFive: number
Title:
Additional Number Five
Additional number, if any, for the charge tier. -
AdditionalNumberFour: number
Title:
Additional Number Four
Additional number, if any, for the charge tier. -
AdditionalNumberOne: number
Title:
Additional Number One
Additional number, if any, for the charge tier. -
AdditionalNumberSix: number
Title:
Additional Number Six
Additional number, if any, for the charge tier. -
AdditionalNumberThree: number
Title:
Additional Number Three
Additional number, if any, for the charge tier. -
AdditionalNumberTwo: number
Title:
Additional Number Two
Additional number, if any, for the charge tier. -
AdditionalTextOne: string
Title:
Additional Text One
Maximum Length:4000
Additional text, if any, for the charge tier. -
AdditionalTextTwo: string
Title:
Additional Text Two
Maximum Length:4000
Additional text, if any, for the charge tier. -
AdditionalTimestampOne: string
(date-time)
Title:
Additional Time-stamp One
Additional timestamp, if any, for the charge tier. -
AdditionalTimestampThree: string
(date-time)
Title:
Additional Time-stamp Three
Additional timestamp, if any, for the charge tier. -
AdditionalTimestampTwo: string
(date-time)
Title:
Additional Time-stamp Two
Additional timestamp, if any, for the charge tier. -
AddtionalTextThree: string
Title:
Additional Text Three
Maximum Length:4000
Additional text, if any, for the charge tier. -
BlockSize: number
Title:
Block Size
The block size -
ChargeId: integer
(int64)
The unique identifier of the charge.
-
ChargeTierId: integer
(int64)
The unique identifier of the charge tier.
-
ChargeTierPuid: string
Maximum Length:
120
The public unique identifier of the charge tier. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the charge tier. -
CreationDate: string
(date-time)
Read Only:
true
The date when the charge tier was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the charge tier was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the charge tier. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of the user who last updated the charge tier. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ListPrice: number
Title:
List Price
The list price -
PriceFormat: string
Title:
Price Format
Maximum Length:30
The display format of the price. -
SequenceNumber: number
The sequence number
-
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
-
TierFrom: number
Title:
Tier From
The tier from -
TierTo: number
Title:
Tier To
The tier to
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-coveredLevels-item-response
Type:
Show Source
object
-
Address: string
Title:
Address
The address of the party site. -
AssetGroupId: integer
(int64)
The unique identifier of the asset group.
-
AssetGroupName: string
Title:
Asset Group Name
The name of the asset group. -
AssetGroupNumber: string
Title:
Asset Group Number
The alternate identifier of an asset group. -
AssetId: integer
(int64)
The unique identifier of the asset.
-
AssetName: string
Title:
Covered Level Asset Name
The name of the asset. -
AssetSerialNumber: string
Title:
Covered Asset Serial Number
The serial number of the asset. -
billLines: array
Bill Lines
Title:
Bill Lines
The bill lines resource is used to view, create, update, and delete the subscription bill line details, such as charge period, date bill from, date billed to, amount, recurring flag, invoice text, usage quantity, and usage flags. -
CalculatedCreditAmount: number
Title:
Calculated Credit Amount
The calculated credit amount of the covered level. -
CancelDescription: string
Title:
Cancellation Description
Maximum Length:2000
The cancellation description associated with a covered level. -
CanceledAmount: number
The amount that was canceled.
-
CanceledDate: string
(date)
Title:
Canceled Date
The date when the covered level was canceled. -
CancelReason: string
Title:
Cancellation Reason
Maximum Length:30
The reason for cancelling the covered level. -
charges: array
Charges
Title:
Charges
The charges resource is used to view, create, update, and delete the subscription charge details, such as charge name, charge definition, price type, price periodicity, and tiered flag. -
ClosedAmount: number
The amount at which the covered level was closed.
-
ClosedDate: string
(date)
Title:
Covered Level Close Date
The date when the covered level was closed. -
CloseDescription: string
Title:
Covered Level Close Description
Maximum Length:2000
The close description associated with a covered level. -
CloseReason: string
Title:
Covered Level Close Reason
Maximum Length:30
The reason why the covered level was closed. -
CorpCurrencyCode: string
Maximum Length:
15
The corporate currency code associated with the covered level. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. -
CoveredLevelId: integer
(int64)
The unique identifier of the covered level.
-
CoveredLevelName: string
Title:
Covered Level Name
Maximum Length:300
The name of the covered level. -
CoveredLevelParentPuid: string
The alternate unique identifier of the covered level parent.
-
CoveredLevelPuid: string
Maximum Length:
120
The public unique identifier of the covered level. -
CoveredLevlName: string
Title:
Covered Level Name
The name of the covered level. -
CoveredLevlNumber: string
Title:
Covered Level Number
The alternate identifier of the covered level. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the covered level. -
CreationDate: string
(date-time)
Read Only:
true
The date when the covered level was created. -
CreditedAmount: number
The amount that was credited.
-
CurcyConvRateType: string
Maximum Length:
30
The currency conversion rate type associated with the covered level. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. -
CurrencyCode: string
Maximum Length:
15
The currency code associated with the covered level. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CustomerAccountId: integer
(int64)
The unique identifier of the customer account.
-
CustomerName: string
Title:
Customer Account
The name of the customer. -
CustomerNumber: string
Title:
Customer Account Number
The alternate unique identifier of the customer. -
Description: string
Title:
Covered Level Description
A brief description of the covered level. -
Duration: integer
The duration of the covered level.
-
EndDate: string
(date)
Title:
Covered Level End Date
The date when the covered level ends. -
ExplodeAssetHierarchy: string
Indicates if the assest hierarchy should be copied to other hierarchies.
-
GenerateBillingSchedule: string
Indicates whether the billing schedule is to be generated.
-
HierarchyTotal: number
The total covered level of the hierarchy.
-
InventoryItemId: integer
(int64)
The unique identifier of the inventory item.
-
InvoicedAmount: number
The amount for which the invoice was created.
-
InvoiceText: string
Maximum Length:
2000
The text included in the invoice. -
ItemUnitOfMeasure: string
Maximum Length:
15
The unit of measure used to measure the items in the covered level. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the covered level was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the covered level. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of the user who last updated the covered level. -
LineNumber: string
Title:
Number
Maximum Length:300
The line number -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OverrideCreditAmount: number
Title:
Override Credit Amount
The override credit amount of the covered level. -
ParentCoveredAssetId: integer
(int64)
The unique identifier of the parent covered asset.
-
ParentCoveredLevelId: integer
(int64)
The unique identifier of the parent covered level.
-
PartyId: integer
(int64)
The unique identifier of the party.
-
PartyName: string
Title:
Party Name
The name of the party. -
PartyNumber: string
Title:
Party Number
The alternate identifier of the party. -
PartySite: string
Title:
Party Site Number
The name of the party site. -
PartySiteId: integer
(int64)
The unique identifier of the party site.
-
Period: string
Maximum Length:
80
The period of the covered level. -
PriceAsOf: string
(date)
The price as of a certain date.
-
PriceListId: integer
(int64)
The unique identifier of the price list.
-
PriceUnitOfMeasure: string
Maximum Length:
30
The unit of measure used to indicate the price. -
PriceUnitOfMeasureName: string
Title:
Pricing UOM
The display name of the unit of measure. -
PricingError: string
Maximum Length:
1000
The error in the pricing, if any. -
ProductGroupId: integer
(int64)
The unique identifier of the product group.
-
ProductGroupName: string
Title:
Product Group Name
The name of the product group. -
ProductGroupNumber: string
Title:
Product Group Number
The alternate identifier of a product group. -
ProductName: string
Title:
Product Name
The name of the product associated with the covered level. -
PutOnHoldFlag: boolean
Indicates if the covered level has been put on hold.
-
Quantity: number
Title:
Quantity
Default Value:1
The quantity of the covered level. -
relationships: array
Relationships
Title:
Relationships
The relationships resource is used to view, create, update, and delete the subscription product relationships details, such as relationship type, source subscription product PUID, and target subscription product PUID. -
RemoveHoldFlag: boolean
Indicates if the hold on the covered level has to be removed.
-
RenewalType: string
Title:
Renewal Type
Maximum Length:30
The type of the covered level renewal. -
RenewedDate: string
(date)
The date when the covered level was renewed.
-
RepriceFlag: boolean
Indicates whether the subscription covered level should be repriced or not. If passed as 'true', the subscription covered level and its child covered levels will be repriced.
-
ReturnCreditMethod: string
Title:
Close Credit Method
Maximum Length:230
The method used to return the credit. -
RevenueOption: string
Title:
Revenue Accounting Option
Maximum Length:30
Revenue Option -
RollupTotal: number
The rollup total of covered level.
-
SerialNumber: string
Title:
Covered Asset Serial Number
Read Only:true
Maximum Length:80
The serial number of the covered level. -
SourceKey: string
Maximum Length:
120
The source key of the covered level. -
SourceLineKey: string
Maximum Length:
120
The source line key of the covered level. -
SourceLineNumber: string
Maximum Length:
120
The source line number of the covered level. -
SourceNumber: string
Maximum Length:
120
The source number of the covered level. -
SourceSystem: string
Maximum Length:
30
The source system of the covered level. -
StartDate: string
(date)
Title:
Covered Level Start Date
The date when the covered level starts. -
Status: string
Title:
Covered Level Status
Maximum Length:30
The status of the covered level. -
StatusName: string
Title:
Status
The meaning of the status of the covered level. -
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
-
SuppressedCreditAmount: number
The credit amount that was suppressed.
-
SuspendCreditMethod: string
Maximum Length:
30
Indicates if the credit method has to be suspended. -
SuspendedDate: string
(date)
Title:
Covered Level Suspend Date
The date when the covered level was suspended. -
SuspendReason: string
Title:
Covered Level Suspend Reason
Maximum Length:30
The reason for suspending the credit method for the covered level. -
TaxAmount: number
The tax amount levied on the transaction.
-
TaxError: string
Maximum Length:
4000
The tax error, if any, in the calculated amount. -
TotalContractValue: number
Title:
Covered Level Contract Value
The total contract value associated with the covered level. -
Type: string
Title:
Type
Maximum Length:30
The type of the covered level. -
TypeName: string
Title:
Covered Level Type
The name of the type of the covered level. -
UnitPrice: number
Title:
Unit Price
The unit price of the covered level.
Nested Schema : Bill Lines
Type:
array
Title:
Bill Lines
The bill lines resource is used to view, create, update, and delete the subscription bill line details, such as charge period, date bill from, date billed to, amount, recurring flag, invoice text, usage quantity, and usage flags.
Show Source
Nested Schema : Charges
Type:
array
Title:
Charges
The charges resource is used to view, create, update, and delete the subscription charge details, such as charge name, charge definition, price type, price periodicity, and tiered flag.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Relationships
Type:
array
Title:
Relationships
The relationships resource is used to view, create, update, and delete the subscription product relationships details, such as relationship type, source subscription product PUID, and target subscription product PUID.
Show Source
Nested Schema : subscriptionProducts-coveredLevels-billLines-item-response
Type:
Show Source
object
-
Amount: number
Title:
Amount
The amount for which the bill is generated. -
billAdjustments: array
Bill Adjustments
Title:
Bill Adjustments
The bill adjustments resource is used to view, create, update, and delete the subscription bill adjustment details, such as adjustment name, adjustment value, adjustment type, reason, and effectivity. -
BillingPeriod: number
Title:
Sequence
The period for which the bill is generated. -
BillLineId: integer
(int64)
The unique identifier of the bill line.
-
BillLinePuid: string
Maximum Length:
120
The public unique identifier of the bill line. -
BusinessUnitId: integer
The ID of the business unit associated with the bill line.
-
ChargeDefinition: string
Maximum Length:
30
The definition that indicates the purpose of the charge. -
ChargeId: integer
(int64)
The unique identifier of the charge.
-
ChargeName: string
Title:
Charge Name
Maximum Length:120
The name of the charge associated with the bill line. -
ChargePeriod: number
Title:
Period
The usage period that was charged. -
ChargePeriodFactor: number
The change period factor associated with the bill line.
-
ChargePuid: string
Read Only:
true
The public unique identifier of the charge. -
CoveredLevelId: integer
(int64)
The unique identifier of the covered level.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the billing line. -
CreationDate: string
(date-time)
Read Only:
true
The date when the billing line was created. -
CreditMemoAmount: number
The amount for the credit memo.
-
CreditMemoFlag: string
Indicates if there is a credit memo associated with the bill line.
-
CreditMemoReason: string
The reason to raise the credit memo.
-
CreditMemoReasonCode: string
Maximum Length:
30
The code of the credit memo reason code. -
CustomerTrxTypeSequenceId: integer
(int64)
Customer Transaction Type Sequence Id
-
DateBilledFrom: string
(date)
Title:
Bill-from Date
The date from which the bill was generated. -
DateBilledTo: string
(date)
Title:
Bill-to Date
The date up to which the bill is generated. -
DateToInterface: string
(date)
Title:
Interface Date
The date to interface for the bill line. -
InterfacedFlag: boolean
Title:
Interfaced
Maximum Length:1
Default Value:false
Indicates whether the bill line is interfaced or not. -
InvoiceBillLineId: integer
(int64)
The unique identifier of the invoice bill line.
-
InvoiceDate: string
(date)
The date when the invoice was raised.
-
InvoiceText: string
Title:
Invoice Text
Maximum Length:240
The text in the bill line invoice. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the billing line was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the billing line. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of the user who last updated the billing line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ListPrice: number
The list price of the product associated with the bill line.
-
MilestoneEventId: integer
(int64)
The ID of the milestone event associated with the bill line.
-
MilestoneEventName: string
The name of the milestone event associated with the bill line.
-
NewCreditMemoPUID: string
The unique public identifier of the new credit memo.
-
PricedQuantity: number
The quantity for which the bill line was charged.
-
PricingError: string
Maximum Length:
1000
The error in pricing, if any. -
RecurringFlag: boolean
Maximum Length:
1
Indicates whether the line is recurring or not. -
RetrieveInvoiceFlag: boolean
Title:
Retrieve Invoice from Receivables
Maximum Length:1
Retrieve Invoice Flag -
RevenueLineId: integer
(int64)
The unique identifier of the revenue line.
-
RevenueOption: string
Title:
Revenue Accounting Option
Maximum Length:30
Revenue Option -
RevenuePeriod: string
Title:
Revenue Effectivity Periods
Maximum Length:30
Revenue Period -
SentDate: string
(date)
Title:
Sent Date
The date invoice information is sent to receivables. -
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
-
SummarizedBillLineId: integer
Title:
Summarized Bill Line ID
Summarized Bill Line ID -
TransactionAmount: number
Title:
Invoice Amount
The amount for which the transaction occurred. -
TransactionClass: string
Title:
Transaction Class
Maximum Length:30
The class of the transaction. -
TransactionClassMeaning: string
Title:
Class
The meaning of transaction class lookup. -
TransactionDate: string
(date)
Title:
Invoice Date
The date when the transaction occurred. -
TransactionNumber: string
Title:
Invoice Number
Maximum Length:30
The number of the transaction. -
TransactionTax: number
Title:
Tax
The tax levied on the transaction. -
TransactionTypeName: string
The transaction type name of the subscription bill line.
-
TruedUpYn: string
Maximum Length:
3
Indicates if the bill line has a trueup period. -
TrxId: integer
(int64)
The AR transaction ID.
-
TrxLineId: integer
(int64)
The AR transaction line ID.
-
UsageAcquiredFlag: boolean
Maximum Length:
1
Indicates whether the usage has been acquired or not. -
UsageCaptureDate: string
(date)
The date when the usage was captured.
-
UsageChargeType: string
Title:
Usage Charge Type
Maximum Length:30
The type of usage charge. -
UsageChargeTypeName: string
The name of the usage charge type.
-
UsageFlag: boolean
Maximum Length:
1
Indicates whether the line is a usage line or not. -
UsagePricedFlag: boolean
Maximum Length:
1
Indicates whether the usage line has been priced or not. -
UsageQuantity: number
Title:
Usage Quantity
The quantity of the usage.
Nested Schema : Bill Adjustments
Type:
array
Title:
Bill Adjustments
The bill adjustments resource is used to view, create, update, and delete the subscription bill adjustment details, such as adjustment name, adjustment value, adjustment type, reason, and effectivity.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-coveredLevels-billLines-billAdjustments-item-response
Type:
Show Source
object
-
AdjustmentBasis: string
Title:
Basis
Maximum Length:30
The basis on which the bill is adjusted. -
AdjustmentName: string
Title:
Adjustment
Maximum Length:120
The name of the bill adjustment. -
AdjustmentReasonCode: string
Maximum Length:
30
The code of the adjustment reason. -
AdjustmentType: string
Title:
Type
Maximum Length:30
The type of the bill adjustment. -
AdjustmentValue: number
Title:
Value
The value by which the bill is adjusted. -
AutoAdjustmentFlag: boolean
Maximum Length:
3
Indicates whether the adjustment is automatic or not. -
BasisEnableFlag: boolean
Indicates if the base has been enabled for the bill adjustment.
-
BillAdjustmentId: integer
(int64)
The unique identifier of the bill adjustment.
-
BillAdjustmentPuid: string
Maximum Length:
120
The public unique identifier of the bill adjustment. -
BillLineId: integer
(int64)
The unique identifier of the bill line.
-
ChargeAdjustmentId: integer
(int64)
The unique identifier of the charge adjustment.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the bill adjustment. -
CreationDate: string
(date-time)
Read Only:
true
The date when the bill adjustment was created. -
CurrencyCode: string
The current code used for the bill adjustment.
-
Effectivity: string
Maximum Length:
30
The effectivity of the bill adjustment. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the bill adjustment was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the bill adjustment. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of the user who last updated the bill adjustment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NumberOfPeriods: number
The number of periods
-
PeriodFrom: number
The period from which the bill was adjusted.
-
PeriodUntil: number
The period until which the bill is adjusted.
-
Reason: string
Title:
Reason Details
Maximum Length:120
The reason why the bill is adjusted. -
RevenueAdjustmentFromDate: string
(date)
Title:
Revenue Effective Start Date
Revenue Adjustment From Date -
RevenueAdjustmentToDate: string
(date)
Title:
Revenue Effective End Date
Revenue Adjustment To Date -
RevenueOption: string
Title:
Revenue Accounting Option
Maximum Length:30
Revenue Option -
RevenuePeriod: string
Title:
Revenue Effectivity Periods
Maximum Length:30
Revenue Period -
SequenceNumber: number
Title:
Sequence
The sequence number of the bill adjustment. -
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-coveredLevels-charges-item-response
Type:
Show Source
object
-
adjustments: array
Adjustments
Title:
Adjustments
The adjustments resource is used to view, create, update, and delete the subscription charge adjustment details, such as adjustment name, adjustment type, adjustment value, adjustment reason, and effectivity. -
AggregationMethod: string
Maximum Length:
30
The aggregation method used for the charges. -
Allowance: number
Title:
Allowance
The allowance part of the charge. -
AssetMeterYn: boolean
Maximum Length:
1
The flag whether it is an asset meter or not. -
BillingFreq: string
Maximum Length:
30
Billing Frequency -
BillingFreqName: string
Title:
Billing Frequency
Maximum Length:255
Billing Frequency Name -
BillLineId: integer
(int64)
The unique identifier of the bill line.
-
BlockSize: number
Title:
Block Size
The block size of the charge. -
ChargeDefinition: string
Title:
Charge Name
Maximum Length:30
The definition that indicates the purpose of the charge. -
ChargeDefinitionName: string
The name of the charge definition.
-
ChargeId: integer
(int64)
The unique identifier of the charge.
-
chargeMilestoneEvents: array
Charge Milestone Events
Title:
Charge Milestone Events
The charge milestone events resource is used to view, create, update, and delete the milestone events associated with a charge of a subscription. -
ChargeName: string
Title:
Charge Name
Maximum Length:120
The name of the charge. -
ChargePeriodCode: string
Maximum Length:
30
The code of the charge period associated with the charge. -
ChargePuid: string
Maximum Length:
120
The public unique identifier of the charge. -
chargeTiers: array
Charge Tiers
Title:
Charge Tiers
The charge tiers resource is used to view, create, update, and delete the subscription charge tier details, such as tier from, tier to, and list price. -
CoveredLevelId: integer
(int64)
The unique identifier of the covered level.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the charge. -
CreationDate: string
(date-time)
Read Only:
true
The date when the charge was created. -
EnableProration: string
Maximum Length:
1
Indicates whether proration is enabled or not. -
EstimatedAmount: number
Title:
Estimated Amount
The estimated amount of the charges. -
EstimatedMethodName: string
Title:
Estimation Method
The method used to estimate the amount. -
EstimatedQuantity: number
Title:
Estimated Quantity
The estimated quantity for the charge. -
EstimationMethod: string
Title:
Estimation Method
Maximum Length:30
The method used to estimate the amount. -
ExternalKey: string
Maximum Length:
120
The external key used to measure the charge. -
ExternalParentKey: string
Maximum Length:
120
The external parent key. -
InitialMeterReadingId: integer
(int64)
The initial meter reading identifier value.
-
InvoicingRuleId: integer
(int64)
The ID of the invoice rule.
-
InvoicingRuleName: string
Title:
Invoicing Rule
The name of the invoice rule. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the charge was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the charge. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of the user who last updated the charge. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MeterDefinitionId: integer
(int64)
The unique identifier of the meter definition associated with the charges.
-
MeterId: integer
(int64)
The unique identifier of the meter associated with the charges.
-
MilestoneBillingFlag: boolean
Indicates whether the billing is impacted by milestone events or not.
-
MilestoneRevenueFlag: boolean
Indicates whether the revenue is impacted by milestone events or not.
-
MilestoneTemplateId: integer
(int64)
The ID of the milestone event associated with a charge.
-
MilestoneTemplateName: string
Maximum Length:
120
The name of the milestone template associated with a charge. -
MinimumAmount: number
Title:
Minimum Amount
The minimum amount to be charged. -
MinimumQuantity: number
Title:
Minimum Quantity
The minimum quantity that is allowed. -
PeriodicBillingFlag: boolean
Maximum Length:
1
Indicates whether periodic billing is allowed or not. -
PeriodicRevenueFlag: boolean
Title:
Enable Periodic Revenue Recognition
Maximum Length:1
Indicates the periodic revenue recognition of one-time charges. -
PrePaymentNumber: integer
(int64)
Title:
Prepayment Number
The prepayment number for the charge. -
PricePeriodicity: string
Title:
Periodicity
Maximum Length:30
The price periodicity for the charge. Indicates the frequency when the charge has to be applied. -
PricePeriodicityName: string
The name of the price periodicity.
-
PriceType: string
Maximum Length:
30
The price type associated with the charge. -
QuotedTcv: number
The quoted TCV of the charge.
-
RecurringPricePeriodicityCode: string
Maximum Length:
30
The recurring price periodicity code of the charge. -
RollupFlag: boolean
Maximum Length:
1
Indicates if the charge needs to be rolled up. -
SequenceNumber: integer
(int32)
The sequence number for the charge.
-
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
-
TieredFlag: boolean
Maximum Length:
3
Indicates whether the charge has tiers. -
TierType: string
Title:
Tier Type
Maximum Length:30
The type of the charge tier. -
TrueUpPeriod: string
Title:
True Up Period
Maximum Length:30
Default Value:ORA_OSS_USAGE_BILLING_PERIOD
The identifier of the trueup period. -
TrueUpPeriodName: string
Title:
True Up Period
The name of the trueup period. -
UnitListPrice: number
Title:
List Price
The price of the unit list. -
UsagePriceLockFlag: boolean
Maximum Length:
3
Indicates whether the usage price is locked or not. -
UsageUnitOfMeasure: string
Maximum Length:
3
The usage unit of measure of the charge.
Nested Schema : Adjustments
Type:
array
Title:
Adjustments
The adjustments resource is used to view, create, update, and delete the subscription charge adjustment details, such as adjustment name, adjustment type, adjustment value, adjustment reason, and effectivity.
Show Source
Nested Schema : Charge Milestone Events
Type:
array
Title:
Charge Milestone Events
The charge milestone events resource is used to view, create, update, and delete the milestone events associated with a charge of a subscription.
Show Source
Nested Schema : Charge Tiers
Type:
array
Title:
Charge Tiers
The charge tiers resource is used to view, create, update, and delete the subscription charge tier details, such as tier from, tier to, and list price.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-coveredLevels-charges-adjustments-item-response
Type:
Show Source
object
-
AdjustmentBasis: string
Title:
Basis
Maximum Length:30
The basis of the adjustment. -
AdjustmentName: string
Title:
Adjustment
Maximum Length:120
The name of the adjustment. -
AdjustmentReasonCode: string
Title:
Reason
Maximum Length:30
The code of the adjustment reason. -
AdjustmentReasonMeaning: string
Title:
Reason
The translated adjustment reason. -
AdjustmentType: string
Title:
Type
Maximum Length:30
The type of the adjustment. -
AdjustmentValue: number
Title:
Value
The value of the adjustment. -
AutoAdjustmentFlag: boolean
Maximum Length:
3
Indicates whether the adjustment is automatic or not. -
ChargeAdjustmentId: integer
(int64)
The unique identifier of the charge adjustment.
-
ChargeAdjustmentPuid: string
Maximum Length:
120
The public unique identifier of the charge adjustment. -
ChargeId: integer
(int64)
The unique identifier of the charge.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the adjustment. -
CreationDate: string
(date-time)
Read Only:
true
The date when the adjustment was created. -
Effectivity: string
Title:
Effectivity
Maximum Length:30
The adjustment effectivity -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the adjustment was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the adjustment. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of the user who last updated the adjustment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NumberOfPeriods: number
The number of periods
-
ObjectVersionNumber: integer
(int32)
The number used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
-
PeriodFrom: number
The period from which the adjustment was initiated.
-
PeriodUntil: number
The period until which the adjustment is initiated.
-
Reason: string
Title:
Reason Description
Maximum Length:120
The reason for the adjustment. -
SequenceNumber: integer
(int32)
Title:
Sequence
The sequence number of the adjustment. -
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-coveredLevels-charges-chargeMilestoneEvents-item-response
Type:
Show Source
object
-
BillingOffset: number
The billing offset associated with a milestone event.
-
BillLineId: integer
(int64)
The bill line ID associated with the milestone event.
-
ChargeId: integer
(int64)
The charge ID with which the milestone event is associated.
-
ChargePuid: string
Maximum Length:
120
Default Value:Charges.ChargePuid
The PUID of the charge to which the milestone event is associated. -
CompletionDate: string
(date)
The completion date of the milestone event.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The login of the user who created the milestone event. -
CreationDate: string
(date-time)
Read Only:
true
The date on which the milestone event was created. -
EventId: integer
(int64)
The ID of the milestone event.
-
EventSource: string
Maximum Length:
30
The source of the milestone event. -
EventSourceReference: string
Maximum Length:
120
The source reference of the milestone event. -
EventType: string
Maximum Length:
30
The type of the milestone event. -
ExpectedCompletionDate: string
(date)
The expected completion date of a milestone event.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date of which the milestone event was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who updated the milestone event the last. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login which updated the milestone event the last. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MilestoneComment: string
Maximum Length:
300
The milestone event comment. -
MilestoneName: string
Maximum Length:
30
The name of the milestone event. -
MilestonePuid: string
Maximum Length:
120
The milestone event PUID. -
ObjectVersionNumber: integer
(int32)
The object version number of the milestone event.
-
Percentage: number
The percentage associated with a milestone event.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-coveredLevels-charges-chargeTiers-item-response
Type:
Show Source
object
-
AdditionalNumberFive: number
Title:
Additional Number Five
Additional number, if any, for the charge tier. -
AdditionalNumberFour: number
Title:
Additional Number Four
Additional number, if any, for the charge tier. -
AdditionalNumberOne: number
Title:
Additional Number One
Additional number, if any, for the charge tier. -
AdditionalNumberSix: number
Title:
Additional Number Six
Additional number, if any, for the charge tier. -
AdditionalNumberThree: number
Title:
Additional Number Three
Additional number, if any, for the charge tier. -
AdditionalNumberTwo: number
Title:
Additional Number Two
Additional number, if any, for the charge tier. -
AdditionalTextOne: string
Title:
Additional Text One
Maximum Length:4000
Additional text, if any, for the charge tier. -
AdditionalTextTwo: string
Title:
Additional Text Two
Maximum Length:4000
Additional text, if any, for the charge tier. -
AdditionalTimestampOne: string
(date-time)
Title:
Additional Time-stamp One
Additional timestamp, if any, for the charge tier. -
AdditionalTimestampThree: string
(date-time)
Title:
Additional Time-stamp Three
Additional timestamp, if any, for the charge tier. -
AdditionalTimestampTwo: string
(date-time)
Title:
Additional Time-stamp Two
Additional timestamp, if any, for the charge tier. -
AddtionalTextThree: string
Title:
Additional Text Three
Maximum Length:4000
Additional text, if any, for the charge tier. -
BlockSize: number
Title:
Block Size
The block size -
ChargeId: integer
(int64)
The unique identifier of the charge.
-
ChargeTierId: integer
(int64)
The unique identifier of the charge tier.
-
ChargeTierPuid: string
Maximum Length:
120
The public unique identifier of the charge tier. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the charge tier. -
CreationDate: string
(date-time)
Read Only:
true
The date when the charge tier was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the charge tier was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the charge tier. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of the user who last updated the charge tier. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ListPrice: number
Title:
List Price
The list price -
PriceFormat: string
Title:
Price Format
Maximum Length:30
The display format of the price. -
SequenceNumber: number
The sequence number
-
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
-
TierFrom: number
Title:
Tier From
The tier from -
TierTo: number
Title:
Tier To
The tier to
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-coveredLevels-relationships-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the relationship. -
CreationDate: string
(date-time)
Read Only:
true
The date when the relationship was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the relationship was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the relationship. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of the user who last updated the relationship. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
The number used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row. -
OperationLinksPuid: string
Maximum Length:
120
The public unique identifier of the operation links. -
RelationshipTypeCode: string
Maximum Length:
30
The code indicating the type of the relationship. -
SourceAssetKey: string
Maximum Length:
120
The source asset key -
SourceProdAssociationId: integer
(int64)
The unique identifier of the source product association.
-
SourceProdAssociationPuid: string
Maximum Length:
120
The public unique identifier of the source product association. -
SourceProductPuid: string
Maximum Length:
120
The public unique identifier of the source product. -
SourceRootAssetKey: string
Maximum Length:
120
The source root asset key -
TargetProdAssociationId: integer
(int64)
The unique identifier of the target product association.
-
TargetProdAssociationPuid: string
Maximum Length:
120
The public unique identifier of the target product association. -
TargetProductPuid: string
Maximum Length:
120
The public unique identifier of the target product.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-creditCards-item-response
Type:
Show Source
object
-
AddressLine1: string
Read Only:
true
Maximum Length:255
The address line 1 of the billing address. -
AddressLine2: string
Read Only:
true
Maximum Length:255
The address line 2 of the billing address. -
AddToBillingAccountFlag: boolean
Indicates whether the party can be added as a billing account.
-
AuthorizedAmount: number
The amount the transaction was authorized for.
-
AuthRequestId: string
The card authorization request identifier.
-
CardBillingAddressId: number
Read Only:
true
The ID of the card billing address. -
CardHolderName: string
Title:
Cardholder Name
The name of the credit card holder. -
CardIssuerName: string
Read Only:
true
Maximum Length:255
The name of the card issuer. -
City: string
Read Only:
true
Maximum Length:255
The city of the billing address. -
Country: string
Read Only:
true
Maximum Length:255
The country of the billing address. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the credit card. -
CreationDate: string
(date-time)
Read Only:
true
The date when the credit card was created. -
CreditCardId: integer
(int64)
The unique identifier of the credit card.
-
CreditCardPuid: string
Maximum Length:
120
The public unique identifier of the credit card. -
ExpirationDate: string
(date)
The credit card expiration date used for processing.
-
FirstName: string
The first name of the credit card holder.
-
InstrAssignmentId: integer
(int64)
Title:
Number
The unique identifier of the instrument assignment. -
IssuerCode: string
The credit card issuing company.
-
LastName: string
The last name of the credit card holder.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the credit card was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the credit card. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of the user who last updated the credit card. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaskedNumber: string
The masked credit card number.
-
Notes: string
Title:
Notes
Maximum Length:300
The notes, if any, associated with the credit card. -
PaymentSystemOrderNumber: string
The order number for the credit card payment.
-
PostalCode: string
Read Only:
true
Maximum Length:255
The postal code of the billing address. -
RenewalCreditCardFlag: boolean
Maximum Length:
1
Indicates whether the credit card is used as Renewal Payment Method. -
State: string
Read Only:
true
Maximum Length:255
The state of the billing address. -
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The public unique identifier of the subscription product.
-
TokenNumber: string
The credit card token number used for processing.
-
VoiceAuthCode: string
The credit card voice authorization information.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-flexFields-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
The structure definition of the user descriptive flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
The display name for structure definition of the user descriptive flexfield. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-negotiatedEntitlementPlanCommitments-item-response
Type:
Show Source
object
-
Amount: number
Title:
Amount
The amount under subscription entitlement plan commitments. -
BalanceCode: string
Title:
Balance Code
Maximum Length:30
The balance code of subscription entitlement plan commitments. -
BalanceCodeId: integer
(int64)
The unique identifier of balance code under subscription entitlement plan commitments.
-
ChargeDefinitionCode: string
Maximum Length:
30
The charge definition code under subscription entitlement plan commitments. -
ChargeDefinitionId: integer
(int64)
The unique identifier for charge definition under subscription entitlement plan commitments.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the subscription entitlement plan commitments. -
CreationDate: string
(date-time)
Read Only:
true
The date of creation of the subscription entitlement plan commitments. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code of amount type balance code under subscription entitlement plan commitments. -
EntitlementPlanCommitmentId: integer
(int64)
The unique identifier of subscription entitlement plan commitments.
-
EntitlementPlanCommitmentNumber: string
Maximum Length:
120
The unique number of subscription entitlement plan commitments. -
EntitlementPlanId: integer
(int64)
The unique identifier of subscription entitlement plan.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the subscription entitlement plan commitments was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who has last updated the subscription entitlement plan commitments. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the subscription entitlement plan commitments. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
The version number of subscription entitlement plan commitments. -
Period: string
Title:
Periodicity
The period under subscription entitlement plan commitments. -
Quantity: number
Title:
Quantity
The quantity under subscription entitlement plan commitments. -
RelatedChargeDefinitionCode: string
Maximum Length:
30
The charge definition code of the related charge identifier. -
RelatedChargeDefinitionId: integer
(int64)
The unique identifier of charge definition of the related charge.
-
RelatedPeriod: string
Title:
Related Charge Periodicity
The related period of the related charge. Indicates the related charge name from which the estimates or commitments are granted. -
RoundedQuantity: number
Title:
Rounded Quantity
The rounded quantity under subscription entitlement plan commitments. -
SubscriptionProductId: integer
(int64)
The subscription product identifier of subscription entitlement plan commitments.
-
UnitOfMeasure: string
Title:
UOM
Maximum Length:3
The unit of measure of allowance under subscription entitlement plan commitments.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-negotiatedEntitlementPlanDetails-item-response
Type:
Show Source
object
-
AllowancePeriodicity: string
Title:
Periodicity
Maximum Length:30
The periodicity factor of allowance under subscription entitlement plan details. -
AllowanceQuantity: number
Title:
Quantity
The allowance quantity under subscription entitlement plan details. -
AllowanceRolloverPeriod: integer
Title:
Rollover Period
The allowance rollover period under subscription entitlement plan details. -
AllowanceRolloverPeriodUnitOfMeasure: string
Title:
Rollover Period UOM
Maximum Length:3
The unit of measure of allowance rollover under subscription entitlement plan details. -
AllowanceUnitOfMeasure: string
Title:
UOM
Maximum Length:3
The unit of measure of allowance specified for a negotiated entitlement plan. -
AllowanceValidityPeriod: integer
Title:
Validity Period
The allowance validity period under subscription entitlement plan details. -
AllowanceValidityPeriodUnitOfMeasure: string
Title:
Validity Period UOM
Maximum Length:3
The unit of measure of allowance validity under subscription entitlement plan details. -
Amount: number
Title:
Amount
The amount negotiated for an entitlement plan. -
BalanceCode: string
Title:
Balance Code
Maximum Length:30
The balance code of subscription entitlement plan details. -
BalanceCodeDescription: string
Title:
Name
Read Only:true
Maximum Length:120
The description of balance code under subscription entitlement plan details. -
BalanceCodeId: integer
(int64)
The unique identifier of balance code under subscription entitlement plan details.
-
ChargeDefinitionCode: string
Maximum Length:
30
The unique identifier for charge definition under subscription entitlement plan details. -
ChargeDefinitionId: integer
(int64)
The charge definition code under subscription entitlement plan details.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the subscription entitlement plan details. -
CreationDate: string
(date-time)
Read Only:
true
The date of creation of the subscription entitlement plan details. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code associated with the balance code of amount type of a negotiated entitlement plan. -
EntitlementPlanDetailId: integer
(int64)
The unique identifier of subscription entitlement plan details.
-
EntitlementPlanDetailNumber: string
Maximum Length:
120
The alternate unique number of subscription entitlement plan details. -
EntitlementPlanId: integer
(int64)
The unique identifier of subscription entitlement plan.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the subscription entitlement plan details was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who has last updated the subscription entitlement plan details. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the subscription entitlement plan details. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
The version number of subscription entitlement plan details.
-
PrecisionFactor: number
Title:
Rounding Factor
Read Only:true
The precision factor of subscription entitlement plan details. -
PrecisionType: string
Title:
Rounding Type
Read Only:true
Maximum Length:30
The precision type of subscription entitlement plan details. -
SubscriptionProductId: integer
(int64)
The subscription product identifier of subscription entitlement plan details.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-negotiatedEntitlementPlanEstimates-item-response
Type:
Show Source
object
-
Amount: number
Title:
Amount
The amount under subscription entitlement plan estimates. -
BalanceCode: string
Title:
Balance Code
Maximum Length:30
The balance code of subscription entitlement plan estimates. -
BalanceCodeId: integer
(int64)
The unique identifier of balance code under subscription entitlement plan estimates.
-
ChargeDefinitionCode: string
Maximum Length:
30
The charge definition code under subscription entitlement plan estimates. -
ChargeDefinitionId: integer
(int64)
The unique identifier for charge definition under subscription entitlement plan estimates.
-
ChargePeriod: string
Title:
Estimate Period
The estimate period of the subscription entitlement plan estimates. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the subscription entitlement plan estimates. -
CreationDate: string
(date-time)
Read Only:
true
The date of creation of the subscription entitlement plan estimates. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code of amount type balance code under subscription entitlement plan estimates. -
EnableRolloverFlag: boolean
Title:
Enable rollover
Maximum Length:1
Default Value:false
Indicates where the rollover is enabled for the subscription entitlement plan estimate. -
EntitlementPlanEstimateId: integer
(int64)
The unique identifier of subscription entitlement plan estimates.
-
EntitlementPlanEstimateNumber: string
Maximum Length:
120
The alternate unique number of subscription entitlement plan estimates. -
EntitlementPlanId: integer
(int64)
The unique identifier of subscription entitlement plan.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the subscription entitlement plan estimates was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who has last updated the subscription entitlement plan estimates. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the subscription entitlement plan estimates. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
The version number of subscription entitlement plan estimates. -
Period: string
Title:
Periodicity
The period under subscription entitlement plan estimates. -
Quantity: number
Title:
Quantity
The quantity under subscription entitlement plan estimates. -
RelatedChargeDefinitionCode: string
Maximum Length:
30
The charge definition code of the related charge identifier. -
RelatedChargeDefinitionId: integer
(int64)
The unique identifier of charge definition of the related charge.
-
RelatedPeriod: string
Title:
Related Charge Periodicity
The related period of the related charge. Indicates the related charge name from which the estimates or commitments are granted. -
RolloverPeriod: integer
Title:
Rollover Period
The rollover period of the subscription entitlement plan estimate. -
RolloverPeriodUnitOfMeasure: string
Title:
Rollover Period UOM
Maximum Length:3
The rollover period unit of measure of the subscription entitlement plan estimate. -
RoundedQuantity: number
Title:
Rounded Quantity
The rounded quantity under subscription entitlement plan estimates. -
SubscriptionProductId: integer
(int64)
The subscription product identifier of subscription entitlement plan estimates.
-
TrueupOverageFlag: boolean
Title:
True-up overage
Maximum Length:1
Default Value:true
Indicates whether the flag of the subscription entitlement plan estimates is overage shortage. -
TrueupShortageFlag: boolean
Title:
True-up shortage
Maximum Length:1
Default Value:true
Indicates whether the flag of the subscription entitlement plan estimates is trueup shortage. -
UnitOfMeasure: string
Title:
UOM
Maximum Length:3
The unit of measure under subscription entitlement plan estimates.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-relationships-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the relationship. -
CreationDate: string
(date-time)
Read Only:
true
The date when the relationship was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the relationship was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the relationship. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of the user who last updated the relationship. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
The number used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row. -
OperationLinksPuid: string
Maximum Length:
120
The public unique identifier of the operation links. -
RelationshipTypeCode: string
Maximum Length:
30
The code indicating the type of the relationship. -
SourceAssetKey: string
Maximum Length:
120
The source asset key -
SourceProdAssociationId: integer
(int64)
The unique identifier of the source product association.
-
SourceProdAssociationPuid: string
Maximum Length:
120
The public unique identifier of the source product association. -
SourceProductPuid: string
Maximum Length:
120
The public unique identifier of the source product. -
SourceRootAssetKey: string
Maximum Length:
120
The source root asset key -
TargetProdAssociationId: integer
(int64)
The unique identifier of the target product association.
-
TargetProdAssociationPuid: string
Maximum Length:
120
The public unique identifier of the target product association. -
TargetProductPuid: string
Maximum Length:
120
The public unique identifier of the target product.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-salesCredits-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the sales credit. -
CreationDate: string
(date-time)
Read Only:
true
The date when the sales credit was created. -
EndDate: string
(date)
The date when the sales credit was ends.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the sales credit was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the sales credit. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of the user who last updated the sales credit. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Percentage: number
The percentage
-
QuotaFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether the quota has been fulfilled. -
SalesCreditId: integer
(int64)
The unique identifier of the sales credit.
-
SalesCreditPuid: string
Maximum Length:
120
The public unique identifier of the sales credit. -
SalesCreditType: string
The type of the sales credit.
-
SalesCreditTypeId: integer
(int64)
The unique identifier of the type of the sales credit.
-
SalesPerson: string
The name of the sales person.
-
SalesPersonNumber: string
Title:
Salesperson Number
The alternate identifier of a salesperson. -
SalesrepId: integer
(int64)
The unique identifier of the sales representative.
-
StartDate: string
(date)
The date when the sales credit started.
-
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-serviceResources-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the service resource. -
CreationDate: string
(date-time)
Read Only:
true
The date on which the service resource was created. -
EnabledFlag: boolean
Title:
Enable Service Resource
Maximum Length:1
Default Value:true
Indicates whether the service resource is enabled or not. -
EndDate: string
(date)
Title:
End Date
The end date of the service resource. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the service resource was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the service resource. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the service resource. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ServiceId: string
Title:
Service Identifier
Maximum Length:120
The unique identifier of the service. -
ServiceResourceId: integer
(int64)
The unique identifier of the service resource.
-
ServiceResourcePuid: string
Maximum Length:
120
The PUID of the service resource. -
StartDate: string
(date)
Title:
Start Date
The start date of the service resource. -
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- ProductCloseCreditMethodVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_CLOSE_CREDIT_METHOD
The following properties are defined on the LOV link relation:- Source Attribute: CloseCreditMethod; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ProductCloseReasonVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_CLOSE_REASONS
The following properties are defined on the LOV link relation:- Source Attribute: CloseReason; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- SalesProductTypeLookupVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DQSC_SALES_PRODUCT_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: SalesProductType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- associatedAsset
-
Parameters:
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
The associated assets resource is used to view, create, update, and delete the assets linked to a subscription product of subscription type. - SubscriptionProductPuid:
- billLines
-
Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/billLinesParameters:
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
The bill lines resource is used to view, create, update, and delete the subscription bill line details, such as charge period, date bill from, date billed to, amount, recurring flag, invoice text, usage quantity, and usage flags. - SubscriptionProductPuid:
- cancel
-
Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/action/cancelParameters:
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
This method lets you cancel the subscription product with a reason on a specific date. - SubscriptionProductPuid:
- charges
-
Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/chargesParameters:
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
The charges resource is used to view, create, update, and delete the subscription charge details, such as charge name, charge definition, price type, price periodicity, and tiered flag. - SubscriptionProductPuid:
- close
-
Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/action/closeParameters:
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
This method lets you close a subscription product on a specific date with a reason - SubscriptionProductPuid:
- coveredLevels
-
Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevelsParameters:
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
The covered levels resource is used to create, view, update, or delete the subscription covered levels details, such as subscription ID, subscription product ID, covered asset and its associated details. - SubscriptionProductPuid:
- creditCards
-
Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/creditCardsParameters:
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
The credit cards resource is used to view, create, and update the credit cards associated with a subscription. - SubscriptionProductPuid:
- flexFields
-
Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/flexFieldsParameters:
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
The descriptive flexfields resource is used to view, create, update, and delete a descriptive flexfield. - SubscriptionProductPuid:
- negotiatedEntitlementPlanCommitments
-
Parameters:
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
The subscription entitlement plan commitments resource is used to create a negotiated entitlement plan based on commitments. These records can be created only for those balance codes which have the commitments flag enabled. - SubscriptionProductPuid:
- negotiatedEntitlementPlanDetails
-
Parameters:
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
The subscription entitlement plan details resource is used to view, create, update, and delete an entitlement plan detail. - SubscriptionProductPuid:
- negotiatedEntitlementPlanEstimates
-
Parameters:
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
The subscription entitlement plan estimates resource is used to create a negotiated entitlement plan based on estimates. These records can be created only for those balance codes which have the estimates flag enabled. - SubscriptionProductPuid:
- putOnHold
-
Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/action/putOnHoldParameters:
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
This method lets you put a subscription product on hold. - SubscriptionProductPuid:
- relationships
-
Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/relationshipsParameters:
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
The relationships resource is used to view, create, update, and delete the subscription product relationships details, such as relationship type, source subscription product PUID, and target subscription product PUID. - SubscriptionProductPuid:
- removeHold
-
Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/action/removeHoldParameters:
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
This method lets you remove hold on a subscription product. - SubscriptionProductPuid:
- resume
-
Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/action/resumeParameters:
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
This method lets you resume a suspended subscription product. - SubscriptionProductPuid:
- salesCredits
-
Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/salesCreditsParameters:
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
The sales credits resource to view, create, update, and delete the sales credits defined for a subscription or a subscription product. - SubscriptionProductPuid:
- serviceResources
-
Parameters:
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
The service resources resouce is used to view, create, update, and delete the service identifier for a subscription product. - SubscriptionProductPuid:
- suspend
-
Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/action/suspendParameters:
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
This method lets you suspend the subscription product on a specific date with a reason. - SubscriptionProductPuid:
- undoClose
-
Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/action/undoCloseParameters:
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
This method lets you undo close of a subscription product. - SubscriptionProductPuid:
Examples
The following example shows how to get a subscription product by submitting a GET request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionProducts/CDRM_4016-PRDT-2017
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "items": [ { "SubscriptionProductId": 300100182015426, "SubscriptionId": 300100181994494, "LineNumber": "4", "SubscriptionProductPuid": "CDRM_4016-PRDT-2017", "DefinitionOrganizationId": 204, "SubscriptionNumber": "CDRM_4016", "SalesProductType": "SUBSCRIPTION", "Description": "QP Item for SPT Subscription", "InventoryItemId": 300100012368232, "ItemUnitOfMeasure": "Ea", "ProductName": "QP_Item3", "Quantity": 1, "StartDate": "2019-05-30", "EndDate": null, "CloseReason": null, "CloseCreditMethod": null, "CancelReason": null, "ClosedDate": null, "CanceledDate": null, "RenewedDate": null, "PriceListId": null, "UnitPrice": null, "Status": "ORA_DRAFT", "Currency": "USD", "InvoicingRuleId": -3, "InvoicingRuleName": "Arrears Invoice", "BillOnDay": null, "BillingOffsetDays": null, "BillingFrequency": "0zG", "BillingFrequencyName": "MONTH", "AccountingRuleId": 300100033038414, "AccountingRuleName": "3 Months", "TransactionTypeName": "ORA_OSS_Invoice", "InvoiceText": "[$Product Name]: [$Charge Name] [$Bill from Date]-[$Bill to Date]", "BillToAccountId": 300100006084313, "BillToAccountNumber": "300100006084312", "BillToAccountDescription": "FOS_Customer01", "BillToSiteUseId": 300100006084331, "BillToAddress": "151 N Street,CHICAGO, IL 60601", "ShipToPartyId": null, "ShipToPartyName": null, "ShipToPartySiteId": null, "ShipToPartySiteName": null, "PaymentMethod": null, "PaymentMethodName": null, "PONumber": null, "WireNumber": null, "PaymentTermsId": 300100033038407, "PaymentTermsName": "2 Net", "PrePaymentNumber": null, "TaxExemptionHandling": "S", "TaxExemptionHandlingName": "Standard", "ExemptCertificateNumber": null, "ExemptReason": null, "OutputTaxClassification": null, "ProductFiscClassification": null, "TaxError": null, "CoverageScheduleId": null, "RenewalType": "RENEW", "BillingDateCode": "ORA_PERIOD_START", "BillingDateName": "Period start", "TotalContractValue": null, "EstimatedTax": null, "PricingError": null, "PriceAsOf": "2019-05-31", "PriceTransactionOn": "2019-05-31", "InvoicedAmount": null, "CreditedAmount": null, "CanceledAmount": null, "ClosedAmount": null, "SourceSystem": null, "SourceKey": null, "SourceNumber": null, "SourceLineKey": null, "SourceLineNumber": null, "MonthlyRecurringRevenue": null, "Duration": null, "Period": null, "GenerateBillingSchedule": null, "ExternalAssetKey": null, "ExternalParentAssetKey": null, "ExternalPriceListId": null, "ExternalRootAssetKey": null, "PriceListName": null, "NextPricingDate": null, "PricingTermsStartDate": null, "PricingTermsPricingMethod": null, "PricingTermsPeriod": null, "PricingTermsDuration": null, "PricingTermsAdjustmentPCT": null, "CorpCurrencyCode": "USD", "CurcyConvRateType": "Corporate", "AmendCreditMethod": null, "AmendCreditMethodName": null, "AmendDescription": null, "AmendEffectiveDate": null, "AmendReason": null, "AmendReasonName": null, "StatusMeaning": "Draft", "EnablePricingTermsFlag": null, "TaxClassificationMeaning": null, "CreatedBy": "CONMGR", "CreationDate": "2019-05-31T20:19:41+00:00", "LastUpdatedBy": "CONMGR", "LastUpdateDate": "2019-05-31T20:20:17.091+00:00", "LastUpdateLogin": "8981B08476560847E0533EFDF40A8CB1", "SummarizedBillingFlag": null, "InterfaceOffsetDays": null, "CoverageName": null, "links": ... }