Jump to

• Request
• Response
• Examples

Update a subscription product

patch

/crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}

Request

Path Parameters

• SubscriptionProductPuid(required): string
  The public unique identifier of the subscription product.

Header Parameters

• Metadata-Context: string
  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: string
  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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AccountingRuleId: integer (int64)
  Title: Accounting Rule ID

  The unique identifier of the accounting rule.
• AccountingRuleName: string
  Title: Accounting Rule

  The name of the accounting rule.
• AlignBillingDay: number
  Title: Align Billing Day

  The day part of the align billing from the date of a subscription product.
• AlignBillingFrom: string (date)
  Title: Align Billing From

  The from date of the billing alignment.
• AllowanceGrantFlag: string
  Indicates whether allowance type of plan is associated with the product.
• 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.
• AmendSourceProductPuid: string
  Title: Amended Subscription Product PUID

  Maximum Length: 255

  Amend Source Product Puid
• 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.
• BalanceManagementError: string
  Title: Balance Management Error

  Maximum Length: 2000

  The balance management error.
• BalanceProfileName: string
  Title: Profile Name

  The name of the balance profile associated with the product.
• BalanceRegisterId: integer (int64)
  Title: Balance Register ID

  The ID of the balance register associated with the product.
• BatchTag: string
  Title: Batch Tag

  Maximum Length: 30

  Batch Tag
• 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: Account Id

  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 ID

  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
  Title: Bill-to Contact Number

  The bill-to contact number of the subscription product.
• BillToPartyId: integer (int64)
  Title: Bill-to Party ID

  The bill-to customer ID of the subscription product.
• BillToSite: string
  Title: Bill-to Site

  Bill To Site
• BillToSiteName: string
  Title: Bill-to Site

  Maximum Length: 255

  The bill-to site name of the subscription product.
• BillToSiteNumber: string
  Title: Bill-to Site Number

  The bill-to site number of the subscription product.
• BillToSiteUseId: integer (int64)
  Title: Site Use Id

  The unique identifier of the bill-to site use.
• CalculatedCreditAmount: number
  Title: Calculated Credit Amount

  The calculated credit amount of the subscription product.
• CalculateEstimatedTaxFlag: boolean
  Indicates whether estimated tax will be calculated for 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.
• ChargeRulesFlag: string
  Title: Charge Rules

  Indicates whether volume pricing rule is associated with the product.
• 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.
• CheckActiveExpiredAssetsExists: string
  Indicates whether any underlying assets are active or expired for the subscription product.
• CheckHoldAssetsExists: string
  Indicates whether any underlying assets are on hold for the subscription product.
• ChurnPredictionTrend: integer (int32)
  Title: Churn Prediction Trend

  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.
• CommitmentFlag: string
  Indicates whether commitment type of plan is associated with the product.
• CorpCurrencyCode: string
  Title: Currency Code

  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)
  Title: Coverage Schedule ID

  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.
• 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.
• CreditType: string
  Title: Credit Type

  Maximum Length: 30

  Indicates the type of credit to be issued to the customer on close and amend.
• CurcyConvRateType: string
  Title: Conversion Rate Type

  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.
• CustomerPONumber: string
  Title: Customer PO Number

  Maximum Length: 50

  The customer PO number reference of a subscription product.
• CustomerTrxTypeSequenceId: integer (int64)
  Title: Sequence

  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.
• Description: string
  Title: Product Description

  A brief description of the subscription product.
• DisplaySequence: number
  Title: Display Sequence

  The display sequence of the subscription product.
• 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

  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.
• EnableAdvBipTemplateFlag: boolean
  Title: Enable Advanced Configuration

  Maximum Length: 1

  Default Value: false

  Indicates whether advanced BIP configuration for usage invoice templates is enabled.
• 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.
• EntitlementPlanDescription: string
  Title: Description

  The description of the entitlement plan associated with the product.
• EntitlementPlanId: integer (int64)
  Title: Entitlement Plan ID

  The ID of the entitlement plan associated with the product.
• EntitlementPlanName: string
  Title: Name

  The name 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.
• EstimateFlag: string
  Indicates whether estimate type of plan is associated with 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
  Title: External Asset Key

  Maximum Length: 120

  The external asset key
• ExternalParentAssetKey: string
  Title: External Parent Asset Key

  Maximum Length: 120

  The external parent asset key
• ExternalPriceListId: string
  Title: External Price List ID

  Maximum Length: 120

  The unique identifier of the external price list.
• ExternalRootAssetKey: string
  Title: External Root Asset Key

  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.
• GenBillSchReqdFlag: boolean
  Title: Billing schedule update required

  Maximum Length: 1

  Generate Bill Schedule Required Flag
• 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.
• InflightFlag: boolean
  Title: Subscription In-Process

  Maximum Length: 1

  Indicates whether the subscription product is inflight or not.
• InterfaceOffsetDays: integer (int32)
  Title: Billing Interface Offset Days

  The number of days that the interface needs to be offset for.
• InventoryItemId: integer (int64)
  Title: Item ID

  The unique identifier of the inventory item.
• InvoiceBipReportCode: string
  Title: BIP Data Source

  Maximum Length: 30

  The code of the type of template to pick for the invoice report.
• InvoicedAmount: number
  Title: Invoiced Amount

  The amount specified in the invoice.
• InvoiceText: string
  Title: Invoice Text

  Maximum Length: 4000

  The text in the billing invoice.
• InvoicingRuleId: integer (int64)
  Title: Invoicing Rule Id

  The unique identifier of the invoicing rule.
• InvoicingRuleName: string
  Title: Invoicing Rule

  The name of the invoicing rule.
• IsProductCreatedFromAmendFlag: boolean
  Indicates whether subscription product is created from amend action.
• ItemUnitOfMeasure: string
  Title: Pricing UOM Code

  Maximum Length: 15

  The unit of measure used to measure the items.
• ItemUnitOfMeasureMeaning: string
  Title: Pricing UOM

  The display name of item unit of measure.
• LastLifecycleUpdateDate: string (date-time)
  Title: Last Lifecycle Update Date

  Last Lifecycle Update Date
• LegacyRetrospectiveFlag: string
  Maximum Length: 1

  Indicates whether the product had legacy retrospective accounting.
• MilestoneBasedChargeFlag: boolean
  Indicates whether the charge for the product is milestone based.
• 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.
• negotiatedVolumePricingRules: array Subscription Entitlement Pricing Rules
  Title: Subscription Entitlement Pricing Rules

  The subscription entitlement plan charge rules resource is used to view, create, update, and delete a negotiated entitlement plan charge rule which is used for the rating of a subscription product.
• NextBillStartDate: string (date)
  Title: Next Bill Start Date

  Next Bill Start Date
• NextPricingDate: string (date)
  Title: Next Pricing Date

  The date when the next pricing will occur.
• OrderFulfillLineId: integer (int64)
  Title: Order Fulfillment Line ID

  The ID of the sales order fulfillment line associated with the subscription product.
• OrderFulfillLineNumber: integer (int32)
  Title: Order Fulfillment Line Number

  The number of the sales order fulfillment line associated with the subscription product.
• OutputTaxClassification: string
  Title: Output Tax Class

  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 ID

  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.
• 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)
  Title: Price List

  The unique identifier of the price list.
• PriceListName: string
  Title: Price List Name

  Maximum Length: 120

  The name of the price list.
• PriceTransactionOn: string (date)
  Title: Price Transaction on Date

  The date when the price transaction occurred.
• PricingError: string
  Maximum Length: 2000

  The pricing error associated with the product.
• PricingSystem: string
  The pricing system of 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.
• 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
  Title: Product Fiscal Classification

  Maximum Length: 30

  The product fiscal classification.
• ProductName: string
  Title: Product Name

  Maximum Length: 300

  The name of the product.
• productRelationships: array Product Relationships
  Title: Product Relationships

  The product relationships resource is used to view the relationship between a source and a target product. These relationships include amendment, renewal, suspension relationships.
• Quantity: number
  Title: Quantity

  The quantity of the product.
• QuoteId: integer (int64)
  Title: Quote Id

  The quote ID associated with the subscription product.
• QuoteLineId: integer (int64)
  Title: Quote Line ID

  The quote line ID associated with the subscription product.
• RatePlanDocument: string (byte)
  The JSON representing the rate plan.
• RatePlanDocumentId: integer (int64)
  The identifier of the rate plan document.
• RatePlanId: integer (int64)
  Title: Rate Plan ID

  The unique identifier of the rate plan.
• RatePlanName: string
  Title: Rate Plan

  The name of the rate plan.
• RatePlanNumber: string
  Title: Rate Plan Number

  The number of the rate plan.
• RatePlanYn: string
  Indicates whether pricing for the subscription product is based on 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.
• RelationShipExistFlag: string
  Indicates whether relationship exists for the 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.
• RenewalPriceListId: integer (int64)
  The identifier of the renewal price list.
• RenewalPriceListName: string
  Title: Renewal Price List

  Maximum Length: 255

  The name of the renewal price list.
• RenewalRatePlanId: integer (int64)
  The identifier of the renewal rate plan.
• RenewalRatePlanNumber: string
  The renewal rate plan number.
• 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.
• RenewSourceProductPuid: string
  Title: Renewed Subscription Product PUID

  Maximum Length: 255

  Renew Source Product Puid
• 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)
  Title: Requested Entitlement Plan ID

  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.
• RequestedPriceListId: integer (int64)
  Title: Override Price List

  The identifier of the requested price list.
• RequestedRatePlanId: integer (int64)
  Title: Requested Rate Plan ID

  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.
• RetainSubsOnRenewFlag: boolean
  Title: Don't Create New Renewal Subscription

  Maximum Length: 1

  Indicates whether the renewal should happen in the source subscription.
• RevenueOption: string
  Title: Revenue Accounting Option

  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)
  Title: Sales Order ID

  The ID of the sales order associated with the subscription product.
• SalesOrderLineId: integer (int64)
  Title: Sales Order Line ID

  The sales order line ID 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 ID

  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 ID

  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
  Title: Ship-to Contact Number

  The ship-to contact number of the subscription product.
• ShipToPartyId: integer (int64)
  Title: Ship-to Party ID

  The unique identifier of the ship-to party.
• ShipToPartyName: string
  Title: Ship-to Party

  The name of the ship-to party.
• ShipToPartySiteId: integer (int64)
  Title: Ship-to Party Site ID

  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.
• smartActions: array Subscription Product User Actions
  Title: Subscription Product User Actions

  The smart actions resource stores the endpoint and security details for every user action.
• SourceKey: string
  Title: Source Key

  Maximum Length: 120

  The identifier of the product in the source system.
• SourceLineKey: string
  Title: Source Line Key

  Maximum Length: 120

  The source line key
• SourceLineNumber: string
  Title: External Source Line Number

  Maximum Length: 120

  The source line number
• SourceNumber: string
  Title: External Source Number

  Maximum Length: 120

  The alternate identifier of the product in the source system.
• SourceSystem: string
  Title: Source System

  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.
• 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.
• SummarizedRatingFlag: boolean
  Title: Enable summarize rating

  Indicates whether the entitlement plan is associated with the product is eligibile for summarized rating.
• 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.
• TaxError: string
  Title: Tax Error

  Maximum Length: 2000

  The tax error, if any, in the calculated amount.
• TaxExemptionHandling: string
  Title: Tax Exemption Handling

  Maximum Length: 30

  The tax exemption handling.
• TaxExemptionHandlingName: string
  The tax exemption handling name.
• TotalContractValue: number
  Title: Product Contract Value

  The value of the total contract.
• TransactionTypeName: string
  Title: Transaction Type

  Maximum Length: 30

  The name of the transaction type.
• UnitPrice: number
  The price of the unit.
• UpdateFlag: boolean
  Indicates whether the subscription product is updated.
• UsageEventAllowanceInvTemplate: string
  Title: Allowance

  Maximum Length: 200

  The template to show the invoice data for allowance type of balance management.
• UsageEventCommitmentInvTemplate: string
  Title: Commitment

  Maximum Length: 200

  The template to show the invoice data for commitment type of balance management.
• UsageEventEstimateInvTemplate: string
  Title: Estimate

  Maximum Length: 200

  The template to show the invoice data for estimate type of balance management.
• UsageEventRegularInvTemplate: string
  Title: Basic

  Maximum Length: 200

  The common template to show the invoice data.
• UsageInvoiceLayoutTemplate: string
  Title: BIP Template

  Maximum Length: 200

  The layout template of the usage invoice.
• ValidationStatus: string
  Title: Validation Status

  Maximum Length: 1

  The validation status of the subscription product.
• VolumeRatingFlag: boolean
  Title: Enable volume pricing

  Indicates whether the entitlement plan is associated with the product is eligibile for volume pricing.
• 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.

{
    "type":"object",
    "properties":{
        "EntitlementPlanDescription":{
            "title":"Description",
            "type":"string",
            "description":"The description of the entitlement plan associated with the product.",
            "nullable":true,
            "x-hints":{
                "sortable":false
            }
        },
        "CalculatedCreditAmount":{
            "title":"Calculated Credit Amount",
            "type":"number",
            "description":"The calculated credit amount of the subscription product.",
            "nullable":true
        },
        "NextPricingDate":{
            "title":"Next Pricing Date",
            "type":"string",
            "description":"The date when the next pricing will occur.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "CurcyConvRateType":{
            "title":"Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "EarlyTerminationPenalty":{
            "title":"Early Termination Penalty",
            "maxLength":30,
            "type":"string",
            "description":"The early termination penalty.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CancelDescription":{
            "title":"Cancellation Description",
            "maxLength":2000,
            "type":"string",
            "description":"The cancellation reason description of the subscription product.",
            "nullable":true
        },
        "ResumeDate":{
            "type":"string",
            "description":"The date when the product should be resumed.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ChurnProbability":{
            "title":"Churn Probability",
            "type":"number",
            "description":"The probability of churn associated with the product.",
            "nullable":true
        },
        "SourceKey":{
            "title":"Source Key",
            "maxLength":120,
            "type":"string",
            "description":"The identifier of the product in the source system.",
            "nullable":true,
            "x-queryable":false
        },
        "CheckActiveExpiredAssetsExists":{
            "type":"string",
            "description":"Indicates whether any underlying assets are active or expired for the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LegacyRetrospectiveFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the product had legacy retrospective accounting.",
            "nullable":true
        },
        "SalesOrderLineId":{
            "title":"Sales Order Line ID",
            "type":"integer",
            "description":"The sales order line ID associated with the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the subscription product.",
            "nullable":false,
            "default":"DRAFT"
        },
        "AlignBillingFrom":{
            "title":"Align Billing From",
            "type":"string",
            "description":"The from date of the billing alignment.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "InventoryItemId":{
            "title":"Item ID",
            "type":"integer",
            "description":"The unique identifier of the inventory item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CreditedAmount":{
            "title":"Credited Amount",
            "type":"number",
            "description":"The amount credited to a account.",
            "nullable":true,
            "x-queryable":false
        },
        "PaymentTermsId":{
            "title":"Payment Terms ID",
            "type":"integer",
            "description":"The unique identifier of the payment terms.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PaymentTermsName":{
            "title":"Payment Terms",
            "type":"string",
            "description":"The name of the payment terms.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AmendDescription":{
            "title":"Amendment Description",
            "maxLength":2000,
            "type":"string",
            "description":"A brief description of the amended credit.",
            "nullable":true,
            "x-queryable":false
        },
        "RenewalPaymentMethod":{
            "title":"Renewal Payment Method",
            "maxLength":30,
            "type":"string",
            "description":"The internal code for the renewal payment method used in the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RenewPerpetuallyFlag":{
            "title":"Renew forever",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the subscription product should be renewed forever.",
            "nullable":true
        },
        "charges":{
            "title":"Charges",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-charges-item-patch-request"
            }
        },
        "ShipToPartySiteName":{
            "title":"Ship-to Site",
            "type":"string",
            "description":"The name of the ship-to party site.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "PriceListId":{
            "title":"Price List",
            "type":"integer",
            "description":"The unique identifier of the price list.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AutoExtendFlag":{
            "type":"boolean",
            "description":"Indicates if the product should be auto extended.",
            "nullable":true,
            "x-queryable":false
        },
        "GracePeriod":{
            "title":"Grace Period in Days",
            "type":"integer",
            "description":"The grace period.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AmendReasonName":{
            "type":"string",
            "description":"The name of the amend reason.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OutputTaxClassification":{
            "title":"Output Tax Class",
            "maxLength":50,
            "type":"string",
            "description":"The tax classification to use when calculating the output tax.",
            "nullable":true,
            "x-queryable":false
        },
        "MonthlyRecurringRevenue":{
            "title":"MRR",
            "type":"number",
            "description":"The monthly recurring revenue associated with the product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "enableInGenAI":"true"
            }
        },
        "CanceledAmount":{
            "title":"Canceled Amount",
            "type":"number",
            "description":"The transaction amount that was canceled.",
            "nullable":true,
            "x-queryable":false
        },
        "QuoteId":{
            "title":"Quote Id",
            "type":"integer",
            "description":"The quote ID associated with the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "LastLifecycleUpdateDate":{
            "title":"Last Lifecycle Update Date",
            "type":"string",
            "description":"Last Lifecycle Update Date",
            "format":"date-time",
            "nullable":true
        },
        "RequestedPriceListId":{
            "title":"Override Price List",
            "type":"integer",
            "description":"The identifier of the requested price list.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "DefaultRevenueAction":{
            "maxLength":30,
            "type":"string",
            "description":"The revenue management rule of the subscription product used during the amendment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UsageEventCommitmentInvTemplate":{
            "title":"Commitment",
            "maxLength":200,
            "type":"string",
            "description":"The template to show the invoice data for commitment type of balance management.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "InvoiceBipReportCode"
                ]
            }
        },
        "CustomerPONumber":{
            "title":"Customer PO Number",
            "maxLength":50,
            "type":"string",
            "description":"The customer PO number reference of a subscription product.",
            "nullable":true
        },
        "UsageInvoiceLayoutTemplate":{
            "title":"BIP Template",
            "maxLength":200,
            "type":"string",
            "description":"The layout template of the usage invoice.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "OrderFulfillLineNumber":{
            "title":"Order Fulfillment Line Number",
            "type":"integer",
            "description":"The number of the sales order fulfillment line associated with the subscription product.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "BillingDateCode":{
            "title":"Billing Date",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the billing date.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EstimateFlag":{
            "type":"string",
            "description":"Indicates whether estimate type of plan is associated with the product.",
            "nullable":true,
            "x-hints":{
                "sortable":false
            }
        },
        "billLines":{
            "title":"Bill Lines",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-billLines-item-patch-request"
            }
        },
        "PendingActivationFlag":{
            "title":"Pending activation",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the activation of the subscription product is pending or not.",
            "nullable":true,
            "x-queryable":false
        },
        "ExternalParentAssetKey":{
            "title":"External Parent Asset Key",
            "maxLength":120,
            "type":"string",
            "description":"The external parent asset key",
            "nullable":true
        },
        "RequestedEntitlementPlanId":{
            "title":"Requested Entitlement Plan ID",
            "type":"integer",
            "description":"The ID of the requested entitlement plan associated with the product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "negotiatedEntitlementPlanCommitments":{
            "title":"Subscription Entitlement Plan Commitments",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-negotiatedEntitlementPlanCommitments-item-patch-request"
            }
        },
        "PricingTermsDuration":{
            "title":"Pricing Term Duration",
            "type":"number",
            "description":"The duration for which the pricing terms last.",
            "nullable":true,
            "x-queryable":false
        },
        "WarehouseId":{
            "title":"Warehouse",
            "type":"integer",
            "description":"The warehouse ID associated with the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EndDate":{
            "title":"Product End Date",
            "type":"string",
            "description":"The date when the subscriptions ends.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "enableInGenAI":"true"
            }
        },
        "ClosedAmount":{
            "title":"Closed Amount",
            "type":"number",
            "description":"The amount at which the transaction was closed.",
            "nullable":true,
            "x-queryable":false
        },
        "RelatedProductName":{
            "title":"Product Name",
            "maxLength":300,
            "type":"string",
            "description":"The name of the replacement subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "OverrideCreditAmount":{
            "title":"Override Credit Amount",
            "type":"number",
            "description":"The override credit amount of the subscription product.",
            "nullable":true
        },
        "ValidationStatus":{
            "title":"Validation Status",
            "maxLength":1,
            "type":"string",
            "description":"The validation status of the subscription product.",
            "nullable":true
        },
        "UnitPrice":{
            "type":"number",
            "description":"The price of the unit.",
            "nullable":true,
            "x-queryable":false
        },
        "ExternalRootAssetKey":{
            "title":"External Root Asset Key",
            "maxLength":120,
            "type":"string",
            "description":"The external root asset key",
            "nullable":true
        },
        "ResumeDuration":{
            "type":"integer",
            "description":"The duration after which the the product should be resumed.",
            "nullable":true,
            "x-queryable":false
        },
        "PriceTransactionOn":{
            "title":"Price Transaction on Date",
            "type":"string",
            "description":"The date when the price transaction occurred.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "GenerateBillingSchedule":{
            "title":"Generate billing schedule for full period",
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the billing schedule is to be generated or not.",
            "nullable":true,
            "x-queryable":false
        },
        "CloseDescription":{
            "title":"Close Description",
            "maxLength":2000,
            "type":"string",
            "description":"The close reason description of the subscription product.",
            "nullable":true
        },
        "AmendReason":{
            "title":"Amendment Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason why the credit was amended.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BillingOffsetDays":{
            "title":"Billing Offset Days",
            "type":"integer",
            "description":"The billing offset days.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeRulesFlag":{
            "title":"Charge Rules",
            "type":"string",
            "description":"Indicates whether volume pricing rule is associated with the product.",
            "nullable":true,
            "x-hints":{
                "sortable":false
            }
        },
        "TaxExemptionHandlingName":{
            "type":"string",
            "description":"The tax exemption handling name.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BillToAccountNumber":{
            "title":"Billing Account",
            "maxLength":30,
            "type":"string",
            "description":"The account number of the bill-to account.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "BillingDateName":{
            "type":"string",
            "description":"The name of the billing date.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PenaltyChargeName":{
            "type":"string",
            "description":"The penalty charge name.",
            "nullable":true
        },
        "TaxExemptionHandling":{
            "title":"Tax Exemption Handling",
            "maxLength":30,
            "type":"string",
            "description":"The tax exemption handling.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "smartActions":{
            "title":"Subscription Product User Actions",
            "type":"array",
            "description":"The smart actions resource stores the endpoint and security details for every user action.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-smartActions-item-patch-request"
            }
        },
        "RelatedInventoryItemId":{
            "title":"Related Inventory Item ID",
            "type":"integer",
            "description":"The unique identifier of the item associated to the replacement subscription product.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RatePlanDocumentId":{
            "type":"integer",
            "description":"The identifier of the rate plan document.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "productRelationships":{
            "title":"Product Relationships",
            "type":"array",
            "description":"The product relationships resource is used to view the relationship between a source and a target product. These relationships include amendment, renewal, suspension relationships.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-productRelationships-item-patch-request"
            }
        },
        "ShipToAccountNumber":{
            "title":"Ship-to Account",
            "type":"string",
            "description":"The ship-to account number of the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "sortable":false,
                "dependencies":[
                    "ShipToAccountNumber1"
                ]
            }
        },
        "negotiatedVolumePricingRules":{
            "title":"Subscription Entitlement Pricing Rules",
            "type":"array",
            "description":"The subscription entitlement plan charge rules resource is used to view, create, update, and delete a negotiated entitlement plan charge rule which is used for the rating of a subscription product.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-negotiatedVolumePricingRules-item-patch-request"
            }
        },
        "ShipToContactId":{
            "title":"Ship-to Contact ID",
            "type":"integer",
            "description":"The ship-to contact ID of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AlignBillingDay":{
            "title":"Align Billing Day",
            "type":"number",
            "description":"The day part of the align billing from the date of a subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Duration":{
            "title":"Duration",
            "type":"integer",
            "description":"Product Duration",
            "nullable":true,
            "x-queryable":false
        },
        "RequestedRatePlanId":{
            "title":"Requested Rate Plan ID",
            "type":"integer",
            "description":"The unique identifier of the requested rate plan.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RenewalType":{
            "title":"Product Renewal Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of subscription renewal.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CommitmentFlag":{
            "type":"string",
            "description":"Indicates whether commitment type of plan is associated with the product.",
            "nullable":true,
            "x-hints":{
                "sortable":false
            }
        },
        "PriceAdjustmentType":{
            "title":"Price Adjustment Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the price adjustment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EarlyTerminationFee":{
            "title":"Early Termination Fee",
            "type":"number",
            "description":"The early termination fee.",
            "nullable":true,
            "x-queryable":false
        },
        "AmendSourceProductPuid":{
            "title":"Amended Subscription Product PUID",
            "maxLength":255,
            "type":"string",
            "description":"Amend Source Product Puid",
            "nullable":true
        },
        "RenewalPoNumber":{
            "title":"Product Renewal PO Number",
            "maxLength":50,
            "type":"string",
            "description":"The purchase order number of the renewed subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "RenewalPaymentMethod"
                ]
            }
        },
        "SourceLineNumber":{
            "title":"External Source Line Number",
            "maxLength":120,
            "type":"string",
            "description":"The source line number",
            "nullable":true,
            "x-queryable":false
        },
        "SalesProductType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the sales product.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PriceAsOf":{
            "title":"Price as of Date",
            "type":"string",
            "description":"The price of the product as of a certain date.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "CoverageName":{
            "title":"Template Name",
            "type":"string",
            "description":"The name of the coverage associated with the product.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "CoverageName1"
                ]
            }
        },
        "IsProductCreatedFromAmendFlag":{
            "type":"boolean",
            "description":"Indicates whether subscription product is created from amend action.",
            "nullable":true
        },
        "RatePlanNumber":{
            "title":"Rate Plan Number",
            "type":"string",
            "description":"The number of the rate plan.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ShipToContactNumber":{
            "title":"Ship-to Contact Number",
            "type":"string",
            "description":"The ship-to contact number of the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "ShipToContactNumber1"
                ]
            }
        },
        "ProductChangeSchedule":{
            "title":"Apply Change",
            "maxLength":30,
            "type":"string",
            "description":"The product change schedule is applicable on RENEWAL, ANNIVERSARY or SPECIFIC_DATE.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipToAccountId":{
            "title":"Ship-to Account ID",
            "type":"integer",
            "description":"The ship-to account ID of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AccountingRuleName":{
            "title":"Accounting Rule",
            "type":"string",
            "description":"The name of the accounting rule.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the subscription product is updated.",
            "nullable":true
        },
        "SalesOrderId":{
            "title":"Sales Order ID",
            "type":"integer",
            "description":"The ID of the sales order associated with the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PricingTermsAdjustmentPCT":{
            "title":"Pricing Term Adjustment Percentage",
            "type":"number",
            "description":"The adjustment in the pricing terms.",
            "nullable":true,
            "x-queryable":false
        },
        "TaxError":{
            "title":"Tax Error",
            "maxLength":2000,
            "type":"string",
            "description":"The tax error, if any, in the calculated amount.",
            "nullable":true,
            "x-queryable":false
        },
        "InterfaceOffsetDays":{
            "title":"Billing Interface Offset Days",
            "type":"integer",
            "description":"The number of days that the interface needs to be offset for.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":5
            }
        },
        "CreditType":{
            "title":"Credit Type",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of credit to be issued to the customer on close and amend.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "GenBillSchReqdFlag":{
            "title":"Billing schedule update required",
            "maxLength":1,
            "type":"boolean",
            "description":"Generate Bill Schedule Required Flag",
            "nullable":true
        },
        "SourceLineKey":{
            "title":"Source Line Key",
            "maxLength":120,
            "type":"string",
            "description":"The source line key",
            "nullable":true,
            "x-queryable":false
        },
        "EnableUpfrontBillingFlag":{
            "title":"Bill immediately",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether billing is done upfront or not.",
            "nullable":true,
            "x-queryable":false
        },
        "RepriceFlag":{
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionNumber":{
            "title":"Subscription Number",
            "maxLength":120,
            "type":"string",
            "description":"The subscription number of the product.",
            "nullable":false,
            "default":"Subscriptions.SubscriptionNumber",
            "x-hints":{
                "enableInGenAI":"true"
            }
        },
        "RenewalRatePlanNumber":{
            "type":"string",
            "description":"The renewal rate plan number.",
            "nullable":true,
            "x-queryable":false
        },
        "ExemptCertificateNumber":{
            "title":"Tax Exemption Certificate Number",
            "maxLength":80,
            "type":"string",
            "description":"The number of the exempt certificate.",
            "nullable":true,
            "x-queryable":false
        },
        "BillToContactId":{
            "title":"Bill-to Contact ID",
            "type":"integer",
            "description":"The bill-to contact ID of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RequestedEntitlementPlanNumber":{
            "title":"Entitlement Plan Number",
            "type":"string",
            "description":"The number of the requested entitlement plan associated with the product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "RequestedEntitlementPlanNumber1",
                    "RequestedEntitlementPlanId"
                ]
            }
        },
        "ShipToPartySiteNumber":{
            "title":"Ship-to Site Number",
            "type":"string",
            "description":"The ship-to party site number of the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "EnablePricingTermsFlag":{
            "title":"Enable pricing term",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the pricing terms are enabled or not.",
            "nullable":true
        },
        "RenewalWireNumber":{
            "title":"Product Renewal Wire Number",
            "maxLength":30,
            "type":"string",
            "description":"The wire number that identifies the electronic funds transfer used to pay for a renewed subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "RenewalPaymentMethod"
                ]
            }
        },
        "associatedAsset":{
            "title":"Associated Assets",
            "type":"array",
            "description":"The associated assets resource is used to view, create, update, and delete the assets linked to a subscription product of subscription type.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-associatedAsset-item-patch-request"
            }
        },
        "RenewalRatePlanId":{
            "type":"integer",
            "description":"The identifier of the renewal rate plan.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BatchTag":{
            "title":"Batch Tag",
            "maxLength":30,
            "type":"string",
            "description":"Batch Tag",
            "nullable":true
        },
        "PONumber":{
            "title":"PO Number",
            "maxLength":50,
            "type":"string",
            "description":"The number of the purchase order.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PaymentMethod"
                ]
            }
        },
        "CheckHoldAssetsExists":{
            "type":"string",
            "description":"Indicates whether any underlying assets are on hold for the subscription product.",
            "nullable":true,
            "x-queryable":false
        },
        "AllowanceGrantFlag":{
            "type":"string",
            "description":"Indicates whether allowance type of plan is associated with the product.",
            "nullable":true,
            "x-hints":{
                "sortable":false
            }
        },
        "RenewSourceProductPuid":{
            "title":"Renewed Subscription Product PUID",
            "maxLength":255,
            "type":"string",
            "description":"Renew Source Product Puid",
            "nullable":true
        },
        "RenewalPriceListId":{
            "type":"integer",
            "description":"The identifier of the renewal price list.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "InflightFlag":{
            "title":"Subscription In-Process",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the subscription product is inflight or not.",
            "nullable":true
        },
        "ShipToPartyId":{
            "title":"Ship-to Party ID",
            "type":"integer",
            "description":"The unique identifier of the ship-to party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ResumePeriod":{
            "type":"string",
            "description":"The period of time after which the product will resume.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChurnPredictionTrend":{
            "title":"Churn Prediction Trend",
            "type":"integer",
            "description":"The churn prediction trend.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            }
        },
        "ProductChangeScheduleFrom":{
            "title":"Product Change Schedule Effective Date",
            "type":"string",
            "description":"The date from which the product change schedule is  applicable.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "PrePaymentNumber":{
            "title":"Prepayment Number",
            "type":"integer",
            "description":"The prepayment number.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "relationships":{
            "title":"Relationships",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-relationships-item-patch-request"
            }
        },
        "CloseReason":{
            "title":"Product Close Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason why the product was closed.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "InvoiceBipReportCode":{
            "title":"BIP Data Source",
            "maxLength":30,
            "type":"string",
            "description":"The code of  the type of template to pick for the invoice report.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BillToPartyId":{
            "title":"Bill-to Party ID",
            "type":"integer",
            "description":"The bill-to customer ID of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SourceNumber":{
            "title":"External Source Number",
            "maxLength":120,
            "type":"string",
            "description":"The alternate identifier of the product in the source system.",
            "nullable":true,
            "x-queryable":false
        },
        "PricingTermsPeriod":{
            "title":"Pricing Term",
            "maxLength":15,
            "type":"string",
            "description":"The period for which the pricing terms last.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CanceledDate":{
            "title":"Product Canceled Date",
            "type":"string",
            "description":"The date when the product was canceled.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "WareHouseName":{
            "title":"Warehouse",
            "type":"string",
            "description":"The warehouse name of the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "sortable":false
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PriceAdjustmentPercent":{
            "title":"Price Adjustment Value",
            "type":"number",
            "description":"The price adjustment percent.",
            "nullable":true,
            "x-queryable":false
        },
        "BillingFrequency":{
            "title":"Billing Frequency",
            "maxLength":30,
            "type":"string",
            "description":"The billing frequency.",
            "nullable":false,
            "x-queryable":false
        },
        "RenewalPaymentMethodName":{
            "title":"Renewal Payment Method Name",
            "type":"string",
            "description":"The method of payment for renewed subscription product. The payment method could be a purchase order, wire, or credit card.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RenewalDurationPeriodName":{
            "title":"Renewal Period",
            "type":"string",
            "description":"The name of the subscription product level renewal duration period override that will be used while renewing through automatic or manual renewal.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "RenewalDurationPeriodName1"
                ]
            }
        },
        "EstimatedTax":{
            "title":"Estimated Tax",
            "type":"number",
            "description":"The estimated tax on the product.",
            "nullable":true,
            "x-queryable":false
        },
        "SalesOrderNumber":{
            "title":"Sales Order Number",
            "maxLength":200,
            "type":"string",
            "description":"The number of the sales order associated with the subscription product.",
            "nullable":true
        },
        "RequestedAlignBillingDate":{
            "title":"Requested Align Billing From",
            "type":"string",
            "description":"The requested align billing date for the product.",
            "format":"date",
            "nullable":true
        },
        "PricingTermsPricingMethod":{
            "title":"Pricing Method",
            "maxLength":30,
            "type":"string",
            "description":"The method used to set the terms of the product pricing.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "serviceResources":{
            "title":"Service Resources",
            "type":"array",
            "description":"The service resources resouce is used to view, create, update, and delete the service identifier for a subscription product.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-serviceResources-item-patch-request"
            }
        },
        "EntitlementPlanName":{
            "title":"Name",
            "type":"string",
            "description":"The name of the entitlement plan associated with the product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "InvoicedAmount":{
            "title":"Invoiced Amount",
            "type":"number",
            "description":"The amount specified in the invoice.",
            "nullable":true,
            "x-queryable":false
        },
        "SuspendedDate":{
            "title":"Suspend Date",
            "type":"string",
            "description":"The date when the product was suspended.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "negotiatedEntitlementPlanEstimates":{
            "title":"Subscription Entitlement Plan Estimates",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-negotiatedEntitlementPlanEstimates-item-patch-request"
            }
        },
        "RenewalDuration":{
            "title":"Renewal Duration",
            "type":"integer",
            "description":"The subscription product level renewal duration override that will be used while renewing through automatic or manual renewal.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PricingSystem":{
            "type":"string",
            "description":"The pricing system of the product.",
            "nullable":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Product Description",
            "type":"string",
            "description":"A brief description of the subscription product.",
            "nullable":true,
            "x-queryable":false
        },
        "RelatedProductDescription":{
            "title":"Description",
            "type":"string",
            "description":"The description of the replacement subscription product.",
            "nullable":true,
            "x-queryable":false
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"number",
            "description":"The display sequence of the subscription product.",
            "nullable":true,
            "x-queryable":false
        },
        "InvoicingRuleName":{
            "title":"Invoicing Rule",
            "type":"string",
            "description":"The name of the invoicing rule.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CustomerTrxTypeSequenceId":{
            "title":"Sequence",
            "type":"integer",
            "description":"The customer transaction type sequence ID of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PaymentMethodName":{
            "title":"Payment Method Name",
            "type":"string",
            "description":"The name of the payment method.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ExternalAssetKey":{
            "title":"External Asset Key",
            "maxLength":120,
            "type":"string",
            "description":"The external asset key",
            "nullable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ExternalPriceListId":{
            "title":"External Price List ID",
            "maxLength":120,
            "type":"string",
            "description":"The unique identifier of the external price list.",
            "nullable":true
        },
        "SalesOrderLineNumber":{
            "title":"Sales Order Line Number",
            "maxLength":100,
            "type":"string",
            "description":"Sales Order Line Number",
            "nullable":true
        },
        "RevenueOption":{
            "title":"Revenue Accounting Option",
            "maxLength":30,
            "type":"string",
            "description":"Revenue Option",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "flexFields":{
            "title":"Descriptive Flexfields",
            "type":"array",
            "description":"The descriptive flexfields resource is used to view, create, update, and delete a descriptive flexfield.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-flexFields-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "EarlyTerminationPenaltyName":{
            "type":"string",
            "description":"The name of the early termination penalty.",
            "nullable":true
        },
        "VolumeRatingFlag":{
            "title":"Enable volume pricing",
            "type":"boolean",
            "description":"Indicates whether the entitlement plan is associated with the product is eligibile for volume pricing.",
            "nullable":true,
            "x-hints":{
                "sortable":false
            }
        },
        "ShipToContactName":{
            "title":"Ship-to Contact",
            "type":"string",
            "description":"The ship-to contact name of the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "sortable":false,
                "dependencies":[
                    "ShipToContactName1"
                ]
            }
        },
        "TotalContractValue":{
            "title":"Product Contract Value",
            "type":"number",
            "description":"The value of the total contract.",
            "nullable":true,
            "x-hints":{
                "enableInGenAI":"true"
            }
        },
        "SuspendReason":{
            "title":"Suspend Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason to suspend the product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DropOneTimeChargeFlag":{
            "title":"Don't copy one-time charges",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether one time charges have to be removed when the product is changed.",
            "nullable":true,
            "x-queryable":false
        },
        "SummarizedRatingFlag":{
            "title":"Enable summarize rating",
            "type":"boolean",
            "description":"Indicates whether the entitlement plan is associated with the product is eligibile for summarized rating.",
            "nullable":true,
            "x-hints":{
                "sortable":false
            }
        },
        "coveredLevels":{
            "title":"Covered Levels",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-item-patch-request"
            }
        },
        "CloseCreditMethod":{
            "title":"Close Credit Method",
            "maxLength":30,
            "type":"string",
            "description":"The method used to close the credit.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RelationShipExistFlag":{
            "type":"string",
            "description":"Indicates whether relationship exists for the product.",
            "nullable":true
        },
        "BillToSiteNumber":{
            "title":"Bill-to Site Number",
            "type":"string",
            "description":"The bill-to site number of the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ShipToPartySiteId":{
            "title":"Ship-to Party Site ID",
            "type":"integer",
            "description":"The unique identifier of the ship-to party site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CalculateEstimatedTaxFlag":{
            "type":"boolean",
            "description":"Indicates whether estimated tax will be calculated for the subscription product.",
            "nullable":true,
            "x-queryable":false
        },
        "ProductFiscClassification":{
            "title":"Product Fiscal Classification",
            "maxLength":30,
            "type":"string",
            "description":"The product fiscal classification.",
            "nullable":true,
            "x-queryable":false
        },
        "AccountingRuleId":{
            "title":"Accounting Rule ID",
            "type":"integer",
            "description":"The unique identifier of the accounting rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BillToAccountId":{
            "title":"Account Id",
            "type":"integer",
            "description":"The unique identifier of the bill-to account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "UsageEventRegularInvTemplate":{
            "title":"Basic",
            "maxLength":200,
            "type":"string",
            "description":"The common template to show the invoice data.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "InvoiceBipReportCode"
                ]
            }
        },
        "PenaltyValue":{
            "title":"Penalty Value",
            "type":"number",
            "description":"The penalty value.",
            "nullable":true,
            "x-queryable":false
        },
        "EntitlementPlanNumber":{
            "title":"Number",
            "type":"string",
            "description":"The number of the entitlement plan associated with the product.",
            "nullable":true,
            "x-hints":{
                "sortable":false
            }
        },
        "RatePlanName":{
            "title":"Rate Plan",
            "type":"string",
            "description":"The name of the rate plan.",
            "nullable":true,
            "x-queryable":false
        },
        "ClosedDate":{
            "title":"Product Close Date",
            "type":"string",
            "description":"The date when the product was closed.",
            "format":"date",
            "nullable":true
        },
        "SourceSystem":{
            "title":"Source System",
            "maxLength":30,
            "type":"string",
            "description":"The reference of the product in the source system.",
            "nullable":true
        },
        "ProductChangeReason":{
            "title":"Change Reason",
            "maxLength":300,
            "type":"string",
            "description":"The reason for the product change.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TransactionTypeName":{
            "title":"Transaction Type",
            "maxLength":30,
            "type":"string",
            "description":"The name of the transaction type.",
            "nullable":false,
            "x-queryable":false
        },
        "ProductName":{
            "title":"Product Name",
            "maxLength":300,
            "type":"string",
            "description":"The name of the product.",
            "nullable":true,
            "x-hints":{
                "controlType":"input_text_lov",
                "enableInGenAI":"true"
            }
        },
        "BalanceManagementError":{
            "title":"Balance Management Error",
            "maxLength":2000,
            "type":"string",
            "description":"The balance management error.",
            "nullable":true
        },
        "QuoteLineId":{
            "title":"Quote Line ID",
            "type":"integer",
            "description":"The quote line ID associated with the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "BillToAccountDescription":{
            "type":"string",
            "description":"A brief description of the bill-to account.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "BillToAccountDescription1"
                ]
            }
        },
        "SuspendCreditMethod":{
            "title":"Suspend Credit Method",
            "maxLength":30,
            "type":"string",
            "description":"Indicates if the credit method has to be suspended.",
            "nullable":true,
            "x-queryable":false
        },
        "StartDate":{
            "title":"Product Start Date",
            "type":"string",
            "description":"The date when the subscriptions starts.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "enableInGenAI":"true"
            }
        },
        "BillToAddress":{
            "title":"Bill-to Address",
            "type":"string",
            "description":"The bill-to address.",
            "nullable":true,
            "x-queryable":false
        },
        "ExemptReason":{
            "title":"Exemption Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason for the tax exemption.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipToAccountDescription":{
            "type":"string",
            "description":"The ship-to account description of the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "ShipToAccountDescription1"
                ]
            }
        },
        "PricingTermsStartDate":{
            "title":"Starting On",
            "type":"string",
            "description":"The date when the pricing terms starts.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "PriceAdjustmentBasis":{
            "title":"Price Adjustment Basis",
            "maxLength":30,
            "type":"string",
            "description":"The basis on the which the price is adjusted.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RequestedRatePlanNumber":{
            "type":"string",
            "description":"The alternate unique identifier of the requested rate plan.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"input_text_lov",
                "sortable":false,
                "dependencies":[
                    "RequestedRatePlanNumber1"
                ]
            }
        },
        "MilestoneBasedChargeFlag":{
            "type":"boolean",
            "description":"Indicates whether the charge for the product is milestone based.",
            "nullable":true
        },
        "ItemUnitOfMeasureMeaning":{
            "title":"Pricing UOM",
            "type":"string",
            "description":"The display name of item unit of measure.",
            "nullable":true,
            "x-queryable":false
        },
        "CorpCurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "RetainSubsOnRenewFlag":{
            "title":"Don't Create New Renewal Subscription",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the renewal should happen in the source subscription.",
            "nullable":true
        },
        "ItemUnitOfMeasure":{
            "title":"Pricing UOM Code",
            "maxLength":15,
            "type":"string",
            "description":"The unit of measure used to measure the items.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BillToSiteName":{
            "title":"Bill-to Site",
            "maxLength":255,
            "type":"string",
            "description":"The bill-to site name of the subscription product.",
            "nullable":true
        },
        "EnableProrateByDay":{
            "title":"Prorate by day",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether proration by day is enabled or not.",
            "nullable":true,
            "x-queryable":false
        },
        "CoverageScheduleId":{
            "title":"Coverage Schedule ID",
            "type":"integer",
            "description":"Coverage Scheduled",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "UsageEventEstimateInvTemplate":{
            "title":"Estimate",
            "maxLength":200,
            "type":"string",
            "description":"The template to show the invoice data for estimate type of balance management.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "InvoiceBipReportCode"
                ]
            }
        },
        "BillToSiteUseId":{
            "title":"Site Use Id",
            "type":"integer",
            "description":"The unique identifier of the bill-to site use.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Period":{
            "title":"Period",
            "type":"string",
            "description":"The period for which the product has been subscribed.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RenewalPriceListName":{
            "title":"Renewal Price List",
            "maxLength":255,
            "type":"string",
            "description":"The name of the renewal price list.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "negotiatedEntitlementPlanDetails":{
            "title":"Subscription Entitlement Plan Details",
            "type":"array",
            "description":"The subscription entitlement plan details resource is used to view, create, update, and delete an entitlement plan detail.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-negotiatedEntitlementPlanDetails-item-patch-request"
            }
        },
        "DropAllowanceFlag":{
            "title":"No Allowance",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether allowances alone are dropped for a subscription product.",
            "nullable":true
        },
        "BillOnDay":{
            "title":"Bill on Day",
            "type":"number",
            "description":"The day on which the product should be billed.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "WireNumber":{
            "title":"Wire Number",
            "maxLength":30,
            "type":"string",
            "description":"The wire number.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PaymentMethod"
                ]
            }
        },
        "RatePlanId":{
            "title":"Rate Plan ID",
            "type":"integer",
            "description":"The unique identifier of the rate plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CancelReason":{
            "title":"Cancellation Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason why the product was canceled.",
            "nullable":true,
            "x-queryable":false
        },
        "creditCards":{
            "title":"Credit Cards",
            "type":"array",
            "description":"The credit cards resource is used to view, create, and update the credit cards associated with a subscription.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-creditCards-item-patch-request"
            }
        },
        "GenerateBillFullPeriodFlag":{
            "title":"Generate billing schedule for full period",
            "maxLength":1,
            "type":"boolean",
            "description":"Generate Bill Full Period Flag",
            "nullable":true,
            "x-queryable":false
        },
        "BillToContactNumber":{
            "title":"Bill-to Contact Number",
            "type":"string",
            "description":"The bill-to contact number of the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "BillToContactNumber1"
                ]
            }
        },
        "PaymentMethod":{
            "title":"Payment Method",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the payment method.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BalanceRegisterId":{
            "title":"Balance Register ID",
            "type":"integer",
            "description":"The ID of the balance register associated with the product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AmendCreditMethod":{
            "title":"Amendment Credit Method",
            "maxLength":30,
            "type":"string",
            "description":"The method used to amend the credit.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RenewalDurationPeriod":{
            "title":"Renewal Period",
            "maxLength":30,
            "type":"string",
            "description":"The code of the subscription product level renewal duration period override that will be used while renewing through automatic or manual renewal.",
            "nullable":true
        },
        "BalanceProfileName":{
            "title":"Profile Name",
            "type":"string",
            "description":"The name of the balance profile associated with the product.",
            "nullable":true,
            "x-hints":{
                "sortable":false
            }
        },
        "ShipToPartyName":{
            "title":"Ship-to Party",
            "type":"string",
            "description":"The name of the ship-to party.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "ShipToPartyName1"
                ]
            }
        },
        "RatePlanYn":{
            "type":"string",
            "description":"Indicates whether pricing for the subscription product is based on rate plan.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "InvoiceText":{
            "title":"Invoice Text",
            "maxLength":4000,
            "type":"string",
            "description":"The text in the billing invoice.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BillToSite":{
            "title":"Bill-to Site",
            "type":"string",
            "description":"Bill To Site",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "AmendCreditMethodName":{
            "type":"string",
            "description":"The name of the method used to amend the credit .",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "NextBillStartDate":{
            "title":"Next Bill Start Date",
            "type":"string",
            "description":"Next Bill Start Date",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "AmendEffectiveDate":{
            "title":"Amendment Effective Date",
            "type":"string",
            "description":"The date when the amended credit becomes effective.",
            "format":"date",
            "nullable":true
        },
        "OrderFulfillLineId":{
            "title":"Order Fulfillment Line ID",
            "type":"integer",
            "description":"The ID of the sales order fulfillment line associated with the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EntitlementType":{
            "title":"Entitlement Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the entitlement associated with the product.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PriceListName":{
            "title":"Price List Name",
            "maxLength":120,
            "type":"string",
            "description":"The name of the price list.",
            "nullable":true,
            "x-queryable":false
        },
        "UsageEventAllowanceInvTemplate":{
            "title":"Allowance",
            "maxLength":200,
            "type":"string",
            "description":"The template to show the invoice data for allowance type of balance management.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "InvoiceBipReportCode"
                ]
            }
        },
        "InvoicingRuleId":{
            "title":"Invoicing Rule Id",
            "type":"integer",
            "description":"The unique identifier of the invoicing rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RenewedDate":{
            "title":"Renewed On",
            "type":"string",
            "description":"The date when the product was renewed.",
            "format":"date",
            "nullable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity of the product.",
            "nullable":true,
            "x-queryable":false
        },
        "BillingFrequencyName":{
            "title":"Billing Frequency",
            "type":"string",
            "description":"The name of the billing frequency.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BillingFrequencyName1"
                ]
            }
        },
        "EntitlementPlanId":{
            "title":"Entitlement Plan ID",
            "type":"integer",
            "description":"The ID of the entitlement plan associated with the product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "salesCredits":{
            "title":"Sales Credits",
            "type":"array",
            "description":"The sales credits resource to view, create, update, and delete the sales credits defined for a subscription or a subscription product.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-salesCredits-item-patch-request"
            }
        },
        "BillToContactName":{
            "title":"Bill-to Contact",
            "type":"string",
            "description":"The bill-to contact name of the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "enableInGenAI":"true",
                "sortable":false,
                "dependencies":[
                    "BillToContactName1"
                ]
            }
        },
        "EnableAdvBipTemplateFlag":{
            "title":"Enable Advanced Configuration",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether advanced BIP configuration for usage invoice templates is enabled.",
            "nullable":true,
            "default":false
        },
        "RatePlanDocument":{
            "type":"string",
            "description":"The JSON representing the rate plan.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "PricingError":{
            "maxLength":2000,
            "type":"string",
            "description":"The pricing error associated with the product.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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

• Array of: object subscriptionProducts-associatedAsset-item-patch-request

{
    "title":"Associated Assets",
    "type":"array",
    "description":"The associated assets resource is used to view, create, update, and delete the assets linked to a subscription product of subscription type.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-associatedAsset-item-patch-request"
    }
}

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

• Array of: object subscriptionProducts-billLines-item-patch-request

{
    "title":"Bill Lines",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-billLines-item-patch-request"
    }
}

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

• Array of: object subscriptionProducts-charges-item-patch-request

{
    "title":"Charges",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-charges-item-patch-request"
    }
}

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

• Array of: object subscriptionProducts-coveredLevels-item-patch-request

{
    "title":"Covered Levels",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-item-patch-request"
    }
}

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

• Array of: object schema

{
    "title":"Credit Cards",
    "type":"array",
    "description":"The credit cards resource is used to view, create, and update the credit cards associated with a subscription.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-creditCards-item-patch-request"
    }
}

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

• Array of: object subscriptionProducts-flexFields-item-patch-request

{
    "title":"Descriptive Flexfields",
    "type":"array",
    "description":"The descriptive flexfields resource is used to view, create, update, and delete a descriptive flexfield.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-flexFields-item-patch-request"
    },
    "x-cardinality":"1"
}

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

• Array of: object subscriptionProducts-negotiatedEntitlementPlanCommitments-item-patch-request

{
    "title":"Subscription Entitlement Plan Commitments",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-negotiatedEntitlementPlanCommitments-item-patch-request"
    }
}

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

• Array of: object subscriptionProducts-negotiatedEntitlementPlanDetails-item-patch-request

{
    "title":"Subscription Entitlement Plan Details",
    "type":"array",
    "description":"The subscription entitlement plan details resource is used to view, create, update, and delete an entitlement plan detail.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-negotiatedEntitlementPlanDetails-item-patch-request"
    }
}

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

• Array of: object subscriptionProducts-negotiatedEntitlementPlanEstimates-item-patch-request

{
    "title":"Subscription Entitlement Plan Estimates",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-negotiatedEntitlementPlanEstimates-item-patch-request"
    }
}

Nested Schema : Subscription Entitlement Pricing Rules

Type: array

Title: Subscription Entitlement Pricing Rules

The subscription entitlement plan charge rules resource is used to view, create, update, and delete a negotiated entitlement plan charge rule which is used for the rating of a subscription product.

Show Source

• Array of: object subscriptionProducts-negotiatedVolumePricingRules-item-patch-request

{
    "title":"Subscription Entitlement Pricing Rules",
    "type":"array",
    "description":"The subscription entitlement plan charge rules resource is used to view, create, update, and delete a negotiated entitlement plan charge rule which is used for the rating of a subscription product.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-negotiatedVolumePricingRules-item-patch-request"
    }
}

Nested Schema : Product Relationships

Type: array

Title: Product Relationships

The product relationships resource is used to view the relationship between a source and a target product. These relationships include amendment, renewal, suspension relationships.

Show Source

• Array of: object subscriptionProducts-productRelationships-item-patch-request

{
    "title":"Product Relationships",
    "type":"array",
    "description":"The product relationships resource is used to view the relationship between a source and a target product. These relationships include amendment, renewal, suspension relationships.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-productRelationships-item-patch-request"
    }
}

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

• Array of: object subscriptionProducts-relationships-item-patch-request

{
    "title":"Relationships",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-relationships-item-patch-request"
    }
}

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

• Array of: object schema

{
    "title":"Sales Credits",
    "type":"array",
    "description":"The sales credits resource to view, create, update, and delete the sales credits defined for a subscription or a subscription product.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-salesCredits-item-patch-request"
    }
}

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

• Array of: object schema

{
    "title":"Service Resources",
    "type":"array",
    "description":"The service resources resouce is used to view, create, update, and delete the service identifier for a subscription product.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-serviceResources-item-patch-request"
    }
}

Nested Schema : Subscription Product User Actions

Type: array

Title: Subscription Product User Actions

The smart actions resource stores the endpoint and security details for every user action.

Show Source

• Array of: object subscriptionProducts-smartActions-item-patch-request

{
    "title":"Subscription Product User Actions",
    "type":"array",
    "description":"The smart actions resource stores the endpoint and security details for every user action.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-smartActions-item-patch-request"
    }
}

Nested Schema : subscriptionProducts-associatedAsset-item-patch-request

Type: object

Show Source

• AssetName: string
  Title: Asset Name

  The name of the asset.
• AssetSerialNumber: string
  Title: Asset Serial Number

  The serial number of the asset.
• CorpCurrencyCode: string
  Maximum Length: 15

  The corporate currency code.
• 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.
• 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.
• 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.

{
    "type":"object",
    "properties":{
        "UnitOfMeasureCode":{
            "title":"UOM",
            "type":"string",
            "description":"The unit of measure code of the associated asset.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "sortable":false,
                "dependencies":[
                    "AssetId"
                ]
            }
        },
        "ProductName":{
            "title":"Product Name",
            "type":"string",
            "description":"The name of the product.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AssetId"
                ]
            }
        },
        "UnitOfMeasure":{
            "title":"UOM",
            "type":"string",
            "description":"The unit of measure of the associated asset.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "UnitOfMeasureCode"
                ]
            }
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"The unique identifier of the inventory item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity of the associated asset.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "AssetId"
                ]
            }
        },
        "CurcyConvRateType":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "AssetName":{
            "title":"Asset Name",
            "type":"string",
            "description":"The name of the asset.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "sortable":false,
                "dependencies":[
                    "AssetId"
                ]
            }
        },
        "AssetSerialNumber":{
            "title":"Asset Serial Number",
            "type":"string",
            "description":"The serial number of the asset.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AssetId"
                ]
            }
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The currency code such as USD or INR.",
            "nullable":true
        },
        "SourceKey":{
            "maxLength":120,
            "type":"string",
            "description":"The source key of the associated asset.",
            "nullable":true
        },
        "SourceNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The source number of the associated asset.",
            "nullable":true
        },
        "SourceLineKey":{
            "maxLength":120,
            "type":"string",
            "description":"The source line key of the associated asset.",
            "nullable":true
        },
        "SourceLineNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The source line number of the associated asset.",
            "nullable":true
        },
        "SourceSystem":{
            "maxLength":30,
            "type":"string",
            "description":"The source system of the associated asset.",
            "nullable":true
        },
        "CorpCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code.",
            "nullable":true
        }
    }
}

Nested Schema : subscriptionProducts-billLines-item-patch-request

Type: object

Show Source

• AdhocBillLineFlag: boolean
  Default Value: false

  Adhoc BillLine Flag
• Amount: number
  Title: Amount

  The amount for which the bill is generated.
• BatchTag: string
  Title: Batch Tag

  Maximum Length: 30

  Batch Tag
• 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.
• 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.
• CoveredLevelId: integer (int64)
  The unique identifier of the covered level.
• 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
  Title: Credit Memo Reason Code

  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.
• 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
  Title: Milestone Name

  The name of the milestone event associated with the bill line.
• NewCreditMemoPUID: string
  The unique public identifier of the new credit memo.
• PricedQuantity: number
  Title: Priced Quantity

  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
• 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)
  Title: Usage Capture Date

  The date when the usage was captured.
• UsageChargeType: string
  Title: Usage Charge Type

  Maximum Length: 30

  The type of usage charge.
• UsageChargeTypeName: string
  Title: Usage Charge Type

  The name of the usage charge type.
• UsageFlag: boolean
  Maximum Length: 1

  Indicates whether the line is a usage line or not.
• UsageInvoiceAttachmentYn: string
  Maximum Length: 1

  Indicates whether usage events invoice attachment is associated with the bill line.
• 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.
• UsageRatingProcess: string
  Title: Usage Rating Process

  Maximum Length: 30

  Usage Rating Process

{
    "type":"object",
    "properties":{
        "TrxId":{
            "type":"integer",
            "description":"The AR transaction ID.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TransactionTypeName":{
            "type":"string",
            "description":"The transaction type name of the subscription bill line.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargeDefinition":{
            "maxLength":30,
            "type":"string",
            "description":"The definition that indicates the purpose of the charge.",
            "nullable":true
        },
        "UsagePricedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the usage line has been priced or not.",
            "nullable":true
        },
        "UsageRatingProcess":{
            "title":"Usage Rating Process",
            "maxLength":30,
            "type":"string",
            "description":"Usage Rating Process",
            "nullable":true
        },
        "ListPrice":{
            "type":"number",
            "description":"The list price of the product associated with the bill line.",
            "nullable":true
        },
        "TransactionTax":{
            "title":"Tax",
            "type":"number",
            "description":"The tax levied on the transaction.",
            "nullable":true
        },
        "RevenueLineId":{
            "type":"integer",
            "description":"The unique identifier of the revenue line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CreditMemoReason":{
            "type":"string",
            "description":"The reason to raise the credit memo.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "BillLinePuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the bill line.",
            "nullable":false
        },
        "UsageFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the line is a usage line or not.",
            "nullable":true
        },
        "UsageChargeTypeName":{
            "title":"Usage Charge Type",
            "type":"string",
            "description":"The name of the usage charge type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "billAdjustments":{
            "title":"Bill Adjustments",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-billLines-billAdjustments-item-patch-request"
            }
        },
        "BillingPeriod":{
            "title":"Sequence",
            "type":"number",
            "description":"The period for which the bill is generated.",
            "nullable":false
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"The ID of the business unit associated with the bill line.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargeName":{
            "title":"Charge Name",
            "maxLength":120,
            "type":"string",
            "description":"The name of the charge associated with the bill line.",
            "nullable":true
        },
        "RetrieveInvoiceFlag":{
            "title":"Retrieve Invoice from Receivables",
            "maxLength":1,
            "type":"boolean",
            "description":"Retrieve Invoice Flag",
            "nullable":true
        },
        "MilestoneEventId":{
            "type":"integer",
            "description":"The ID of the milestone event associated with the bill line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TrxLineId":{
            "type":"integer",
            "description":"The AR transaction line ID.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SummarizedBillLineId":{
            "title":"Summarized Bill Line ID",
            "type":"integer",
            "description":"Summarized Bill Line ID",
            "nullable":true
        },
        "UsageCaptureDate":{
            "title":"Usage Capture Date",
            "type":"string",
            "description":"The date when the usage was captured.",
            "format":"date",
            "nullable":true
        },
        "RevenuePeriod":{
            "title":"Revenue Effectivity Periods",
            "maxLength":30,
            "type":"string",
            "description":"Revenue Period",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CreditMemoFlag":{
            "type":"string",
            "description":"Indicates if there is a credit memo associated with the bill line.",
            "nullable":true,
            "x-queryable":false
        },
        "DateToInterface":{
            "title":"Interface Date",
            "type":"string",
            "description":"The date to interface for the bill line.",
            "format":"date",
            "nullable":true
        },
        "UsageChargeType":{
            "title":"Usage Charge Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of usage charge.",
            "nullable":true
        },
        "TransactionNumber":{
            "title":"Invoice Number",
            "maxLength":30,
            "type":"string",
            "description":"The number of the transaction.",
            "nullable":true
        },
        "NewCreditMemoPUID":{
            "type":"string",
            "description":"The unique public identifier of the new credit memo.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargePeriodFactor":{
            "type":"number",
            "description":"The change period factor associated with the bill line.",
            "nullable":true
        },
        "CustomerTrxTypeSequenceId":{
            "type":"integer",
            "description":"Customer Transaction Type Sequence Id",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TruedUpYn":{
            "maxLength":3,
            "type":"string",
            "description":"Indicates if the bill line has a trueup period.",
            "nullable":true
        },
        "CreditMemoReasonCode":{
            "title":"Credit Memo Reason Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the credit memo reason code.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "InvoiceText":{
            "title":"Invoice Text",
            "maxLength":240,
            "type":"string",
            "description":"The text in the bill line invoice.",
            "nullable":true
        },
        "CreditMemoAmount":{
            "type":"number",
            "description":"The amount for the credit memo.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TransactionClass":{
            "title":"Transaction Class",
            "maxLength":30,
            "type":"string",
            "description":"The class of the transaction.",
            "nullable":true
        },
        "UsageInvoiceAttachmentYn":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether usage events invoice attachment is associated with the bill line.",
            "nullable":true
        },
        "AdhocBillLineFlag":{
            "type":"boolean",
            "description":"Adhoc BillLine Flag",
            "nullable":true,
            "default":false
        },
        "RevenueOption":{
            "title":"Revenue Accounting Option",
            "maxLength":30,
            "type":"string",
            "description":"Revenue Option",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "InvoiceDate":{
            "type":"string",
            "description":"The date when the invoice was raised.",
            "format":"date",
            "nullable":true
        },
        "ChargePeriod":{
            "title":"Period",
            "type":"number",
            "description":"The usage period that was charged.",
            "nullable":true
        },
        "TransactionDate":{
            "title":"Invoice Date",
            "type":"string",
            "description":"The date when the transaction occurred.",
            "format":"date",
            "nullable":true
        },
        "InvoiceBillLineId":{
            "type":"integer",
            "description":"The unique identifier of the invoice bill line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "UsageAcquiredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the usage has been acquired or not.",
            "nullable":true
        },
        "InterfacedFlag":{
            "title":"Interfaced",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the bill line is interfaced or not.",
            "nullable":false,
            "default":false
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount for which the bill is generated.",
            "nullable":true
        },
        "DateBilledTo":{
            "title":"Bill-to Date",
            "type":"string",
            "description":"The date up to which the bill is generated.",
            "format":"date",
            "nullable":false
        },
        "UsageQuantity":{
            "title":"Usage Quantity",
            "type":"number",
            "description":"The quantity of the usage.",
            "nullable":true
        },
        "CoveredLevelId":{
            "type":"integer",
            "description":"The unique identifier of the covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PricedQuantity":{
            "title":"Priced Quantity",
            "type":"number",
            "description":"The quantity for which the bill line was charged.",
            "nullable":true
        },
        "MilestoneEventName":{
            "title":"Milestone Name",
            "type":"string",
            "description":"The name of the milestone event associated with the bill line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TransactionAmount":{
            "title":"Invoice Amount",
            "type":"number",
            "description":"The amount for which the transaction occurred.",
            "nullable":true
        },
        "RecurringFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the line is recurring or not.",
            "nullable":false
        },
        "DateBilledFrom":{
            "title":"Bill-from Date",
            "type":"string",
            "description":"The date from which the bill was generated.",
            "format":"date",
            "nullable":false
        },
        "TransactionClassMeaning":{
            "title":"Class",
            "type":"string",
            "description":"The meaning of transaction class lookup.",
            "nullable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The unique identifier of the charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PricingError":{
            "maxLength":1000,
            "type":"string",
            "description":"The error in pricing, if any.",
            "nullable":true
        },
        "BatchTag":{
            "title":"Batch Tag",
            "maxLength":30,
            "type":"string",
            "description":"Batch Tag",
            "nullable":true
        }
    }
}

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

• Array of: object schema

{
    "title":"Bill Adjustments",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-billLines-billAdjustments-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• 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.
• CurrencyCode: string
  The current code used for the bill adjustment.
• Effectivity: string
  Maximum Length: 30

  The effectivity of the bill adjustment.
• 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.

{
    "type":"object",
    "properties":{
        "AutoAdjustmentFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Indicates whether the adjustment is automatic or not.",
            "nullable":false
        },
        "AdjustmentBasis":{
            "title":"Basis",
            "maxLength":30,
            "type":"string",
            "description":"The basis on which the bill is adjusted.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RevenueAdjustmentToDate":{
            "title":"Revenue Effective End Date",
            "type":"string",
            "description":"Revenue Adjustment To Date",
            "format":"date",
            "nullable":true
        },
        "Reason":{
            "title":"Reason Details",
            "maxLength":120,
            "type":"string",
            "description":"The reason why the bill is adjusted.",
            "nullable":true
        },
        "CurrencyCode":{
            "type":"string",
            "description":"The current code used for the bill adjustment.",
            "nullable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"number",
            "description":"The sequence number of the bill adjustment.",
            "nullable":false
        },
        "NumberOfPeriods":{
            "type":"number",
            "description":"The number of periods",
            "nullable":true
        },
        "RevenueOption":{
            "title":"Revenue Accounting Option",
            "maxLength":30,
            "type":"string",
            "description":"Revenue Option",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "BillAdjustmentPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the bill adjustment.",
            "nullable":false
        },
        "PeriodUntil":{
            "type":"number",
            "description":"The period until which the bill is adjusted.",
            "nullable":true
        },
        "PeriodFrom":{
            "type":"number",
            "description":"The period from which the bill was adjusted.",
            "nullable":true
        },
        "BillAdjustmentId":{
            "type":"integer",
            "description":"The unique identifier of the bill adjustment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RevenueAdjustmentFromDate":{
            "title":"Revenue Effective Start Date",
            "type":"string",
            "description":"Revenue Adjustment From Date",
            "format":"date",
            "nullable":true
        },
        "ChargeAdjustmentId":{
            "type":"integer",
            "description":"The unique identifier of the charge adjustment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AdjustmentReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code of the adjustment reason.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Effectivity":{
            "maxLength":30,
            "type":"string",
            "description":"The effectivity of the bill adjustment.",
            "nullable":true
        },
        "AdjustmentType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the bill adjustment.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AdjustmentValue":{
            "title":"Value",
            "type":"number",
            "description":"The value by which the bill is adjusted.",
            "nullable":false
        },
        "BillLineId":{
            "type":"integer",
            "description":"The unique identifier of the bill line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RevenuePeriod":{
            "title":"Revenue Effectivity Periods",
            "maxLength":30,
            "type":"string",
            "description":"Revenue Period",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AdjustmentName":{
            "title":"Adjustment",
            "maxLength":120,
            "type":"string",
            "description":"The name of the bill adjustment.",
            "nullable":true
        },
        "BasisEnableFlag":{
            "type":"boolean",
            "description":"Indicates if the base has been enabled for the bill adjustment.",
            "nullable":true
        }
    }
}

Nested Schema : subscriptionProducts-charges-item-patch-request

Type: object

Show Source

• 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
  Title: Aggregation Method

  Maximum Length: 30

  The aggregation method used for the charges.
• Allowance: number
  Title: Allowance

  The allowance part of the charge.
• AssetMeterYn: boolean
  Title: Asset Meter Flag

  Maximum Length: 1

  The flag whether it is an asset meter or not.
• BatchTag: string
  Title: Batch Tag

  Maximum Length: 30

  Batch Tag
• BillingFreq: string
  Title: Billing Frequency

  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.
• chargeComponents: array Subcription Product Charge Components Records
  Title: Subcription Product Charge Components Records

  The subscription product charge components records resoure is used to view the price details of the individual charge components of subscription products.
• ChargeDefinition: string
  Title: Charge Name

  Maximum Length: 30

  The definition that indicates the purpose of the charge.
• ChargeDefinitionName: string
  Title: Charge Definition

  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
  Title: Charge Period Code

  Maximum Length: 30

  The code of the charge period associated with the charge.
• ChargePuid: string
  Title: Charge PUID

  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)
  Title: Covered Level ID

  The unique identifier of the covered level.
• EnableProration: string
  Title: Enable Proration

  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
  Title: External Key

  Maximum Length: 120

  The external key used to measure the charge.
• ExternalParentKey: string
  Title: External Parent Key

  Maximum Length: 120

  The external parent key.
• InitialMeterReadingId: integer (int64)
  Title: Initial Meter Reading ID

  The initial meter reading identifier value.
• InvoicingRuleId: integer (int64)
  Title: Invoicing Rule Id

  The ID of the invoice rule.
• InvoicingRuleName: string
  Title: Invoicing Rule

  The name of the invoice rule.
• MeterDefinitionId: integer (int64)
  Title: Meter Definition ID

  The unique identifier of the meter definition associated with the charges.
• MeterId: integer (int64)
  Title: Meter ID

  The unique identifier of the meter associated with the charges.
• MilestoneBillingFlag: boolean
  Title: Enable Milestone Based Billing

  Indicates whether the billing is impacted by milestone events or not.
• MilestoneRevenueFlag: boolean
  Title: Enable Milestone Based Revenue Recognition

  Indicates whether the revenue is impacted by milestone events or not.
• MilestoneTemplateId: integer (int64)
  Title: Template

  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
  Title: Enable Periodic Billing

  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
  Title: Periodicity

  The name of the price periodicity.
• PriceType(required): string
  Title: Price Type

  Maximum Length: 30

  The price type associated with the charge.
• QuotedTcv: number
  Title: Total Charge Amount

  The quoted TCV of the charge.
• RecurringPricePeriodicityCode: string
  Title: Recurring Price Periodicity Code

  Maximum Length: 30

  The recurring price periodicity code of the charge.
• RollupFlag: boolean
  Title: Rollup Flag

  Maximum Length: 1

  Indicates if the charge needs to be rolled up.
• SequenceNumber: integer (int32)
  Title: Sequence Number

  The sequence number for the charge.
• SubscriptionId: integer (int64)
  Title: Subscription ID

  The unique identifier of the subscription.
• SubscriptionProductId: integer (int64)
  Title: Subscription Product ID

  The unique identifier of the subscription product.
• TieredFlag: boolean
  Title: Tiered

  Maximum Length: 3

  Indicates whether the charge has tiers.
• TieredPricingHeaderId: integer
  Title: Tiered Pricing Header ID

  Tiered Pricing Header Id
• 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
  Title: Usage Price Lock

  Maximum Length: 3

  Indicates whether the usage price is locked or not.
• UsageUnitOfMeasure: string
  Title: Usage UOM

  Maximum Length: 3

  The usage unit of measure of the charge.

{
    "required":[
        "PriceType"
    ],
    "type":"object",
    "properties":{
        "AggregationMethod":{
            "title":"Aggregation Method",
            "maxLength":30,
            "type":"string",
            "description":"The aggregation method used for the charges.",
            "nullable":true
        },
        "ChargePuid":{
            "title":"Charge PUID",
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the charge.",
            "nullable":true
        },
        "chargeMilestoneEvents":{
            "title":"Charge Milestone Events",
            "type":"array",
            "description":"The charge milestone events resource is used to view, create, update, and delete the milestone events associated with a charge of a subscription.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-charges-chargeMilestoneEvents-item-patch-request"
            }
        },
        "adjustments":{
            "title":"Adjustments",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-charges-adjustments-item-patch-request"
            }
        },
        "ChargeDefinition":{
            "title":"Charge Name",
            "maxLength":30,
            "type":"string",
            "description":"The definition that indicates the purpose of the charge.",
            "nullable":true
        },
        "AssetMeterYn":{
            "title":"Asset Meter Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"The flag whether it is an asset meter or not.",
            "nullable":true
        },
        "EstimatedAmount":{
            "title":"Estimated Amount",
            "type":"number",
            "description":"The estimated amount of the charges.",
            "nullable":true
        },
        "PricePeriodicityName":{
            "title":"Periodicity",
            "type":"string",
            "description":"The name of the price periodicity.",
            "nullable":true
        },
        "PrePaymentNumber":{
            "title":"Prepayment Number",
            "type":"integer",
            "description":"The prepayment number for the charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "BillingFreq":{
            "title":"Billing Frequency",
            "maxLength":30,
            "type":"string",
            "description":"Billing Frequency",
            "nullable":true
        },
        "MeterDefinitionId":{
            "title":"Meter Definition ID",
            "type":"integer",
            "description":"The unique identifier of the meter definition associated with the charges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EstimationMethod":{
            "title":"Estimation Method",
            "maxLength":30,
            "type":"string",
            "description":"The method used to estimate the amount.",
            "nullable":true
        },
        "PeriodicBillingFlag":{
            "title":"Enable Periodic Billing",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether periodic billing is allowed or not.",
            "nullable":true
        },
        "MilestoneBillingFlag":{
            "title":"Enable Milestone Based Billing",
            "type":"boolean",
            "description":"Indicates whether the billing is impacted by milestone events or not.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "ExternalParentKey":{
            "title":"External Parent Key",
            "maxLength":120,
            "type":"string",
            "description":"The external parent key.",
            "nullable":true
        },
        "UnitListPrice":{
            "title":"List Price",
            "type":"number",
            "description":"The price of the unit list.",
            "nullable":true
        },
        "SequenceNumber":{
            "title":"Sequence Number",
            "type":"integer",
            "description":"The sequence number for the charge.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "InitialMeterReadingId":{
            "title":"Initial Meter Reading ID",
            "type":"integer",
            "description":"The initial meter reading identifier value.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SubscriptionProductId":{
            "title":"Subscription Product ID",
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EstimatedQuantity":{
            "title":"Estimated Quantity",
            "type":"number",
            "description":"The estimated quantity for the charge.",
            "nullable":true
        },
        "chargeComponents":{
            "title":"Subcription Product Charge Components Records",
            "type":"array",
            "description":"The subscription product charge components records resoure is used to view the price details of the individual charge components of subscription products.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-charges-chargeComponents-item-patch-request"
            }
        },
        "ChargeName":{
            "title":"Charge Name",
            "maxLength":120,
            "type":"string",
            "description":"The name of the charge.",
            "nullable":true
        },
        "RecurringPricePeriodicityCode":{
            "title":"Recurring Price Periodicity Code",
            "maxLength":30,
            "type":"string",
            "description":"The recurring price periodicity code of the charge.",
            "nullable":true
        },
        "QuotedTcv":{
            "title":"Total Charge Amount",
            "type":"number",
            "description":"The quoted TCV of the charge.",
            "nullable":true
        },
        "TieredFlag":{
            "title":"Tiered",
            "maxLength":3,
            "type":"boolean",
            "description":"Indicates whether the charge has tiers.",
            "nullable":true
        },
        "UsagePriceLockFlag":{
            "title":"Usage Price Lock",
            "maxLength":3,
            "type":"boolean",
            "description":"Indicates whether the usage price is locked or not.",
            "nullable":true
        },
        "PeriodicRevenueFlag":{
            "title":"Enable Periodic Revenue Recognition",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the periodic revenue recognition of one-time charges.",
            "nullable":true
        },
        "MilestoneRevenueFlag":{
            "title":"Enable Milestone Based Revenue Recognition",
            "type":"boolean",
            "description":"Indicates whether the revenue is impacted by milestone events or not.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "chargeTiers":{
            "title":"Charge Tiers",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-charges-chargeTiers-item-patch-request"
            }
        },
        "MinimumAmount":{
            "title":"Minimum Amount",
            "type":"number",
            "description":"The minimum amount to be charged.",
            "nullable":true
        },
        "PriceType":{
            "title":"Price Type",
            "maxLength":30,
            "type":"string",
            "description":"The price type associated with the charge.",
            "nullable":false
        },
        "RollupFlag":{
            "title":"Rollup Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the charge needs to be rolled up.",
            "nullable":true
        },
        "TierType":{
            "title":"Tier Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the charge tier.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TieredPricingHeaderId":{
            "title":"Tiered Pricing Header ID",
            "type":"integer",
            "description":"Tiered Pricing Header Id",
            "nullable":true,
            "x-queryable":false
        },
        "InvoicingRuleName":{
            "title":"Invoicing Rule",
            "type":"string",
            "description":"The name of the invoice rule.",
            "nullable":true,
            "x-queryable":false
        },
        "MeterId":{
            "title":"Meter ID",
            "type":"integer",
            "description":"The unique identifier of the meter associated with the charges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeDefinitionName":{
            "title":"Charge Definition",
            "type":"string",
            "description":"The name of the charge definition.",
            "nullable":true
        },
        "UsageUnitOfMeasure":{
            "title":"Usage UOM",
            "maxLength":3,
            "type":"string",
            "description":"The usage unit of measure of the charge.",
            "nullable":true
        },
        "SubscriptionId":{
            "title":"Subscription ID",
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EnableProration":{
            "title":"Enable Proration",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether proration is enabled or not.",
            "nullable":true
        },
        "TrueUpPeriodName":{
            "title":"True Up Period",
            "type":"string",
            "description":"The name of the trueup period.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ExternalKey":{
            "title":"External Key",
            "maxLength":120,
            "type":"string",
            "description":"The external key used to measure the charge.",
            "nullable":true
        },
        "ChargePeriodCode":{
            "title":"Charge Period Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the charge period associated with the charge.",
            "nullable":true
        },
        "Allowance":{
            "title":"Allowance",
            "type":"number",
            "description":"The allowance part of the charge.",
            "nullable":true
        },
        "InvoicingRuleId":{
            "title":"Invoicing Rule Id",
            "type":"integer",
            "description":"The ID of the invoice rule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "MilestoneTemplateName":{
            "maxLength":120,
            "type":"string",
            "description":"The name of the milestone template associated with a charge.",
            "nullable":true,
            "x-queryable":false
        },
        "MilestoneTemplateId":{
            "title":"Template",
            "type":"integer",
            "description":"The ID of the milestone event associated with a charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "CoveredLevelId":{
            "title":"Covered Level ID",
            "type":"integer",
            "description":"The unique identifier of the covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "BillingFreqName":{
            "title":"Billing Frequency",
            "maxLength":255,
            "type":"string",
            "description":"Billing Frequency Name",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "MinimumQuantity":{
            "title":"Minimum Quantity",
            "type":"number",
            "description":"The minimum quantity that is allowed.",
            "nullable":true
        },
        "EstimatedMethodName":{
            "title":"Estimation Method",
            "type":"string",
            "description":"The method used to estimate the amount.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PricePeriodicity":{
            "title":"Periodicity",
            "maxLength":30,
            "type":"string",
            "description":"The price periodicity for the charge. Indicates the frequency when the charge has to be applied.",
            "nullable":true
        },
        "TrueUpPeriod":{
            "title":"True Up Period",
            "maxLength":30,
            "type":"string",
            "description":"The identifier of the trueup period.",
            "nullable":true,
            "default":"ORA_OSS_USAGE_BILLING_PERIOD"
        },
        "BillLineId":{
            "type":"integer",
            "description":"The unique identifier of the bill line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeId":{
            "type":"integer",
            "description":"The unique identifier of the charge.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BlockSize":{
            "title":"Block Size",
            "type":"number",
            "description":"The block size of the charge.",
            "nullable":true
        },
        "BatchTag":{
            "title":"Batch Tag",
            "maxLength":30,
            "type":"string",
            "description":"Batch Tag",
            "nullable":true
        }
    }
}

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

• Array of: object schema

{
    "title":"Adjustments",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-charges-adjustments-item-patch-request"
    }
}

Nested Schema : Subcription Product Charge Components Records

Type: array

Title: Subcription Product Charge Components Records

The subscription product charge components records resoure is used to view the price details of the individual charge components of subscription products.

Show Source

• Array of: object subscriptionProducts-charges-chargeComponents-item-patch-request

{
    "title":"Subcription Product Charge Components Records",
    "type":"array",
    "description":"The subscription product charge components records resoure is used to view the price details of the individual charge components of subscription products.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-charges-chargeComponents-item-patch-request"
    }
}

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

• Array of: object subscriptionProducts-charges-chargeMilestoneEvents-item-patch-request

{
    "title":"Charge Milestone Events",
    "type":"array",
    "description":"The charge milestone events resource is used to view, create, update, and delete the milestone events associated with a charge of a subscription.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-charges-chargeMilestoneEvents-item-patch-request"
    }
}

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

• Array of: object subscriptionProducts-charges-chargeTiers-item-patch-request

{
    "title":"Charge Tiers",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-charges-chargeTiers-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• 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.
• Effectivity: string
  Title: Effectivity

  Maximum Length: 30

  The adjustment effectivity
• 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.

{
    "type":"object",
    "properties":{
        "AutoAdjustmentFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Indicates whether the adjustment is automatic or not.",
            "nullable":true
        },
        "ChargeAdjustmentPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the charge adjustment.",
            "nullable":true
        },
        "AdjustmentBasis":{
            "title":"Basis",
            "maxLength":30,
            "type":"string",
            "description":"The basis of the adjustment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChargeAdjustmentId":{
            "type":"integer",
            "description":"The unique identifier of the charge adjustment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AdjustmentReasonCode":{
            "title":"Reason",
            "maxLength":30,
            "type":"string",
            "description":"The code of the adjustment reason.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Effectivity":{
            "title":"Effectivity",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment effectivity",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Reason":{
            "title":"Reason Description",
            "maxLength":120,
            "type":"string",
            "description":"The reason for the adjustment.",
            "nullable":true
        },
        "AdjustmentType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the adjustment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AdjustmentValue":{
            "title":"Value",
            "type":"number",
            "description":"The value of the adjustment.",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"integer",
            "description":"The sequence number of the adjustment.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "NumberOfPeriods":{
            "type":"number",
            "description":"The number of periods",
            "nullable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The unique identifier of the charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PeriodUntil":{
            "type":"number",
            "description":"The period until which the adjustment is initiated.",
            "nullable":true
        },
        "AdjustmentReasonMeaning":{
            "title":"Reason",
            "type":"string",
            "description":"The translated adjustment reason.",
            "nullable":true,
            "x-queryable":false
        },
        "AdjustmentName":{
            "title":"Adjustment",
            "maxLength":120,
            "type":"string",
            "description":"The name of the adjustment.",
            "nullable":true
        },
        "PeriodFrom":{
            "type":"number",
            "description":"The period from which the adjustment was initiated.",
            "nullable":true
        }
    }
}

Nested Schema : subscriptionProducts-charges-chargeComponents-item-patch-request

Type: object

Show Source

• ChargeComponentId: integer (int64)
  The identifier of the charge component.
• ChargeComponentPuid: string
  Maximum Length: 120

  The PUID of the charge component.
• ChargeCurrency: string
  Title: Currency

  Maximum Length: 15

  The charge currency of the charge component.
• ChargeCurrencyExtAmount: number
  Title: Extended Amount

  The extended amount of the charge component in charge currency.
• ChargeCurrencyUnitPrice: number
  Title: Currency Unit Price

  The unit price of the charge component in charge currency.
• ChargeId: integer (int64)
  Title: Charge ID

  The identifier of the charge.
• CoverageExtendedAmount: number
  Title: Coverage Extended Amount

  The extended coverage amount of the charge component.
• Explanation: string
  Title: Explanation

  Maximum Length: 1000

  The explanation for the charge component.
• ExplanationMessageName: string
  Title: Explanation Message

  Maximum Length: 30

  The explanation message name of the charge component.
• ObjectVersionNumber: integer (int32)
  The object version number of the charge component.
• Price: number
  Title: Amount

  The price of the charge component.
• PriceElement: string
  Title: Price Element

  Maximum Length: 30

  The price element of the charge component.
• PriceElementUsage: string
  Title: Price Element Usage

  Maximum Length: 30

  The price element usage of the charge component.
• PriceforQuantity: number
  Title: Price

  The price for quantity of the charge component.
• PricingSourceId: integer (int64)
  The identifier of the pricing source of the charge component.
• PricingSourceType: string
  Title: Pricing Source Type

  Maximum Length: 30

  The type of pricing source of the charge component.
• RollupFlag: boolean
  Title: Rollup Flag

  Maximum Length: 1

  The indicator of whether charge component should be rolled up or not.
• SequenceNumber: integer (int32)
  Title: Sequence Number

  The sequence number of the charge component.
• SubscriptionCurrency: string
  Title: Subscription Currency

  Maximum Length: 15

  The subscription currency of the charge component.
• SubscriptionId: integer (int64)
  Title: Subscription ID

  The identifier of the subscription.
• TaxIncludedFlag: boolean
  Title: Tax Included Flag

  Maximum Length: 1

  The indicator of whether tax is included for the charge component or not.
• UnitPrice: number
  Title: Unit Price

  The unit price of the charge component.

{
    "type":"object",
    "properties":{
        "ChargeComponentPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The PUID of the charge component.",
            "nullable":true
        },
        "RollupFlag":{
            "title":"Rollup Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"The indicator of whether charge component should be rolled up or not.",
            "nullable":true
        },
        "ExplanationMessageName":{
            "title":"Explanation Message",
            "maxLength":30,
            "type":"string",
            "description":"The explanation message name of the charge component.",
            "nullable":true
        },
        "ChargeCurrency":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The charge currency of the charge component.",
            "nullable":true
        },
        "Explanation":{
            "title":"Explanation",
            "maxLength":1000,
            "type":"string",
            "description":"The explanation for the charge component.",
            "nullable":true
        },
        "PricingSourceId":{
            "type":"integer",
            "description":"The identifier of the pricing source of the charge component.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TaxIncludedFlag":{
            "title":"Tax Included Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"The indicator of whether tax is included for the charge component or not.",
            "nullable":true
        },
        "CoverageExtendedAmount":{
            "title":"Coverage Extended Amount",
            "type":"number",
            "description":"The extended coverage amount of the charge component.",
            "nullable":true
        },
        "PricingSourceType":{
            "title":"Pricing Source Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of pricing source of the charge component.",
            "nullable":true
        },
        "ChargeCurrencyUnitPrice":{
            "title":"Currency Unit Price",
            "type":"number",
            "description":"The unit price of the charge component in charge currency.",
            "nullable":true
        },
        "UnitPrice":{
            "title":"Unit Price",
            "type":"number",
            "description":"The unit price of the charge component.",
            "nullable":true
        },
        "SubscriptionId":{
            "title":"Subscription ID",
            "type":"integer",
            "description":"The identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeComponentId":{
            "type":"integer",
            "description":"The identifier of the charge component.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the charge component.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "Price":{
            "title":"Amount",
            "type":"number",
            "description":"The price of the charge component.",
            "nullable":true
        },
        "PriceElement":{
            "title":"Price Element",
            "maxLength":30,
            "type":"string",
            "description":"The price element of the charge component.",
            "nullable":true
        },
        "SubscriptionCurrency":{
            "title":"Subscription Currency",
            "maxLength":15,
            "type":"string",
            "description":"The subscription currency of the charge component.",
            "nullable":true
        },
        "SequenceNumber":{
            "title":"Sequence Number",
            "type":"integer",
            "description":"The sequence number of the charge component.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "ChargeCurrencyExtAmount":{
            "title":"Extended Amount",
            "type":"number",
            "description":"The extended amount of the charge component in charge currency.",
            "nullable":true
        },
        "ChargeId":{
            "title":"Charge ID",
            "type":"integer",
            "description":"The identifier of the charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PriceforQuantity":{
            "title":"Price",
            "type":"number",
            "description":"The price for quantity of the charge component.",
            "nullable":true
        },
        "PriceElementUsage":{
            "title":"Price Element Usage",
            "maxLength":30,
            "type":"string",
            "description":"The price element usage of the charge component.",
            "nullable":true
        }
    }
}

Nested Schema : subscriptionProducts-charges-chargeMilestoneEvents-item-patch-request

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "BillingOffset":{
            "type":"number",
            "description":"The billing offset associated with a milestone event.",
            "nullable":true
        },
        "ChargePuid":{
            "maxLength":120,
            "type":"string",
            "description":"The PUID of the charge to which the milestone event is associated.",
            "nullable":true,
            "default":"Charges.ChargePuid",
            "x-queryable":false
        },
        "ExpectedCompletionDate":{
            "type":"string",
            "description":"The expected completion date of a milestone event.",
            "format":"date",
            "nullable":true
        },
        "EventType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of the milestone event.",
            "nullable":false
        },
        "Percentage":{
            "type":"number",
            "description":"The percentage associated with a milestone event.",
            "nullable":false,
            "x-hints":{
                "precision":5,
                "scale":2
            }
        },
        "MilestoneName":{
            "maxLength":30,
            "type":"string",
            "description":"The name of the milestone event.",
            "nullable":false
        },
        "MilestoneComment":{
            "maxLength":300,
            "type":"string",
            "description":"The milestone event comment.",
            "nullable":true
        },
        "MilestonePuid":{
            "maxLength":120,
            "type":"string",
            "description":"The milestone event PUID.",
            "nullable":true
        },
        "EventSource":{
            "maxLength":30,
            "type":"string",
            "description":"The source of the milestone event.",
            "nullable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the milestone event.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "EventSourceReference":{
            "maxLength":120,
            "type":"string",
            "description":"The source reference of the milestone event.",
            "nullable":true
        },
        "BillLineId":{
            "type":"integer",
            "description":"The bill line ID associated with the milestone event.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeId":{
            "type":"integer",
            "description":"The charge ID with which the milestone event is associated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CompletionDate":{
            "type":"string",
            "description":"The completion date of the milestone event.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BillingOffset"
                ]
            }
        }
    }
}

Nested Schema : subscriptionProducts-charges-chargeTiers-item-patch-request

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "ChargeTierId":{
            "type":"integer",
            "description":"The unique identifier of the charge tier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AdditionalTimestampTwo":{
            "title":"Additional Time-stamp Two",
            "type":"string",
            "description":"Additional timestamp, if any, for the charge tier.",
            "format":"date-time",
            "nullable":true
        },
        "AdditionalNumberFour":{
            "title":"Additional Number Four",
            "type":"number",
            "description":"Additional number, if any, for the charge tier.",
            "nullable":true
        },
        "ChargeTierPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the charge tier.",
            "nullable":false
        },
        "AdditionalNumberThree":{
            "title":"Additional Number Three",
            "type":"number",
            "description":"Additional number, if any, for the charge tier.",
            "nullable":true
        },
        "AdditionalTimestampOne":{
            "title":"Additional Time-stamp One",
            "type":"string",
            "description":"Additional timestamp, if any, for the charge tier.",
            "format":"date-time",
            "nullable":true
        },
        "ListPrice":{
            "title":"List Price",
            "type":"number",
            "description":"The list price",
            "nullable":false
        },
        "PriceFormat":{
            "title":"Price Format",
            "maxLength":30,
            "type":"string",
            "description":"The display format of the price.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AdditionalTextOne":{
            "title":"Additional Text One",
            "maxLength":4000,
            "type":"string",
            "description":"Additional text, if any, for the charge tier.",
            "nullable":true
        },
        "AdditionalNumberFive":{
            "title":"Additional Number Five",
            "type":"number",
            "description":"Additional number, if any, for the charge tier.",
            "nullable":true
        },
        "AdditionalNumberSix":{
            "title":"Additional Number Six",
            "type":"number",
            "description":"Additional number, if any, for the charge tier.",
            "nullable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TierTo":{
            "title":"Tier To",
            "type":"number",
            "description":"The tier to",
            "nullable":true
        },
        "AddtionalTextThree":{
            "title":"Additional Text Three",
            "maxLength":4000,
            "type":"string",
            "description":"Additional text, if any, for the charge tier.",
            "nullable":true
        },
        "AdditionalNumberOne":{
            "title":"Additional Number One",
            "type":"number",
            "description":"Additional number, if any, for the charge tier.",
            "nullable":true
        },
        "SequenceNumber":{
            "type":"number",
            "description":"The sequence number",
            "nullable":false
        },
        "AdditionalTextTwo":{
            "title":"Additional Text Two",
            "maxLength":4000,
            "type":"string",
            "description":"Additional text, if any, for the charge tier.",
            "nullable":true
        },
        "AdditionalTimestampThree":{
            "title":"Additional Time-stamp Three",
            "type":"string",
            "description":"Additional timestamp, if any, for the charge tier.",
            "format":"date-time",
            "nullable":true
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeId":{
            "type":"integer",
            "description":"The unique identifier of the charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "BlockSize":{
            "title":"Block Size",
            "type":"number",
            "description":"The block size",
            "nullable":true
        },
        "TierFrom":{
            "title":"Tier From",
            "type":"number",
            "description":"The tier from",
            "nullable":false
        },
        "AdditionalNumberTwo":{
            "title":"Additional Number Two",
            "type":"number",
            "description":"Additional number, if any, for the charge tier.",
            "nullable":true
        }
    }
}

Nested Schema : subscriptionProducts-coveredLevels-item-patch-request

Type: object

Show Source

• Address: string
  Title: Address

  The address of the party site.
• AssetGroupId: integer (int64)
  Title: Asset Group ID

  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)
  Title: Asset ID

  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.
• BatchTag: string
  Title: Batch Tag

  Maximum Length: 30

  Batch Tag
• 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.
• CalculateEstimatedTaxFlag: boolean
  Indicates whether estimated tax will be calculated for the subscription covered level.
• CancelDescription: string
  Title: Cancellation Description

  Maximum Length: 2000

  The cancellation description associated with a covered level.
• CanceledAmount: number
  Title: Canceled Amount

  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
  Title: Closed Amount

  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
  Title: Currency Code

  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.
• 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.
• 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.
• CreditedAmount: number
  Title: Credited Amount

  The amount that was credited.
• CreditType: string
  Title: Credit Type

  Maximum Length: 30

  Indicates the type of credit to be issued to the customer on close and amend.
• CurcyConvRateType: string
  Title: Conversion Rate Type

  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
  Title: Currency Code

  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)
  Title: Customer Account ID

  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.
• GenBillSchReqdFlag: boolean
  Title: Billing schedule update required

  Maximum Length: 1

  Generate Bill Schedule Required Flag
• GenerateBillingSchedule: string
  Indicates whether the billing schedule is to be generated.
• HierarchyTotal: number
  The total covered level of the hierarchy.
• InventoryItemId: integer (int64)
  Title: Item ID

  The unique identifier of the inventory item.
• InvoicedAmount: number
  Title: Invoiced Amount

  The amount for which the invoice was created.
• InvoiceText: string
  Maximum Length: 2000

  The text included in the invoice.
• ItemUnitOfMeasure: string
  Title: UOM

  Maximum Length: 15

  The unit of measure used to measure the items in the covered level.
• LineNumber: string
  Title: Number

  Maximum Length: 300

  The line number
• OverrideCreditAmount: number
  Title: Override Credit Amount

  The override credit amount of the covered level.
• ParentCoveredAssetId: integer (int64)
  Title: Parent Covered Asset ID

  The unique identifier of the parent covered asset.
• ParentCoveredLevelId: integer (int64)
  Title: Parent Covered Level ID

  The unique identifier of the parent covered level.
• PartyId: integer (int64)
  Title: Party ID

  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)
  Title: Party Site ID

  The unique identifier of the party site.
• Period: string
  Maximum Length: 80

  The period of the covered level.
• PriceAsOf: string (date)
  Title: Price as of Date

  The price as of a certain date.
• PriceListId: integer (int64)
  Title: Price List

  The unique identifier of the price list.
• PriceUnitOfMeasure: string
  Title: Pricing UOM

  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
  Title: Pricing Error

  Maximum Length: 1000

  The error in the pricing, if any.
• productAssetRelationships: array Covered Level Relationships
  Title: Covered Level Relationships

  The covered level relationships resource is used to view the relationship between a source and a target covered level. These relationships include amendment, renewal, suspension relationships.
• ProductGroupId: integer (int64)
  Title: Product Group ID

  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)
  Title: Renewed On

  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.
• RequestedPriceListId: integer (int64)
  Title: Override Price List

  The identifier of the requested price list.
• 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
  Title: Configured Asset Amount

  The rollup total of covered level.
• SourceKey: string
  Title: Source Key

  Maximum Length: 120

  The source key of the covered level.
• SourceLineKey: string
  Title: Source Line Key

  Maximum Length: 120

  The source line key of the covered level.
• SourceLineNumber: string
  Title: External Source Line Number

  Maximum Length: 120

  The source line number of the covered level.
• SourceNumber: string
  Title: External Source Number

  Maximum Length: 120

  The source number of the covered level.
• SourceSystem: string
  Title: External Source System

  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)
  Title: Subscription ID

  The unique identifier of the subscription.
• SubscriptionProductId: integer (int64)
  Title: Subscription Product ID

  The unique identifier of the subscription product.
• SuppressedCreditAmount: number
  Title: Suppressed Credit Amount

  The credit amount that was suppressed.
• SuspendCreditMethod: string
  Title: Suspend Credit Method

  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
  Title: Tax Amount

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

{
    "type":"object",
    "properties":{
        "TypeName":{
            "title":"Covered Level Type",
            "type":"string",
            "description":"The name of the type of the covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CalculatedCreditAmount":{
            "title":"Calculated Credit Amount",
            "type":"number",
            "description":"The calculated credit amount of the covered level.",
            "nullable":true
        },
        "ProductName":{
            "title":"Product Name",
            "type":"string",
            "description":"The name of the product associated with the covered level.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "Address":{
            "title":"Address",
            "type":"string",
            "description":"The address of the party site.",
            "nullable":true,
            "x-queryable":false
        },
        "productAssetRelationships":{
            "title":"Covered Level Relationships",
            "type":"array",
            "description":"The covered level relationships resource is used to view the relationship between a source and a target covered level. These relationships include amendment, renewal, suspension relationships.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-productAssetRelationships-item-patch-request"
            }
        },
        "ParentCoveredLevelId":{
            "title":"Parent Covered Level ID",
            "type":"integer",
            "description":"The unique identifier of the parent covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PartyName":{
            "title":"Party Name",
            "type":"string",
            "description":"The name of the party.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "CancelDescription":{
            "title":"Cancellation Description",
            "maxLength":2000,
            "type":"string",
            "description":"The cancellation description associated with a covered level.",
            "nullable":true
        },
        "CurcyConvRateType":{
            "title":"Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "ProductGroupName":{
            "title":"Product Group Name",
            "type":"string",
            "description":"The name of the product group.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "RollupTotal":{
            "title":"Configured Asset Amount",
            "type":"number",
            "description":"The rollup total of covered level.",
            "nullable":true
        },
        "SuspendCreditMethod":{
            "title":"Suspend Credit Method",
            "maxLength":30,
            "type":"string",
            "description":"Indicates if the credit method has to be suspended.",
            "nullable":true
        },
        "StartDate":{
            "title":"Covered Level Start Date",
            "type":"string",
            "description":"The date when the covered level starts.",
            "format":"date",
            "nullable":false
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "ParentCoveredAssetId":{
            "title":"Parent Covered Asset ID",
            "type":"integer",
            "description":"The unique identifier of the parent covered asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "relationships":{
            "title":"Relationships",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-relationships-item-patch-request"
            }
        },
        "TaxAmount":{
            "title":"Tax Amount",
            "type":"number",
            "description":"The tax amount levied on the transaction.",
            "nullable":true
        },
        "SourceKey":{
            "title":"Source Key",
            "maxLength":120,
            "type":"string",
            "description":"The source key of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CloseReason":{
            "title":"Covered Level Close Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason why the covered level was closed.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CustomerNumber":{
            "title":"Customer Account Number",
            "type":"string",
            "description":"The alternate unique identifier of the customer.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "CoveredLevelParentPuid":{
            "type":"string",
            "description":"The alternate unique identifier of the covered level parent.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceNumber":{
            "title":"External Source Number",
            "maxLength":120,
            "type":"string",
            "description":"The source number of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "PartySiteId":{
            "title":"Party Site ID",
            "type":"integer",
            "description":"The unique identifier of the party site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CanceledDate":{
            "title":"Canceled Date",
            "type":"string",
            "description":"The date when the covered level was canceled.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ExplodeAssetHierarchy":{
            "type":"string",
            "description":"Indicates if the assest hierarchy should be copied to other hierarchies.",
            "nullable":true,
            "x-queryable":false
        },
        "AssetGroupId":{
            "title":"Asset Group ID",
            "type":"integer",
            "description":"The unique identifier of the asset group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SubscriptionProductId":{
            "title":"Subscription Product ID",
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CorpCurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "ItemUnitOfMeasure":{
            "title":"UOM",
            "maxLength":15,
            "type":"string",
            "description":"The unit of measure used to measure the items in the covered level.",
            "nullable":true
        },
        "Status":{
            "title":"Covered Level Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the covered level.",
            "nullable":true
        },
        "CoveredLevelName":{
            "title":"Covered Level Name",
            "maxLength":300,
            "type":"string",
            "description":"The name of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "AssetGroupNumber":{
            "title":"Asset Group Number",
            "type":"string",
            "description":"The alternate identifier of an asset group.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "InventoryItemId":{
            "title":"Item ID",
            "type":"integer",
            "description":"The unique identifier of the inventory item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CreditedAmount":{
            "title":"Credited Amount",
            "type":"number",
            "description":"The amount that was credited.",
            "nullable":true
        },
        "Period":{
            "maxLength":80,
            "type":"string",
            "description":"The period of the covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Duration":{
            "type":"integer",
            "description":"The duration of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "StatusName":{
            "title":"Status",
            "type":"string",
            "description":"The meaning of the status of the covered level.",
            "nullable":true
        },
        "RenewalType":{
            "title":"Renewal Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the covered level renewal.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AssetName":{
            "title":"Covered Level Asset Name",
            "type":"string",
            "description":"The name of the asset.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "AssetSerialNumber":{
            "title":"Covered Asset Serial Number",
            "type":"string",
            "description":"The serial number of the asset.",
            "nullable":true
        },
        "charges":{
            "title":"Charges",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-charges-item-patch-request"
            }
        },
        "CancelReason":{
            "title":"Cancellation Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason for cancelling the covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SuppressedCreditAmount":{
            "title":"Suppressed Credit Amount",
            "type":"number",
            "description":"The credit amount that was suppressed.",
            "nullable":true
        },
        "PriceUnitOfMeasureName":{
            "title":"Pricing UOM",
            "type":"string",
            "description":"The display name of the unit of measure.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PriceListId":{
            "title":"Price List",
            "type":"integer",
            "description":"The unique identifier of the price list.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ReturnCreditMethod":{
            "title":"Close Credit Method",
            "maxLength":230,
            "type":"string",
            "description":"The method used to return the credit.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AssetId":{
            "title":"Asset ID",
            "type":"integer",
            "description":"The unique identifier of the asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "InvoicedAmount":{
            "title":"Invoiced Amount",
            "type":"number",
            "description":"The amount for which the invoice was created.",
            "nullable":true
        },
        "SuspendedDate":{
            "title":"Covered Level Suspend Date",
            "type":"string",
            "description":"The date when the covered level was suspended.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "SourceLineNumber":{
            "title":"External Source Line Number",
            "maxLength":120,
            "type":"string",
            "description":"The source line number of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CoveredLevlNumber":{
            "title":"Covered Level Number",
            "type":"string",
            "description":"The alternate identifier of the covered level.",
            "nullable":true
        },
        "ProductGroupNumber":{
            "title":"Product Group Number",
            "type":"string",
            "description":"The alternate identifier of a product group.",
            "nullable":true,
            "x-queryable":false
        },
        "AssetGroupName":{
            "title":"Asset Group Name",
            "type":"string",
            "description":"The name of the asset group.",
            "nullable":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Covered Level Description",
            "type":"string",
            "description":"A brief description of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CanceledAmount":{
            "title":"Canceled Amount",
            "type":"number",
            "description":"The amount that was canceled.",
            "nullable":true
        },
        "PriceAsOf":{
            "title":"Price as of Date",
            "type":"string",
            "description":"The price as of a certain date.",
            "format":"date",
            "nullable":true
        },
        "RequestedPriceListId":{
            "title":"Override Price List",
            "type":"integer",
            "description":"The identifier of the requested price list.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "LineNumber":{
            "title":"Number",
            "maxLength":300,
            "type":"string",
            "description":"The line number",
            "nullable":true,
            "x-queryable":false
        },
        "PartySite":{
            "title":"Party Site Number",
            "type":"string",
            "description":"The name of the party site.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "InvoiceText":{
            "maxLength":2000,
            "type":"string",
            "description":"The text included in the invoice.",
            "nullable":true
        },
        "SubscriptionId":{
            "title":"Subscription ID",
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CustomerAccountId":{
            "title":"Customer Account ID",
            "type":"integer",
            "description":"The unique identifier of the customer account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RevenueOption":{
            "title":"Revenue Accounting Option",
            "maxLength":30,
            "type":"string",
            "description":"Revenue Option",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TaxError":{
            "maxLength":4000,
            "type":"string",
            "description":"The tax error, if any, in the calculated amount.",
            "nullable":true
        },
        "CustomerName":{
            "title":"Customer Account",
            "type":"string",
            "description":"The name of the customer.",
            "nullable":true,
            "x-queryable":false
        },
        "CreditType":{
            "title":"Credit Type",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of credit to be issued to the customer on close and amend.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "GenBillSchReqdFlag":{
            "title":"Billing schedule update required",
            "maxLength":1,
            "type":"boolean",
            "description":"Generate Bill Schedule Required Flag",
            "nullable":true
        },
        "SourceLineKey":{
            "title":"Source Line Key",
            "maxLength":120,
            "type":"string",
            "description":"The source line key of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "ProductGroupId":{
            "title":"Product Group ID",
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RepriceFlag":{
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "billLines":{
            "title":"Bill Lines",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-billLines-item-patch-request"
            }
        },
        "RenewedDate":{
            "title":"Renewed On",
            "type":"string",
            "description":"The date when the covered level was renewed.",
            "format":"date",
            "nullable":true
        },
        "TotalContractValue":{
            "title":"Covered Level Contract Value",
            "type":"number",
            "description":"The total contract value associated with the covered level.",
            "nullable":true
        },
        "SuspendReason":{
            "title":"Covered Level Suspend Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason for suspending the credit method for the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity of the covered level.",
            "nullable":false,
            "default":1
        },
        "PriceUnitOfMeasure":{
            "title":"Pricing UOM",
            "maxLength":30,
            "type":"string",
            "description":"The unit of measure used to indicate the price.",
            "nullable":true
        },
        "HierarchyTotal":{
            "type":"number",
            "description":"The total covered level of the hierarchy.",
            "nullable":true
        },
        "EndDate":{
            "title":"Covered Level End Date",
            "type":"string",
            "description":"The date when the covered level ends.",
            "format":"date",
            "nullable":true
        },
        "ClosedAmount":{
            "title":"Closed Amount",
            "type":"number",
            "description":"The amount at which the covered level was closed.",
            "nullable":true
        },
        "CoveredLevlName":{
            "title":"Covered Level Name",
            "type":"string",
            "description":"The name of the covered level.",
            "nullable":true
        },
        "OverrideCreditAmount":{
            "title":"Override Credit Amount",
            "type":"number",
            "description":"The override credit amount of the covered level.",
            "nullable":true
        },
        "CalculateEstimatedTaxFlag":{
            "type":"boolean",
            "description":"Indicates whether estimated tax will be calculated for the subscription covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "PutOnHoldFlag":{
            "type":"boolean",
            "description":"Indicates if the covered level has been put on hold.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyNumber":{
            "title":"Party Number",
            "type":"string",
            "description":"The alternate identifier of the party.",
            "nullable":true,
            "x-queryable":false
        },
        "UnitPrice":{
            "title":"Unit Price",
            "type":"number",
            "description":"The unit price of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "GenerateBillingSchedule":{
            "type":"string",
            "description":"Indicates whether the billing schedule is to be generated.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RemoveHoldFlag":{
            "type":"boolean",
            "description":"Indicates if the hold on the covered level has to be removed.",
            "nullable":true,
            "x-queryable":false
        },
        "ClosedDate":{
            "title":"Covered Level Close Date",
            "type":"string",
            "description":"The date when the covered level was closed.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "PricingError":{
            "title":"Pricing Error",
            "maxLength":1000,
            "type":"string",
            "description":"The error in the pricing, if any.",
            "nullable":true
        },
        "CloseDescription":{
            "title":"Covered Level Close Description",
            "maxLength":2000,
            "type":"string",
            "description":"The close description associated with a covered level.",
            "nullable":true
        },
        "SourceSystem":{
            "title":"External Source System",
            "maxLength":30,
            "type":"string",
            "description":"The source system of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "BatchTag":{
            "title":"Batch Tag",
            "maxLength":30,
            "type":"string",
            "description":"Batch Tag",
            "nullable":true
        }
    }
}

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

• Array of: object subscriptionProducts-coveredLevels-billLines-item-patch-request

{
    "title":"Bill Lines",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-billLines-item-patch-request"
    }
}

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

• Array of: object subscriptionProducts-coveredLevels-charges-item-patch-request

{
    "title":"Charges",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-charges-item-patch-request"
    }
}

Nested Schema : Covered Level Relationships

Type: array

Title: Covered Level Relationships

The covered level relationships resource is used to view the relationship between a source and a target covered level. These relationships include amendment, renewal, suspension relationships.

Show Source

• Array of: object subscriptionProducts-coveredLevels-productAssetRelationships-item-patch-request

{
    "title":"Covered Level Relationships",
    "type":"array",
    "description":"The covered level relationships resource is used to view the relationship between a source and a target covered level. These relationships include amendment, renewal, suspension relationships.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-productAssetRelationships-item-patch-request"
    }
}

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

• Array of: object subscriptionProducts-coveredLevels-relationships-item-patch-request

{
    "title":"Relationships",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-relationships-item-patch-request"
    }
}

Nested Schema : subscriptionProducts-coveredLevels-billLines-item-patch-request

Type: object

Show Source

• AdhocBillLineFlag: boolean
  Default Value: false

  Adhoc BillLine Flag
• Amount: number
  Title: Amount

  The amount for which the bill is generated.
• BatchTag: string
  Title: Batch Tag

  Maximum Length: 30

  Batch Tag
• 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.
• 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.
• CoveredLevelId: integer (int64)
  The unique identifier of the covered level.
• 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
  Title: Credit Memo Reason Code

  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.
• 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
  Title: Milestone Name

  The name of the milestone event associated with the bill line.
• NewCreditMemoPUID: string
  The unique public identifier of the new credit memo.
• PricedQuantity: number
  Title: Priced Quantity

  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
• 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)
  Title: Usage Capture Date

  The date when the usage was captured.
• UsageChargeType: string
  Title: Usage Charge Type

  Maximum Length: 30

  The type of usage charge.
• UsageChargeTypeName: string
  Title: Usage Charge Type

  The name of the usage charge type.
• UsageFlag: boolean
  Maximum Length: 1

  Indicates whether the line is a usage line or not.
• UsageInvoiceAttachmentYn: string
  Maximum Length: 1

  Indicates whether usage events invoice attachment is associated with the bill line.
• 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.
• UsageRatingProcess: string
  Title: Usage Rating Process

  Maximum Length: 30

  Usage Rating Process

{
    "type":"object",
    "properties":{
        "TrxId":{
            "type":"integer",
            "description":"The AR transaction ID.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TransactionTypeName":{
            "type":"string",
            "description":"The transaction type name of the subscription bill line.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargeDefinition":{
            "maxLength":30,
            "type":"string",
            "description":"The definition that indicates the purpose of the charge.",
            "nullable":true
        },
        "UsagePricedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the usage line has been priced or not.",
            "nullable":true
        },
        "UsageRatingProcess":{
            "title":"Usage Rating Process",
            "maxLength":30,
            "type":"string",
            "description":"Usage Rating Process",
            "nullable":true
        },
        "ListPrice":{
            "type":"number",
            "description":"The list price of the product associated with the bill line.",
            "nullable":true
        },
        "TransactionTax":{
            "title":"Tax",
            "type":"number",
            "description":"The tax levied on the transaction.",
            "nullable":true
        },
        "RevenueLineId":{
            "type":"integer",
            "description":"The unique identifier of the revenue line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CreditMemoReason":{
            "type":"string",
            "description":"The reason to raise the credit memo.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "BillLinePuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the bill line.",
            "nullable":false
        },
        "UsageFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the line is a usage line or not.",
            "nullable":true
        },
        "UsageChargeTypeName":{
            "title":"Usage Charge Type",
            "type":"string",
            "description":"The name of the usage charge type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "billAdjustments":{
            "title":"Bill Adjustments",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-billLines-billAdjustments-item-patch-request"
            }
        },
        "BillingPeriod":{
            "title":"Sequence",
            "type":"number",
            "description":"The period for which the bill is generated.",
            "nullable":false
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"The ID of the business unit associated with the bill line.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargeName":{
            "title":"Charge Name",
            "maxLength":120,
            "type":"string",
            "description":"The name of the charge associated with the bill line.",
            "nullable":true
        },
        "RetrieveInvoiceFlag":{
            "title":"Retrieve Invoice from Receivables",
            "maxLength":1,
            "type":"boolean",
            "description":"Retrieve Invoice Flag",
            "nullable":true
        },
        "MilestoneEventId":{
            "type":"integer",
            "description":"The ID of the milestone event associated with the bill line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TrxLineId":{
            "type":"integer",
            "description":"The AR transaction line ID.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SummarizedBillLineId":{
            "title":"Summarized Bill Line ID",
            "type":"integer",
            "description":"Summarized Bill Line ID",
            "nullable":true
        },
        "UsageCaptureDate":{
            "title":"Usage Capture Date",
            "type":"string",
            "description":"The date when the usage was captured.",
            "format":"date",
            "nullable":true
        },
        "RevenuePeriod":{
            "title":"Revenue Effectivity Periods",
            "maxLength":30,
            "type":"string",
            "description":"Revenue Period",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CreditMemoFlag":{
            "type":"string",
            "description":"Indicates if there is a credit memo associated with the bill line.",
            "nullable":true,
            "x-queryable":false
        },
        "DateToInterface":{
            "title":"Interface Date",
            "type":"string",
            "description":"The date to interface for the bill line.",
            "format":"date",
            "nullable":true
        },
        "UsageChargeType":{
            "title":"Usage Charge Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of usage charge.",
            "nullable":true
        },
        "TransactionNumber":{
            "title":"Invoice Number",
            "maxLength":30,
            "type":"string",
            "description":"The number of the transaction.",
            "nullable":true
        },
        "NewCreditMemoPUID":{
            "type":"string",
            "description":"The unique public identifier of the new credit memo.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargePeriodFactor":{
            "type":"number",
            "description":"The change period factor associated with the bill line.",
            "nullable":true
        },
        "CustomerTrxTypeSequenceId":{
            "type":"integer",
            "description":"Customer Transaction Type Sequence Id",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TruedUpYn":{
            "maxLength":3,
            "type":"string",
            "description":"Indicates if the bill line has a trueup period.",
            "nullable":true
        },
        "CreditMemoReasonCode":{
            "title":"Credit Memo Reason Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the credit memo reason code.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "InvoiceText":{
            "title":"Invoice Text",
            "maxLength":240,
            "type":"string",
            "description":"The text in the bill line invoice.",
            "nullable":true
        },
        "CreditMemoAmount":{
            "type":"number",
            "description":"The amount for the credit memo.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TransactionClass":{
            "title":"Transaction Class",
            "maxLength":30,
            "type":"string",
            "description":"The class of the transaction.",
            "nullable":true
        },
        "UsageInvoiceAttachmentYn":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether usage events invoice attachment is associated with the bill line.",
            "nullable":true
        },
        "AdhocBillLineFlag":{
            "type":"boolean",
            "description":"Adhoc BillLine Flag",
            "nullable":true,
            "default":false
        },
        "RevenueOption":{
            "title":"Revenue Accounting Option",
            "maxLength":30,
            "type":"string",
            "description":"Revenue Option",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "InvoiceDate":{
            "type":"string",
            "description":"The date when the invoice was raised.",
            "format":"date",
            "nullable":true
        },
        "ChargePeriod":{
            "title":"Period",
            "type":"number",
            "description":"The usage period that was charged.",
            "nullable":true
        },
        "TransactionDate":{
            "title":"Invoice Date",
            "type":"string",
            "description":"The date when the transaction occurred.",
            "format":"date",
            "nullable":true
        },
        "InvoiceBillLineId":{
            "type":"integer",
            "description":"The unique identifier of the invoice bill line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "UsageAcquiredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the usage has been acquired or not.",
            "nullable":true
        },
        "InterfacedFlag":{
            "title":"Interfaced",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the bill line is interfaced or not.",
            "nullable":false,
            "default":false
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount for which the bill is generated.",
            "nullable":true
        },
        "DateBilledTo":{
            "title":"Bill-to Date",
            "type":"string",
            "description":"The date up to which the bill is generated.",
            "format":"date",
            "nullable":false
        },
        "UsageQuantity":{
            "title":"Usage Quantity",
            "type":"number",
            "description":"The quantity of the usage.",
            "nullable":true
        },
        "CoveredLevelId":{
            "type":"integer",
            "description":"The unique identifier of the covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PricedQuantity":{
            "title":"Priced Quantity",
            "type":"number",
            "description":"The quantity for which the bill line was charged.",
            "nullable":true
        },
        "MilestoneEventName":{
            "title":"Milestone Name",
            "type":"string",
            "description":"The name of the milestone event associated with the bill line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TransactionAmount":{
            "title":"Invoice Amount",
            "type":"number",
            "description":"The amount for which the transaction occurred.",
            "nullable":true
        },
        "RecurringFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the line is recurring or not.",
            "nullable":false
        },
        "DateBilledFrom":{
            "title":"Bill-from Date",
            "type":"string",
            "description":"The date from which the bill was generated.",
            "format":"date",
            "nullable":false
        },
        "TransactionClassMeaning":{
            "title":"Class",
            "type":"string",
            "description":"The meaning of transaction class lookup.",
            "nullable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The unique identifier of the charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PricingError":{
            "maxLength":1000,
            "type":"string",
            "description":"The error in pricing, if any.",
            "nullable":true
        },
        "BatchTag":{
            "title":"Batch Tag",
            "maxLength":30,
            "type":"string",
            "description":"Batch Tag",
            "nullable":true
        }
    }
}

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

• Array of: object subscriptionProducts-coveredLevels-billLines-billAdjustments-item-patch-request

{
    "title":"Bill Adjustments",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-billLines-billAdjustments-item-patch-request"
    }
}

Nested Schema : subscriptionProducts-coveredLevels-billLines-billAdjustments-item-patch-request

Type: object

Show Source

• 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.
• CurrencyCode: string
  The current code used for the bill adjustment.
• Effectivity: string
  Maximum Length: 30

  The effectivity of the bill adjustment.
• 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.

{
    "type":"object",
    "properties":{
        "AutoAdjustmentFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Indicates whether the adjustment is automatic or not.",
            "nullable":false
        },
        "AdjustmentBasis":{
            "title":"Basis",
            "maxLength":30,
            "type":"string",
            "description":"The basis on which the bill is adjusted.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RevenueAdjustmentToDate":{
            "title":"Revenue Effective End Date",
            "type":"string",
            "description":"Revenue Adjustment To Date",
            "format":"date",
            "nullable":true
        },
        "Reason":{
            "title":"Reason Details",
            "maxLength":120,
            "type":"string",
            "description":"The reason why the bill is adjusted.",
            "nullable":true
        },
        "CurrencyCode":{
            "type":"string",
            "description":"The current code used for the bill adjustment.",
            "nullable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"number",
            "description":"The sequence number of the bill adjustment.",
            "nullable":false
        },
        "NumberOfPeriods":{
            "type":"number",
            "description":"The number of periods",
            "nullable":true
        },
        "RevenueOption":{
            "title":"Revenue Accounting Option",
            "maxLength":30,
            "type":"string",
            "description":"Revenue Option",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "BillAdjustmentPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the bill adjustment.",
            "nullable":false
        },
        "PeriodUntil":{
            "type":"number",
            "description":"The period until which the bill is adjusted.",
            "nullable":true
        },
        "PeriodFrom":{
            "type":"number",
            "description":"The period from which the bill was adjusted.",
            "nullable":true
        },
        "BillAdjustmentId":{
            "type":"integer",
            "description":"The unique identifier of the bill adjustment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RevenueAdjustmentFromDate":{
            "title":"Revenue Effective Start Date",
            "type":"string",
            "description":"Revenue Adjustment From Date",
            "format":"date",
            "nullable":true
        },
        "ChargeAdjustmentId":{
            "type":"integer",
            "description":"The unique identifier of the charge adjustment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AdjustmentReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code of the adjustment reason.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Effectivity":{
            "maxLength":30,
            "type":"string",
            "description":"The effectivity of the bill adjustment.",
            "nullable":true
        },
        "AdjustmentType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the bill adjustment.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AdjustmentValue":{
            "title":"Value",
            "type":"number",
            "description":"The value by which the bill is adjusted.",
            "nullable":false
        },
        "BillLineId":{
            "type":"integer",
            "description":"The unique identifier of the bill line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RevenuePeriod":{
            "title":"Revenue Effectivity Periods",
            "maxLength":30,
            "type":"string",
            "description":"Revenue Period",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AdjustmentName":{
            "title":"Adjustment",
            "maxLength":120,
            "type":"string",
            "description":"The name of the bill adjustment.",
            "nullable":true
        },
        "BasisEnableFlag":{
            "type":"boolean",
            "description":"Indicates if the base has been enabled for the bill adjustment.",
            "nullable":true
        }
    }
}

Nested Schema : subscriptionProducts-coveredLevels-charges-item-patch-request

Type: object

Show Source

• 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
  Title: Aggregation Method

  Maximum Length: 30

  The aggregation method used for the charges.
• Allowance: number
  Title: Allowance

  The allowance part of the charge.
• AssetMeterYn: boolean
  Title: Asset Meter Flag

  Maximum Length: 1

  The flag whether it is an asset meter or not.
• BatchTag: string
  Title: Batch Tag

  Maximum Length: 30

  Batch Tag
• BillingFreq: string
  Title: Billing Frequency

  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.
• chargeComponents: array Subcription Product Charge Components Records
  Title: Subcription Product Charge Components Records

  The subscription product charge components records resoure is used to view the price details of the individual charge components of subscription products.
• ChargeDefinition: string
  Title: Charge Name

  Maximum Length: 30

  The definition that indicates the purpose of the charge.
• ChargeDefinitionName: string
  Title: Charge Definition

  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
  Title: Charge Period Code

  Maximum Length: 30

  The code of the charge period associated with the charge.
• ChargePuid: string
  Title: Charge PUID

  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)
  Title: Covered Level ID

  The unique identifier of the covered level.
• EnableProration: string
  Title: Enable Proration

  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
  Title: External Key

  Maximum Length: 120

  The external key used to measure the charge.
• ExternalParentKey: string
  Title: External Parent Key

  Maximum Length: 120

  The external parent key.
• InitialMeterReadingId: integer (int64)
  Title: Initial Meter Reading ID

  The initial meter reading identifier value.
• InvoicingRuleId: integer (int64)
  Title: Invoicing Rule Id

  The ID of the invoice rule.
• InvoicingRuleName: string
  Title: Invoicing Rule

  The name of the invoice rule.
• MeterDefinitionId: integer (int64)
  Title: Meter Definition ID

  The unique identifier of the meter definition associated with the charges.
• MeterId: integer (int64)
  Title: Meter ID

  The unique identifier of the meter associated with the charges.
• MilestoneBillingFlag: boolean
  Title: Enable Milestone Based Billing

  Indicates whether the billing is impacted by milestone events or not.
• MilestoneRevenueFlag: boolean
  Title: Enable Milestone Based Revenue Recognition

  Indicates whether the revenue is impacted by milestone events or not.
• MilestoneTemplateId: integer (int64)
  Title: Template

  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
  Title: Enable Periodic Billing

  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
  Title: Periodicity

  The name of the price periodicity.
• PriceType(required): string
  Title: Price Type

  Maximum Length: 30

  The price type associated with the charge.
• QuotedTcv: number
  Title: Total Charge Amount

  The quoted TCV of the charge.
• RecurringPricePeriodicityCode: string
  Title: Recurring Price Periodicity Code

  Maximum Length: 30

  The recurring price periodicity code of the charge.
• RollupFlag: boolean
  Title: Rollup Flag

  Maximum Length: 1

  Indicates if the charge needs to be rolled up.
• SequenceNumber: integer (int32)
  Title: Sequence Number

  The sequence number for the charge.
• SubscriptionId: integer (int64)
  Title: Subscription ID

  The unique identifier of the subscription.
• SubscriptionProductId: integer (int64)
  Title: Subscription Product ID

  The unique identifier of the subscription product.
• TieredFlag: boolean
  Title: Tiered

  Maximum Length: 3

  Indicates whether the charge has tiers.
• TieredPricingHeaderId: integer
  Title: Tiered Pricing Header ID

  Tiered Pricing Header Id
• 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
  Title: Usage Price Lock

  Maximum Length: 3

  Indicates whether the usage price is locked or not.
• UsageUnitOfMeasure: string
  Title: Usage UOM

  Maximum Length: 3

  The usage unit of measure of the charge.

{
    "required":[
        "PriceType"
    ],
    "type":"object",
    "properties":{
        "AggregationMethod":{
            "title":"Aggregation Method",
            "maxLength":30,
            "type":"string",
            "description":"The aggregation method used for the charges.",
            "nullable":true
        },
        "ChargePuid":{
            "title":"Charge PUID",
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the charge.",
            "nullable":true
        },
        "chargeMilestoneEvents":{
            "title":"Charge Milestone Events",
            "type":"array",
            "description":"The charge milestone events resource is used to view, create, update, and delete the milestone events associated with a charge of a subscription.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-charges-chargeMilestoneEvents-item-patch-request"
            }
        },
        "adjustments":{
            "title":"Adjustments",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-charges-adjustments-item-patch-request"
            }
        },
        "ChargeDefinition":{
            "title":"Charge Name",
            "maxLength":30,
            "type":"string",
            "description":"The definition that indicates the purpose of the charge.",
            "nullable":true
        },
        "AssetMeterYn":{
            "title":"Asset Meter Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"The flag whether it is an asset meter or not.",
            "nullable":true
        },
        "EstimatedAmount":{
            "title":"Estimated Amount",
            "type":"number",
            "description":"The estimated amount of the charges.",
            "nullable":true
        },
        "PricePeriodicityName":{
            "title":"Periodicity",
            "type":"string",
            "description":"The name of the price periodicity.",
            "nullable":true
        },
        "PrePaymentNumber":{
            "title":"Prepayment Number",
            "type":"integer",
            "description":"The prepayment number for the charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "BillingFreq":{
            "title":"Billing Frequency",
            "maxLength":30,
            "type":"string",
            "description":"Billing Frequency",
            "nullable":true
        },
        "MeterDefinitionId":{
            "title":"Meter Definition ID",
            "type":"integer",
            "description":"The unique identifier of the meter definition associated with the charges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EstimationMethod":{
            "title":"Estimation Method",
            "maxLength":30,
            "type":"string",
            "description":"The method used to estimate the amount.",
            "nullable":true
        },
        "PeriodicBillingFlag":{
            "title":"Enable Periodic Billing",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether periodic billing is allowed or not.",
            "nullable":true
        },
        "MilestoneBillingFlag":{
            "title":"Enable Milestone Based Billing",
            "type":"boolean",
            "description":"Indicates whether the billing is impacted by milestone events or not.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "ExternalParentKey":{
            "title":"External Parent Key",
            "maxLength":120,
            "type":"string",
            "description":"The external parent key.",
            "nullable":true
        },
        "UnitListPrice":{
            "title":"List Price",
            "type":"number",
            "description":"The price of the unit list.",
            "nullable":true
        },
        "SequenceNumber":{
            "title":"Sequence Number",
            "type":"integer",
            "description":"The sequence number for the charge.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "InitialMeterReadingId":{
            "title":"Initial Meter Reading ID",
            "type":"integer",
            "description":"The initial meter reading identifier value.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SubscriptionProductId":{
            "title":"Subscription Product ID",
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EstimatedQuantity":{
            "title":"Estimated Quantity",
            "type":"number",
            "description":"The estimated quantity for the charge.",
            "nullable":true
        },
        "chargeComponents":{
            "title":"Subcription Product Charge Components Records",
            "type":"array",
            "description":"The subscription product charge components records resoure is used to view the price details of the individual charge components of subscription products.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-charges-chargeComponents-item-patch-request"
            }
        },
        "ChargeName":{
            "title":"Charge Name",
            "maxLength":120,
            "type":"string",
            "description":"The name of the charge.",
            "nullable":true
        },
        "RecurringPricePeriodicityCode":{
            "title":"Recurring Price Periodicity Code",
            "maxLength":30,
            "type":"string",
            "description":"The recurring price periodicity code of the charge.",
            "nullable":true
        },
        "QuotedTcv":{
            "title":"Total Charge Amount",
            "type":"number",
            "description":"The quoted TCV of the charge.",
            "nullable":true
        },
        "TieredFlag":{
            "title":"Tiered",
            "maxLength":3,
            "type":"boolean",
            "description":"Indicates whether the charge has tiers.",
            "nullable":true
        },
        "UsagePriceLockFlag":{
            "title":"Usage Price Lock",
            "maxLength":3,
            "type":"boolean",
            "description":"Indicates whether the usage price is locked or not.",
            "nullable":true
        },
        "PeriodicRevenueFlag":{
            "title":"Enable Periodic Revenue Recognition",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the periodic revenue recognition of one-time charges.",
            "nullable":true
        },
        "MilestoneRevenueFlag":{
            "title":"Enable Milestone Based Revenue Recognition",
            "type":"boolean",
            "description":"Indicates whether the revenue is impacted by milestone events or not.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "chargeTiers":{
            "title":"Charge Tiers",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-charges-chargeTiers-item-patch-request"
            }
        },
        "MinimumAmount":{
            "title":"Minimum Amount",
            "type":"number",
            "description":"The minimum amount to be charged.",
            "nullable":true
        },
        "PriceType":{
            "title":"Price Type",
            "maxLength":30,
            "type":"string",
            "description":"The price type associated with the charge.",
            "nullable":false
        },
        "RollupFlag":{
            "title":"Rollup Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the charge needs to be rolled up.",
            "nullable":true
        },
        "TierType":{
            "title":"Tier Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the charge tier.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TieredPricingHeaderId":{
            "title":"Tiered Pricing Header ID",
            "type":"integer",
            "description":"Tiered Pricing Header Id",
            "nullable":true,
            "x-queryable":false
        },
        "InvoicingRuleName":{
            "title":"Invoicing Rule",
            "type":"string",
            "description":"The name of the invoice rule.",
            "nullable":true,
            "x-queryable":false
        },
        "MeterId":{
            "title":"Meter ID",
            "type":"integer",
            "description":"The unique identifier of the meter associated with the charges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeDefinitionName":{
            "title":"Charge Definition",
            "type":"string",
            "description":"The name of the charge definition.",
            "nullable":true
        },
        "UsageUnitOfMeasure":{
            "title":"Usage UOM",
            "maxLength":3,
            "type":"string",
            "description":"The usage unit of measure of the charge.",
            "nullable":true
        },
        "SubscriptionId":{
            "title":"Subscription ID",
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EnableProration":{
            "title":"Enable Proration",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether proration is enabled or not.",
            "nullable":true
        },
        "TrueUpPeriodName":{
            "title":"True Up Period",
            "type":"string",
            "description":"The name of the trueup period.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ExternalKey":{
            "title":"External Key",
            "maxLength":120,
            "type":"string",
            "description":"The external key used to measure the charge.",
            "nullable":true
        },
        "ChargePeriodCode":{
            "title":"Charge Period Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the charge period associated with the charge.",
            "nullable":true
        },
        "Allowance":{
            "title":"Allowance",
            "type":"number",
            "description":"The allowance part of the charge.",
            "nullable":true
        },
        "InvoicingRuleId":{
            "title":"Invoicing Rule Id",
            "type":"integer",
            "description":"The ID of the invoice rule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "MilestoneTemplateName":{
            "maxLength":120,
            "type":"string",
            "description":"The name of the milestone template associated with a charge.",
            "nullable":true,
            "x-queryable":false
        },
        "MilestoneTemplateId":{
            "title":"Template",
            "type":"integer",
            "description":"The ID of the milestone event associated with a charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "CoveredLevelId":{
            "title":"Covered Level ID",
            "type":"integer",
            "description":"The unique identifier of the covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "BillingFreqName":{
            "title":"Billing Frequency",
            "maxLength":255,
            "type":"string",
            "description":"Billing Frequency Name",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "MinimumQuantity":{
            "title":"Minimum Quantity",
            "type":"number",
            "description":"The minimum quantity that is allowed.",
            "nullable":true
        },
        "EstimatedMethodName":{
            "title":"Estimation Method",
            "type":"string",
            "description":"The method used to estimate the amount.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PricePeriodicity":{
            "title":"Periodicity",
            "maxLength":30,
            "type":"string",
            "description":"The price periodicity for the charge. Indicates the frequency when the charge has to be applied.",
            "nullable":true
        },
        "TrueUpPeriod":{
            "title":"True Up Period",
            "maxLength":30,
            "type":"string",
            "description":"The identifier of the trueup period.",
            "nullable":true,
            "default":"ORA_OSS_USAGE_BILLING_PERIOD"
        },
        "BillLineId":{
            "type":"integer",
            "description":"The unique identifier of the bill line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeId":{
            "type":"integer",
            "description":"The unique identifier of the charge.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BlockSize":{
            "title":"Block Size",
            "type":"number",
            "description":"The block size of the charge.",
            "nullable":true
        },
        "BatchTag":{
            "title":"Batch Tag",
            "maxLength":30,
            "type":"string",
            "description":"Batch Tag",
            "nullable":true
        }
    }
}

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

• Array of: object subscriptionProducts-coveredLevels-charges-adjustments-item-patch-request

{
    "title":"Adjustments",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-charges-adjustments-item-patch-request"
    }
}

Nested Schema : Subcription Product Charge Components Records

Type: array

Title: Subcription Product Charge Components Records

The subscription product charge components records resoure is used to view the price details of the individual charge components of subscription products.

Show Source

• Array of: object subscriptionProducts-coveredLevels-charges-chargeComponents-item-patch-request

{
    "title":"Subcription Product Charge Components Records",
    "type":"array",
    "description":"The subscription product charge components records resoure is used to view the price details of the individual charge components of subscription products.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-charges-chargeComponents-item-patch-request"
    }
}

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

• Array of: object subscriptionProducts-coveredLevels-charges-chargeMilestoneEvents-item-patch-request

{
    "title":"Charge Milestone Events",
    "type":"array",
    "description":"The charge milestone events resource is used to view, create, update, and delete the milestone events associated with a charge of a subscription.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-charges-chargeMilestoneEvents-item-patch-request"
    }
}

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

• Array of: object subscriptionProducts-coveredLevels-charges-chargeTiers-item-patch-request

{
    "title":"Charge Tiers",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-charges-chargeTiers-item-patch-request"
    }
}

Nested Schema : subscriptionProducts-coveredLevels-charges-adjustments-item-patch-request

Type: object

Show Source

• 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.
• Effectivity: string
  Title: Effectivity

  Maximum Length: 30

  The adjustment effectivity
• 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.

{
    "type":"object",
    "properties":{
        "AutoAdjustmentFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Indicates whether the adjustment is automatic or not.",
            "nullable":true
        },
        "ChargeAdjustmentPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the charge adjustment.",
            "nullable":true
        },
        "AdjustmentBasis":{
            "title":"Basis",
            "maxLength":30,
            "type":"string",
            "description":"The basis of the adjustment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChargeAdjustmentId":{
            "type":"integer",
            "description":"The unique identifier of the charge adjustment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AdjustmentReasonCode":{
            "title":"Reason",
            "maxLength":30,
            "type":"string",
            "description":"The code of the adjustment reason.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Effectivity":{
            "title":"Effectivity",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment effectivity",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Reason":{
            "title":"Reason Description",
            "maxLength":120,
            "type":"string",
            "description":"The reason for the adjustment.",
            "nullable":true
        },
        "AdjustmentType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the adjustment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AdjustmentValue":{
            "title":"Value",
            "type":"number",
            "description":"The value of the adjustment.",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"integer",
            "description":"The sequence number of the adjustment.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "NumberOfPeriods":{
            "type":"number",
            "description":"The number of periods",
            "nullable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The unique identifier of the charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PeriodUntil":{
            "type":"number",
            "description":"The period until which the adjustment is initiated.",
            "nullable":true
        },
        "AdjustmentReasonMeaning":{
            "title":"Reason",
            "type":"string",
            "description":"The translated adjustment reason.",
            "nullable":true,
            "x-queryable":false
        },
        "AdjustmentName":{
            "title":"Adjustment",
            "maxLength":120,
            "type":"string",
            "description":"The name of the adjustment.",
            "nullable":true
        },
        "PeriodFrom":{
            "type":"number",
            "description":"The period from which the adjustment was initiated.",
            "nullable":true
        }
    }
}

Nested Schema : subscriptionProducts-coveredLevels-charges-chargeComponents-item-patch-request

Type: object

Show Source

• ChargeComponentId: integer (int64)
  The identifier of the charge component.
• ChargeComponentPuid: string
  Maximum Length: 120

  The PUID of the charge component.
• ChargeCurrency: string
  Title: Currency

  Maximum Length: 15

  The charge currency of the charge component.
• ChargeCurrencyExtAmount: number
  Title: Extended Amount

  The extended amount of the charge component in charge currency.
• ChargeCurrencyUnitPrice: number
  Title: Currency Unit Price

  The unit price of the charge component in charge currency.
• ChargeId: integer (int64)
  Title: Charge ID

  The identifier of the charge.
• CoverageExtendedAmount: number
  Title: Coverage Extended Amount

  The extended coverage amount of the charge component.
• Explanation: string
  Title: Explanation

  Maximum Length: 1000

  The explanation for the charge component.
• ExplanationMessageName: string
  Title: Explanation Message

  Maximum Length: 30

  The explanation message name of the charge component.
• ObjectVersionNumber: integer (int32)
  The object version number of the charge component.
• Price: number
  Title: Amount

  The price of the charge component.
• PriceElement: string
  Title: Price Element

  Maximum Length: 30

  The price element of the charge component.
• PriceElementUsage: string
  Title: Price Element Usage

  Maximum Length: 30

  The price element usage of the charge component.
• PriceforQuantity: number
  Title: Price

  The price for quantity of the charge component.
• PricingSourceId: integer (int64)
  The identifier of the pricing source of the charge component.
• PricingSourceType: string
  Title: Pricing Source Type

  Maximum Length: 30

  The type of pricing source of the charge component.
• RollupFlag: boolean
  Title: Rollup Flag

  Maximum Length: 1

  The indicator of whether charge component should be rolled up or not.
• SequenceNumber: integer (int32)
  Title: Sequence Number

  The sequence number of the charge component.
• SubscriptionCurrency: string
  Title: Subscription Currency

  Maximum Length: 15

  The subscription currency of the charge component.
• SubscriptionId: integer (int64)
  Title: Subscription ID

  The identifier of the subscription.
• TaxIncludedFlag: boolean
  Title: Tax Included Flag

  Maximum Length: 1

  The indicator of whether tax is included for the charge component or not.
• UnitPrice: number
  Title: Unit Price

  The unit price of the charge component.

{
    "type":"object",
    "properties":{
        "ChargeComponentPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The PUID of the charge component.",
            "nullable":true
        },
        "RollupFlag":{
            "title":"Rollup Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"The indicator of whether charge component should be rolled up or not.",
            "nullable":true
        },
        "ExplanationMessageName":{
            "title":"Explanation Message",
            "maxLength":30,
            "type":"string",
            "description":"The explanation message name of the charge component.",
            "nullable":true
        },
        "ChargeCurrency":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The charge currency of the charge component.",
            "nullable":true
        },
        "Explanation":{
            "title":"Explanation",
            "maxLength":1000,
            "type":"string",
            "description":"The explanation for the charge component.",
            "nullable":true
        },
        "PricingSourceId":{
            "type":"integer",
            "description":"The identifier of the pricing source of the charge component.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TaxIncludedFlag":{
            "title":"Tax Included Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"The indicator of whether tax is included for the charge component or not.",
            "nullable":true
        },
        "CoverageExtendedAmount":{
            "title":"Coverage Extended Amount",
            "type":"number",
            "description":"The extended coverage amount of the charge component.",
            "nullable":true
        },
        "PricingSourceType":{
            "title":"Pricing Source Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of pricing source of the charge component.",
            "nullable":true
        },
        "ChargeCurrencyUnitPrice":{
            "title":"Currency Unit Price",
            "type":"number",
            "description":"The unit price of the charge component in charge currency.",
            "nullable":true
        },
        "UnitPrice":{
            "title":"Unit Price",
            "type":"number",
            "description":"The unit price of the charge component.",
            "nullable":true
        },
        "SubscriptionId":{
            "title":"Subscription ID",
            "type":"integer",
            "description":"The identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeComponentId":{
            "type":"integer",
            "description":"The identifier of the charge component.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the charge component.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "Price":{
            "title":"Amount",
            "type":"number",
            "description":"The price of the charge component.",
            "nullable":true
        },
        "PriceElement":{
            "title":"Price Element",
            "maxLength":30,
            "type":"string",
            "description":"The price element of the charge component.",
            "nullable":true
        },
        "SubscriptionCurrency":{
            "title":"Subscription Currency",
            "maxLength":15,
            "type":"string",
            "description":"The subscription currency of the charge component.",
            "nullable":true
        },
        "SequenceNumber":{
            "title":"Sequence Number",
            "type":"integer",
            "description":"The sequence number of the charge component.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "ChargeCurrencyExtAmount":{
            "title":"Extended Amount",
            "type":"number",
            "description":"The extended amount of the charge component in charge currency.",
            "nullable":true
        },
        "ChargeId":{
            "title":"Charge ID",
            "type":"integer",
            "description":"The identifier of the charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PriceforQuantity":{
            "title":"Price",
            "type":"number",
            "description":"The price for quantity of the charge component.",
            "nullable":true
        },
        "PriceElementUsage":{
            "title":"Price Element Usage",
            "maxLength":30,
            "type":"string",
            "description":"The price element usage of the charge component.",
            "nullable":true
        }
    }
}

Nested Schema : subscriptionProducts-coveredLevels-charges-chargeMilestoneEvents-item-patch-request

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "BillingOffset":{
            "type":"number",
            "description":"The billing offset associated with a milestone event.",
            "nullable":true
        },
        "ChargePuid":{
            "maxLength":120,
            "type":"string",
            "description":"The PUID of the charge to which the milestone event is associated.",
            "nullable":true,
            "default":"Charges.ChargePuid",
            "x-queryable":false
        },
        "ExpectedCompletionDate":{
            "type":"string",
            "description":"The expected completion date of a milestone event.",
            "format":"date",
            "nullable":true
        },
        "EventType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of the milestone event.",
            "nullable":false
        },
        "Percentage":{
            "type":"number",
            "description":"The percentage associated with a milestone event.",
            "nullable":false,
            "x-hints":{
                "precision":5,
                "scale":2
            }
        },
        "MilestoneName":{
            "maxLength":30,
            "type":"string",
            "description":"The name of the milestone event.",
            "nullable":false
        },
        "MilestoneComment":{
            "maxLength":300,
            "type":"string",
            "description":"The milestone event comment.",
            "nullable":true
        },
        "MilestonePuid":{
            "maxLength":120,
            "type":"string",
            "description":"The milestone event PUID.",
            "nullable":true
        },
        "EventSource":{
            "maxLength":30,
            "type":"string",
            "description":"The source of the milestone event.",
            "nullable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the milestone event.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "EventSourceReference":{
            "maxLength":120,
            "type":"string",
            "description":"The source reference of the milestone event.",
            "nullable":true
        },
        "BillLineId":{
            "type":"integer",
            "description":"The bill line ID associated with the milestone event.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeId":{
            "type":"integer",
            "description":"The charge ID with which the milestone event is associated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CompletionDate":{
            "type":"string",
            "description":"The completion date of the milestone event.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BillingOffset"
                ]
            }
        }
    }
}

Nested Schema : subscriptionProducts-coveredLevels-charges-chargeTiers-item-patch-request

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "ChargeTierId":{
            "type":"integer",
            "description":"The unique identifier of the charge tier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AdditionalTimestampTwo":{
            "title":"Additional Time-stamp Two",
            "type":"string",
            "description":"Additional timestamp, if any, for the charge tier.",
            "format":"date-time",
            "nullable":true
        },
        "AdditionalNumberFour":{
            "title":"Additional Number Four",
            "type":"number",
            "description":"Additional number, if any, for the charge tier.",
            "nullable":true
        },
        "ChargeTierPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the charge tier.",
            "nullable":false
        },
        "AdditionalNumberThree":{
            "title":"Additional Number Three",
            "type":"number",
            "description":"Additional number, if any, for the charge tier.",
            "nullable":true
        },
        "AdditionalTimestampOne":{
            "title":"Additional Time-stamp One",
            "type":"string",
            "description":"Additional timestamp, if any, for the charge tier.",
            "format":"date-time",
            "nullable":true
        },
        "ListPrice":{
            "title":"List Price",
            "type":"number",
            "description":"The list price",
            "nullable":false
        },
        "PriceFormat":{
            "title":"Price Format",
            "maxLength":30,
            "type":"string",
            "description":"The display format of the price.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AdditionalTextOne":{
            "title":"Additional Text One",
            "maxLength":4000,
            "type":"string",
            "description":"Additional text, if any, for the charge tier.",
            "nullable":true
        },
        "AdditionalNumberFive":{
            "title":"Additional Number Five",
            "type":"number",
            "description":"Additional number, if any, for the charge tier.",
            "nullable":true
        },
        "AdditionalNumberSix":{
            "title":"Additional Number Six",
            "type":"number",
            "description":"Additional number, if any, for the charge tier.",
            "nullable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TierTo":{
            "title":"Tier To",
            "type":"number",
            "description":"The tier to",
            "nullable":true
        },
        "AddtionalTextThree":{
            "title":"Additional Text Three",
            "maxLength":4000,
            "type":"string",
            "description":"Additional text, if any, for the charge tier.",
            "nullable":true
        },
        "AdditionalNumberOne":{
            "title":"Additional Number One",
            "type":"number",
            "description":"Additional number, if any, for the charge tier.",
            "nullable":true
        },
        "SequenceNumber":{
            "type":"number",
            "description":"The sequence number",
            "nullable":false
        },
        "AdditionalTextTwo":{
            "title":"Additional Text Two",
            "maxLength":4000,
            "type":"string",
            "description":"Additional text, if any, for the charge tier.",
            "nullable":true
        },
        "AdditionalTimestampThree":{
            "title":"Additional Time-stamp Three",
            "type":"string",
            "description":"Additional timestamp, if any, for the charge tier.",
            "format":"date-time",
            "nullable":true
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeId":{
            "type":"integer",
            "description":"The unique identifier of the charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "BlockSize":{
            "title":"Block Size",
            "type":"number",
            "description":"The block size",
            "nullable":true
        },
        "TierFrom":{
            "title":"Tier From",
            "type":"number",
            "description":"The tier from",
            "nullable":false
        },
        "AdditionalNumberTwo":{
            "title":"Additional Number Two",
            "type":"number",
            "description":"Additional number, if any, for the charge tier.",
            "nullable":true
        }
    }
}

Nested Schema : subscriptionProducts-coveredLevels-productAssetRelationships-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : subscriptionProducts-coveredLevels-relationships-item-patch-request

Type: object

Show Source

• OperationLinksPuid: string
  Title: Operation Links PUID

  Maximum Length: 120

  The public unique identifier of the operation links.
• SourceAssetKey: string
  Title: Source Asset Key

  Maximum Length: 120

  The source asset key
• SourceProdAssociationId: integer (int64)
  Title: Source Product Association ID

  The unique identifier of the source product association.
• SourceProdAssociationPuid: string
  Title: Source Product Association PUID

  Maximum Length: 120

  The public unique identifier of the source product association.
• SourceProductPuid: string
  Title: Source Product PUID

  Maximum Length: 120

  The public unique identifier of the source product.
• SourceRootAssetKey: string
  Title: Source Root Asset Key

  Maximum Length: 120

  The source root asset key
• TargetProdAssociationId: integer (int64)
  Title: Target Product Association ID

  The unique identifier of the target product association.
• TargetProdAssociationPuid: string
  Title: Target Product Association PUID

  Maximum Length: 120

  The public unique identifier of the target product association.
• TargetProductPuid: string
  Title: Target Product PUID

  Maximum Length: 120

  The public unique identifier of the target product.

{
    "type":"object",
    "properties":{
        "OperationLinksPuid":{
            "title":"Operation Links PUID",
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the operation links.",
            "nullable":true
        },
        "SourceProdAssociationId":{
            "title":"Source Product Association ID",
            "type":"integer",
            "description":"The unique identifier of the source product association.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TargetProdAssociationId":{
            "title":"Target Product Association ID",
            "type":"integer",
            "description":"The unique identifier of the target product association.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SourceAssetKey":{
            "title":"Source Asset Key",
            "maxLength":120,
            "type":"string",
            "description":"The source asset key",
            "nullable":true
        },
        "SourceProductPuid":{
            "title":"Source Product PUID",
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the source product.",
            "nullable":true
        },
        "SourceRootAssetKey":{
            "title":"Source Root Asset Key",
            "maxLength":120,
            "type":"string",
            "description":"The source root asset key",
            "nullable":true
        },
        "SourceProdAssociationPuid":{
            "title":"Source Product Association PUID",
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the source product association.",
            "nullable":true
        },
        "TargetProductPuid":{
            "title":"Target Product PUID",
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the target product.",
            "nullable":true
        },
        "TargetProdAssociationPuid":{
            "title":"Target Product Association PUID",
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the target product association.",
            "nullable":true
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• 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.
• CardHolderName: string
  Title: Cardholder Name

  The name of the credit card holder.
• 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 instrument assignment ID associated with the credit card.
• IssuerCode: string
  The credit card issuing company.
• LastName: string
  The last name of the credit card holder.
• 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.
• RenewalCreditCardFlag: boolean
  Maximum Length: 1

  Indicates whether the credit card is used as Renewal Payment Method.
• 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.
• TrxnExtensionId: integer (int64)
  Transaction Extension Id
• VoiceAuthCode: string
  The credit card voice authorization information.

{
    "type":"object",
    "properties":{
        "InstrAssignmentId":{
            "title":"Number",
            "type":"integer",
            "description":"The instrument assignment ID associated with the credit card.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "CreditCardPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the credit card.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "FirstName":{
            "type":"string",
            "description":"The first name of the credit card holder.",
            "nullable":true,
            "x-queryable":false
        },
        "MaskedNumber":{
            "type":"string",
            "description":"The masked credit card number.",
            "nullable":true,
            "x-queryable":false
        },
        "IssuerCode":{
            "type":"string",
            "description":"The credit card issuing company.",
            "nullable":true,
            "x-queryable":false
        },
        "PaymentSystemOrderNumber":{
            "type":"string",
            "description":"The order number for the credit card payment.",
            "nullable":true,
            "x-queryable":false
        },
        "CardHolderName":{
            "title":"Cardholder Name",
            "type":"string",
            "description":"The name of the credit card holder.",
            "nullable":true
        },
        "AddToBillingAccountFlag":{
            "type":"boolean",
            "description":"Indicates whether the party can be added as a billing account.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "precision":18
            }
        },
        "ExpirationDate":{
            "type":"string",
            "description":"The credit card expiration date used for processing.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "TrxnExtensionId":{
            "type":"integer",
            "description":"Transaction Extension Id",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "VoiceAuthCode":{
            "type":"string",
            "description":"The credit card voice authorization information.",
            "nullable":true,
            "x-queryable":false
        },
        "AuthRequestId":{
            "type":"string",
            "description":"The card authorization request identifier.",
            "nullable":true,
            "x-queryable":false
        },
        "AuthorizedAmount":{
            "type":"number",
            "description":"The amount the transaction was authorized for.",
            "nullable":true,
            "x-queryable":false
        },
        "LastName":{
            "type":"string",
            "description":"The last name of the credit card holder.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The public unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "precision":18
            }
        },
        "RenewalCreditCardFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the credit card is used as Renewal Payment Method.",
            "nullable":true
        },
        "TokenNumber":{
            "type":"string",
            "description":"The credit card token number used for processing.",
            "nullable":true,
            "x-queryable":false
        },
        "Notes":{
            "title":"Notes",
            "maxLength":300,
            "type":"string",
            "description":"The notes, if any, associated with the credit card.",
            "nullable":true
        }
    }
}

Nested Schema : subscriptionProducts-flexFields-item-patch-request

Type: object

Show Source

• __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.
• SubscriptionProductId: integer (int64)
  The unique identifier of the subscription product.

{
    "type":"object",
    "properties":{
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"The display name for structure definition of the user descriptive flexfield.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"The structure definition of the user descriptive flexfield.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Nested Schema : subscriptionProducts-negotiatedEntitlementPlanCommitments-item-patch-request

Type: object

Show Source

• 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)
  Title: Balance Code

  The unique identifier of balance code under subscription entitlement plan commitments.
• BalanceCodeType: string
  Title: Balance Code Type

  Maximum Length: 30

  The balance code type of the commitment rating model setup for the product.
• 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.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 15

  The currency code of amount type balance code under subscription entitlement plan commitments.
• EntitlementPlanId: integer (int64)
  The unique identifier of subscription entitlement plan.
• 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.

{
    "type":"object",
    "properties":{
        "RelatedPeriod":{
            "title":"Related Charge Periodicity",
            "type":"string",
            "description":"The related period of the related charge. Indicates the related charge name from which the estimates or commitments are granted.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "sortable":false
            }
        },
        "UnitOfMeasure":{
            "title":"UOM",
            "maxLength":3,
            "type":"string",
            "description":"The unit of measure of allowance under subscription entitlement plan commitments.",
            "nullable":true
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount under subscription entitlement plan commitments.",
            "nullable":true
        },
        "Period":{
            "title":"Periodicity",
            "type":"string",
            "description":"The period under subscription entitlement plan commitments.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity under subscription entitlement plan commitments.",
            "nullable":true
        },
        "ChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The charge definition code under subscription entitlement plan commitments.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BalanceCode":{
            "title":"Balance Code",
            "maxLength":30,
            "type":"string",
            "description":"The balance code of subscription entitlement plan commitments.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "RoundedQuantity":{
            "title":"Rounded Quantity",
            "type":"number",
            "description":"The rounded quantity under subscription entitlement plan commitments.",
            "nullable":true
        },
        "EntitlementPlanId":{
            "type":"integer",
            "description":"The unique identifier of subscription entitlement plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The currency code of amount type balance code under subscription entitlement plan commitments.",
            "nullable":true
        },
        "BalanceCodeId":{
            "title":"Balance Code",
            "type":"integer",
            "description":"The unique identifier of balance code under subscription entitlement plan commitments.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeDefinitionId":{
            "type":"integer",
            "description":"The unique identifier for charge definition under subscription entitlement plan commitments.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RelatedChargeDefinitionId":{
            "type":"integer",
            "description":"The unique identifier of charge definition of the related charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RelatedChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The charge definition code of the related charge identifier.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BalanceCodeType":{
            "title":"Balance Code Type",
            "maxLength":30,
            "type":"string",
            "description":"The balance code type of the commitment rating model setup for the product.",
            "nullable":true
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The subscription product identifier of subscription entitlement plan commitments.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : subscriptionProducts-negotiatedEntitlementPlanDetails-item-patch-request

Type: object

Show Source

• 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.
• BalanceCodeId: integer (int64)
  Title: Balance Code

  The unique identifier of balance code under subscription entitlement plan details.
• BalanceCodeType: string
  Title: Balance Code Type

  Maximum Length: 30

  The balance code type of the allowance rating model setup for the product.
• 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.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The currency code associated with the balance code of amount type of a negotiated entitlement plan.
• EntitlementPlanId: integer (int64)
  The unique identifier of subscription entitlement plan.
• ObjectVersionNumber: integer (int32)
  The version number of subscription entitlement plan details.
• SubscriptionProductId: integer (int64)
  The subscription product identifier of subscription entitlement plan details.

{
    "type":"object",
    "properties":{
        "AllowancePeriodicity":{
            "title":"Periodicity",
            "maxLength":30,
            "type":"string",
            "description":"The periodicity factor of allowance under subscription entitlement plan details.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AllowanceRolloverPeriodUnitOfMeasure":{
            "title":"Rollover Period UOM",
            "maxLength":3,
            "type":"string",
            "description":"The unit of measure of allowance rollover under subscription entitlement plan details.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount negotiated for an entitlement plan.",
            "nullable":true
        },
        "AllowanceValidityPeriodUnitOfMeasure":{
            "title":"Validity Period UOM",
            "maxLength":3,
            "type":"string",
            "description":"The unit of measure of allowance validity under subscription entitlement plan details.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for charge definition under subscription entitlement plan details.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "BalanceCode":{
            "title":"Balance Code",
            "maxLength":30,
            "type":"string",
            "description":"The balance code of subscription entitlement plan details.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "AllowanceQuantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The allowance quantity under subscription entitlement plan details.",
            "nullable":true
        },
        "EntitlementPlanId":{
            "type":"integer",
            "description":"The unique identifier of subscription entitlement plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the balance code of amount type of a negotiated entitlement plan.",
            "nullable":true
        },
        "BalanceCodeId":{
            "title":"Balance Code",
            "type":"integer",
            "description":"The unique identifier of balance code under subscription entitlement plan details.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AllowanceUnitOfMeasure":{
            "title":"UOM",
            "maxLength":3,
            "type":"string",
            "description":"The unit of measure of allowance specified for a negotiated entitlement plan.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The version number of subscription entitlement plan details.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "ChargeDefinitionId":{
            "type":"integer",
            "description":"The charge definition code under subscription entitlement plan details.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "BalanceCodeType":{
            "title":"Balance Code Type",
            "maxLength":30,
            "type":"string",
            "description":"The balance code type of the allowance rating model setup for the product.",
            "nullable":true
        },
        "AllowanceValidityPeriod":{
            "title":"Validity Period",
            "type":"integer",
            "description":"The allowance validity period under subscription entitlement plan details.",
            "nullable":true
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The subscription product identifier of subscription entitlement plan details.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AllowanceRolloverPeriod":{
            "title":"Rollover Period",
            "type":"integer",
            "description":"The allowance rollover period under subscription entitlement plan details.",
            "nullable":true
        }
    }
}

Nested Schema : subscriptionProducts-negotiatedEntitlementPlanEstimates-item-patch-request

Type: object

Show Source

• 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)
  Title: Balance Code

  The unique identifier of balance code under subscription entitlement plan estimates.
• BalanceCodeType: string
  Title: Balance Code Type

  Maximum Length: 30

  The balance code type of the estimate rating model setup for the product.
• 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.
• 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.
• EntitlementPlanId: integer (int64)
  The unique identifier of subscription entitlement plan.
• 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.

{
    "type":"object",
    "properties":{
        "TrueupShortageFlag":{
            "title":"True-up shortage",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the flag of the subscription entitlement plan estimates is trueup shortage.",
            "nullable":true,
            "default":true
        },
        "RelatedPeriod":{
            "title":"Related Charge Periodicity",
            "type":"string",
            "description":"The related period of the related charge. Indicates the related charge name from which the estimates or commitments are granted.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "sortable":false
            }
        },
        "RolloverPeriod":{
            "title":"Rollover Period",
            "type":"integer",
            "description":"The rollover period of the subscription entitlement plan estimate.",
            "nullable":true
        },
        "EnableRolloverFlag":{
            "title":"Enable rollover",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates where the rollover is enabled for the subscription entitlement plan estimate.",
            "nullable":true,
            "default":false
        },
        "UnitOfMeasure":{
            "title":"UOM",
            "maxLength":3,
            "type":"string",
            "description":"The unit of measure under subscription entitlement plan estimates.",
            "nullable":true
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount under subscription entitlement plan estimates.",
            "nullable":true
        },
        "Period":{
            "title":"Periodicity",
            "type":"string",
            "description":"The period under subscription entitlement plan estimates.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity under subscription entitlement plan estimates.",
            "nullable":true
        },
        "ChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The charge definition code under subscription entitlement plan estimates.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RolloverPeriodUnitOfMeasure":{
            "title":"Rollover Period UOM",
            "maxLength":3,
            "type":"string",
            "description":"The rollover period unit of measure of the subscription entitlement plan estimate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BalanceCode":{
            "title":"Balance Code",
            "maxLength":30,
            "type":"string",
            "description":"The balance code of subscription entitlement plan estimates.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "RoundedQuantity":{
            "title":"Rounded Quantity",
            "type":"number",
            "description":"The rounded quantity under subscription entitlement plan estimates.",
            "nullable":true
        },
        "EntitlementPlanId":{
            "type":"integer",
            "description":"The unique identifier of subscription entitlement plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The currency code of amount type balance code under subscription entitlement plan estimates.",
            "nullable":true
        },
        "BalanceCodeId":{
            "title":"Balance Code",
            "type":"integer",
            "description":"The unique identifier of balance code under subscription entitlement plan estimates.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeDefinitionId":{
            "type":"integer",
            "description":"The unique identifier for charge definition under subscription entitlement plan estimates.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RelatedChargeDefinitionId":{
            "type":"integer",
            "description":"The unique identifier of charge definition of the related charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RelatedChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The charge definition code of the related charge identifier.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BalanceCodeType":{
            "title":"Balance Code Type",
            "maxLength":30,
            "type":"string",
            "description":"The balance code type of the estimate rating model setup for the product.",
            "nullable":true
        },
        "TrueupOverageFlag":{
            "title":"True-up overage",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the flag of the subscription entitlement plan estimates is overage shortage.",
            "nullable":true,
            "default":true
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The subscription product identifier of subscription entitlement plan estimates.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChargePeriod":{
            "title":"Estimate Period",
            "type":"string",
            "description":"The estimate period of the subscription entitlement plan estimates.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "sortable":false
            }
        }
    }
}

Nested Schema : subscriptionProducts-negotiatedVolumePricingRules-item-patch-request

Type: object

Show Source

• AggregationBalanceCode: string
  Title: Aggregation Balance Code

  Maximum Length: 30

  The balance code which is eligible for aggregation rating.
• AggregationBalanceCodeId: integer (int64)
  Title: Aggregation Balance Code ID

  The unique identifier of the balance code which is eligible for aggregation rating.
• AggregationPeriod: string
  Title: Aggregation Period

  Maximum Length: 30

  The charge period of balance code for volume rating.
• BalanceCode: string
  Title: Balance Code

  Maximum Length: 30

  The unique identifier of the balance code which is eligible for volume rating.
• BalanceCodeId: integer (int64)
  The balance code which is eligible for volume rating.
• BalanceCodeUnitOfMeasure: string
  Title: UOM

  Maximum Length: 3

  The unit of measure of balance code for volume rating
• BalanceProfileId: integer (int64)
  Title: Balance Profile ID

  The unique identifier of the subscription balance profile.
• ChargeDefinitionCode: string
  Maximum Length: 30

  The charge definition code of the entitlement plan detail charge definition.
• ChargeDefinitionId: integer (int64)
  Title: Charge Definition ID

  The unique identifier of charge definition of the subscription entitlement plan commitments.
• EligibilityBalanceCodeId: integer (int64)
  Title: Eligible Balance Code ID

  The unique identifier of the balance code which is eligible for volume rating.
• EntitlementPlanChargeRuleId: integer (int64)
  Title: Profile Charge Rule ID

  The unique identifier of the subscription entitlement plan charge rule.
• EntitlementPlanChargeRuleNumber: string
  Title: Charge Rule Number

  Maximum Length: 120

  The unique number of the subscription entitlement plan charge rule.
• EntitlementPlanId: integer (int64)
  Title: Entitlement Plan ID

  The unique identifier of entitlement plan of the subscription entitlement plan.
• ObjectVersionNumber: integer (int32)
  Title: Object Version Number

  The version number of the subscription entitlement plan commitments.
• PricingBalanceCode: string
  Title: Pricing Balance Code

  Maximum Length: 30

  The balance code which is eligible for volume rating.
• ProductEntitlementPlanId: integer (int64)
  Title: Product Entitlement Plan ID

  The unique identifier of entitlement plan product of the subscription entitlement plan.
• SubscriptionProductId: integer (int64)
  Title: Subscription Product ID

  The unique identifier of subscription product.
• VolumePricingAggregationFlag: boolean
  Title: Eligible for aggregation

  Maximum Length: 1

  Indicates whether the balance code is enabled for aggregation of volume pricing.
• VolumePricingEligibilityFlag: boolean
  Title: Eligible for volume pricing

  Maximum Length: 1

  Indicates whether the balance code is eligibile for volume pricing.

{
    "type":"object",
    "properties":{
        "AggregationPeriod":{
            "title":"Aggregation Period",
            "maxLength":30,
            "type":"string",
            "description":"The  charge period of balance code for volume rating.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BalanceCodeUnitOfMeasure":{
            "title":"UOM",
            "maxLength":3,
            "type":"string",
            "description":"The  unit of measure of balance code for volume rating",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AggregationBalanceCodeId":{
            "title":"Aggregation Balance Code ID",
            "type":"integer",
            "description":"The unique identifier of the balance code which is eligible for aggregation rating.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "VolumePricingAggregationFlag"
                ]
            }
        },
        "ProductEntitlementPlanId":{
            "title":"Product Entitlement Plan ID",
            "type":"integer",
            "description":"The unique identifier of entitlement plan product of the subscription entitlement plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The charge definition code of the entitlement plan detail charge definition.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PricingBalanceCode":{
            "title":"Pricing Balance Code",
            "maxLength":30,
            "type":"string",
            "description":"The balance code which is eligible for volume rating.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "BalanceCode":{
            "title":"Balance Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the balance code which is eligible for volume rating.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "EntitlementPlanId":{
            "title":"Entitlement Plan ID",
            "type":"integer",
            "description":"The unique identifier of entitlement plan of the subscription entitlement plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AggregationBalanceCode":{
            "title":"Aggregation Balance Code",
            "maxLength":30,
            "type":"string",
            "description":"The balance code which is eligible for aggregation rating.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "BalanceProfileId":{
            "title":"Balance Profile ID",
            "type":"integer",
            "description":"The unique identifier of the subscription balance profile.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "BalanceCodeId":{
            "type":"integer",
            "description":"The balance code which is eligible for volume rating.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "ChargeDefinitionId"
                ]
            }
        },
        "VolumePricingEligibilityFlag":{
            "title":"Eligible for volume pricing",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the balance code is eligibile for volume pricing.",
            "nullable":true
        },
        "VolumePricingAggregationFlag":{
            "title":"Eligible for aggregation",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the balance code is enabled for aggregation of volume pricing.",
            "nullable":true
        },
        "EligibilityBalanceCodeId":{
            "title":"Eligible Balance Code ID",
            "type":"integer",
            "description":"The unique identifier of the balance code which is eligible for volume rating.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "VolumePricingEligibilityFlag"
                ]
            }
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The version number of the subscription entitlement plan commitments.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "EntitlementPlanChargeRuleId":{
            "title":"Profile Charge Rule ID",
            "type":"integer",
            "description":"The unique identifier of the subscription entitlement plan charge rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeDefinitionId":{
            "title":"Charge Definition ID",
            "type":"integer",
            "description":"The unique identifier of charge definition of the subscription entitlement plan commitments.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EntitlementPlanChargeRuleNumber":{
            "title":"Charge Rule Number",
            "maxLength":120,
            "type":"string",
            "description":"The unique number of the subscription entitlement plan charge rule.",
            "nullable":true
        },
        "SubscriptionProductId":{
            "title":"Subscription Product ID",
            "type":"integer",
            "description":"The unique identifier of subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : subscriptionProducts-productRelationships-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : subscriptionProducts-relationships-item-patch-request

Type: object

Show Source

• OperationLinksPuid: string
  Title: Operation Links PUID

  Maximum Length: 120

  The public unique identifier of the operation links.
• SourceAssetKey: string
  Title: Source Asset Key

  Maximum Length: 120

  The source asset key
• SourceProdAssociationId: integer (int64)
  Title: Source Product Association ID

  The unique identifier of the source product association.
• SourceProdAssociationPuid: string
  Title: Source Product Association PUID

  Maximum Length: 120

  The public unique identifier of the source product association.
• SourceProductPuid: string
  Title: Source Product PUID

  Maximum Length: 120

  The public unique identifier of the source product.
• SourceRootAssetKey: string
  Title: Source Root Asset Key

  Maximum Length: 120

  The source root asset key
• TargetProdAssociationId: integer (int64)
  Title: Target Product Association ID

  The unique identifier of the target product association.
• TargetProdAssociationPuid: string
  Title: Target Product Association PUID

  Maximum Length: 120

  The public unique identifier of the target product association.
• TargetProductPuid: string
  Title: Target Product PUID

  Maximum Length: 120

  The public unique identifier of the target product.

{
    "type":"object",
    "properties":{
        "OperationLinksPuid":{
            "title":"Operation Links PUID",
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the operation links.",
            "nullable":true
        },
        "SourceProdAssociationId":{
            "title":"Source Product Association ID",
            "type":"integer",
            "description":"The unique identifier of the source product association.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TargetProdAssociationId":{
            "title":"Target Product Association ID",
            "type":"integer",
            "description":"The unique identifier of the target product association.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SourceAssetKey":{
            "title":"Source Asset Key",
            "maxLength":120,
            "type":"string",
            "description":"The source asset key",
            "nullable":true
        },
        "SourceProductPuid":{
            "title":"Source Product PUID",
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the source product.",
            "nullable":true
        },
        "SourceRootAssetKey":{
            "title":"Source Root Asset Key",
            "maxLength":120,
            "type":"string",
            "description":"The source root asset key",
            "nullable":true
        },
        "SourceProdAssociationPuid":{
            "title":"Source Product Association PUID",
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the source product association.",
            "nullable":true
        },
        "TargetProductPuid":{
            "title":"Target Product PUID",
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the target product.",
            "nullable":true
        },
        "TargetProdAssociationPuid":{
            "title":"Target Product Association PUID",
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the target product association.",
            "nullable":true
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• EndDate: string (date)
  Title: End Date

  The date when the sales credit was ends.
• Percentage: number
  Title: Percent

  The percentage
• SalesCreditId: integer (int64)
  The unique identifier of the sales credit.
• SalesCreditPuid: string
  Title: Number

  Maximum Length: 120

  The public unique identifier of the sales credit.
• SalesCreditTypeId: integer (int64)
  Title: Credit Type

  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)
  Title: Salesperson

  The unique identifier of the sales representative.
• StartDate: string (date)
  Title: Start Date

  The date when the sales credit started.
• SubscriptionId: integer (int64)
  The unique identifier of the subscription.
• SubscriptionProductId: integer (int64)
  Title: Subscription Product ID

  The unique identifier of the subscription product.

{
    "type":"object",
    "properties":{
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the sales credit started.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.subscriptions.subscriptionManagement.subscriptionService.view.SubscriptionsVO",
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"SubscriptionNumber",
                "fnd:FND_AUDIT_FK_VIEWOBJECT_QRY_FORCEEXEC":"true",
                "fnd:FND_AUDIT_FK_WHEREATTR":"SubscriptionId"
            }
        },
        "Percentage":{
            "title":"Percent",
            "type":"number",
            "description":"The percentage",
            "nullable":false,
            "x-hints":{
                "precision":5,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "scale":2
            }
        },
        "SalesPerson":{
            "type":"string",
            "description":"The name of the sales person.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "SalesCreditPuid":{
            "title":"Number",
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the sales credit.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_FORCE_WRITE":"true",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "SalesCreditTypeId":{
            "title":"Credit Type",
            "type":"integer",
            "description":"The unique identifier of the type of the sales credit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"choice",
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.subscriptions.subscriptionManagement.model.view.SalesCreditTypeVO",
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"Name",
                "fnd:FND_AUDIT_FK_VIEWOBJECT_QRY_FORCEEXEC":"true",
                "fnd:FND_AUDIT_FK_WHEREATTR":"SalesCreditTypeId"
            }
        },
        "SalesrepId":{
            "title":"Salesperson",
            "type":"integer",
            "description":"The unique identifier of the sales representative.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.subscriptions.subscriptionManagement.model.view.AllSalesrepVO",
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"PartyName",
                "fnd:FND_AUDIT_FK_VIEWOBJECT_QRY_FORCEEXEC":"true",
                "fnd:FND_AUDIT_FK_WHEREATTR":"ResourceSalesrepId"
            }
        },
        "SalesPersonNumber":{
            "title":"Salesperson Number",
            "type":"string",
            "description":"The alternate identifier of a salesperson.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "sortable":false
            }
        },
        "SubscriptionProductId":{
            "title":"Subscription Product ID",
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.subscriptions.subscriptionManagement.subscriptionService.view.ProductsVO",
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"LineNumber",
                "fnd:FND_AUDIT_FK_VIEWOBJECT_QRY_FORCEEXEC":"true",
                "fnd:FND_AUDIT_FK_WHEREATTR":"SubscriptionProductId"
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the sales credit was ends.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "SalesCreditId":{
            "type":"integer",
            "description":"The unique identifier of the sales credit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• 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.
• 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
  Title: Service Identifier

  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.

{
    "type":"object",
    "properties":{
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the service resource.",
            "format":"date",
            "nullable":true
        },
        "ServiceResourcePuid":{
            "title":"Service Identifier",
            "maxLength":120,
            "type":"string",
            "description":"The PUID of the service resource.",
            "nullable":false
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ServiceResourceId":{
            "type":"integer",
            "description":"The unique identifier of the service resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EnabledFlag":{
            "title":"Enable Service Resource",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the service resource is enabled or not.",
            "nullable":true,
            "default":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date of the service resource.",
            "format":"date",
            "nullable":true
        },
        "ServiceId":{
            "title":"Service Identifier",
            "maxLength":120,
            "type":"string",
            "description":"The unique identifier of the service.",
            "nullable":false
        }
    }
}

Nested Schema : subscriptionProducts-smartActions-item-patch-request

Type: object

Show Source

• ActionIntent: string (byte)
  Title: Action Intent

  The JSON object that describes what an action does and what context data can be passed to the action.
• ConfirmationMessage: string
  Title: Confirmation Message

  Maximum Length: 4000

  A message seeking confirmation for the action being performed.
• ContentType: string
  Title: Content Type

  Maximum Length: 50

  The content type used when invoking the REST endpoint.
• DisplayLabel: string
  Title: Action Name

  Maximum Length: 256

  The display label of the subscription smart actions.
• Entity: string
  Title: Parent Entity

  Maximum Length: 150

  The entity of the subscription smart actions.
• Href: string
  Title: REST Endpoint

  Maximum Length: 1024

  The HREF of the subscription smart actions.
• IncludedInApplication: string
  Title: Included in Application

  Maximum Length: 512

  The included in application flag of the subscription smart actions.
• MassActionFlag: boolean
  Title: Mass Action

  Maximum Length: 1

  The mass action flag of the smart action.
• Method: string
  Title: HTTP Method

  Maximum Length: 15

  The method associated with the subscription smart actions.
• ObjectFunctionName: string
  Title: Object Function

  Maximum Length: 64

  The object function name of the smart action.
• PageType: string
  Title: Page Type

  Maximum Length: 256

  The page type of the smart action.
• SmartSuggestFlag: boolean
  Title: Smart Suggest

  Maximum Length: 1

  The smart suggest flag of the smart action.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  The flag indicating if the action is seeded or custom.
• UpdateOfAttributes: string
  Title: Attributes to Update

  Maximum Length: 512

  The update of attributes flag of the subscription smart actions.
• UserActionNavigation: array Smart Action User Interface Definitions
  Title: Smart Action User Interface Definitions

  UI navigation metadata striped by app usage.
• UserActionRank: integer (int64)
  Title: Priority

  The user rank action of the smart action.
• UserActionRequestPayload: array Smart Action REST Payload Definitions
  Title: Smart Action REST Payload Definitions

  If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
• UserActionURLBinding: array Smart Action User Interface Definitions
  Title: Smart Action User Interface Definitions

  Binding metadata for a variable in the URL.

{
    "type":"object",
    "properties":{
        "SmartSuggestFlag":{
            "title":"Smart Suggest",
            "maxLength":1,
            "type":"boolean",
            "description":"The smart suggest flag of the smart action.",
            "nullable":true
        },
        "Entity":{
            "title":"Parent Entity",
            "maxLength":150,
            "type":"string",
            "description":"The entity of the subscription smart actions.",
            "nullable":true
        },
        "ContentType":{
            "title":"Content Type",
            "maxLength":50,
            "type":"string",
            "description":"The content type used when invoking the REST endpoint.",
            "nullable":true
        },
        "UserActionURLBinding":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"Binding metadata for a variable in the URL.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-smartActions-UserActionURLBinding-item-patch-request"
            }
        },
        "MassActionFlag":{
            "title":"Mass Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The mass action flag of the smart action.",
            "nullable":true
        },
        "IncludedInApplication":{
            "title":"Included in Application",
            "maxLength":512,
            "type":"string",
            "description":"The included in application flag of the subscription smart actions.",
            "nullable":true
        },
        "UserActionNavigation":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"UI navigation metadata striped by app usage.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-smartActions-UserActionNavigation-item-patch-request"
            }
        },
        "Href":{
            "title":"REST Endpoint",
            "maxLength":1024,
            "type":"string",
            "description":"The HREF of the subscription smart actions.",
            "nullable":true
        },
        "Method":{
            "title":"HTTP Method",
            "maxLength":15,
            "type":"string",
            "description":"The method associated with the subscription smart actions.",
            "nullable":true
        },
        "DisplayLabel":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"The display label of the subscription smart actions.",
            "nullable":false
        },
        "UserActionRank":{
            "title":"Priority",
            "type":"integer",
            "description":"The user rank action of the smart action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The flag indicating if the action is seeded or custom.",
            "nullable":true
        },
        "ConfirmationMessage":{
            "title":"Confirmation Message",
            "maxLength":4000,
            "type":"string",
            "description":"A message seeking confirmation for the action being performed.",
            "nullable":true
        },
        "UserActionRequestPayload":{
            "title":"Smart Action REST Payload Definitions",
            "type":"array",
            "description":"If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-smartActions-UserActionRequestPayload-item-patch-request"
            }
        },
        "UpdateOfAttributes":{
            "title":"Attributes to Update",
            "maxLength":512,
            "type":"string",
            "description":"The update of attributes flag of the subscription smart actions.",
            "nullable":true
        },
        "ActionIntent":{
            "title":"Action Intent",
            "type":"string",
            "description":"The JSON object that describes what an action does and what context data can be passed to the action.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectFunctionName":{
            "title":"Object Function",
            "maxLength":64,
            "type":"string",
            "description":"The object function name of the smart action.",
            "nullable":true
        },
        "PageType":{
            "title":"Page Type",
            "maxLength":256,
            "type":"string",
            "description":"The page type of the smart action.",
            "nullable":true
        }
    }
}

Nested Schema : Smart Action User Interface Definitions

Type: array

Title: Smart Action User Interface Definitions

UI navigation metadata striped by app usage.

Show Source

• Array of: object subscriptionProducts-smartActions-UserActionNavigation-item-patch-request

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"UI navigation metadata striped by app usage.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-smartActions-UserActionNavigation-item-patch-request"
    }
}

Nested Schema : Smart Action REST Payload Definitions

Type: array

Title: Smart Action REST Payload Definitions

If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.

Show Source

• Array of: object subscriptionProducts-smartActions-UserActionRequestPayload-item-patch-request

{
    "title":"Smart Action REST Payload Definitions",
    "type":"array",
    "description":"If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-smartActions-UserActionRequestPayload-item-patch-request"
    }
}

Nested Schema : Smart Action User Interface Definitions

Type: array

Title: Smart Action User Interface Definitions

Binding metadata for a variable in the URL.

Show Source

• Array of: object subscriptionProducts-smartActions-UserActionURLBinding-item-patch-request

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"Binding metadata for a variable in the URL.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-smartActions-UserActionURLBinding-item-patch-request"
    }
}

Nested Schema : subscriptionProducts-smartActions-UserActionNavigation-item-patch-request

Type: object

Show Source

• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  The system action flag of the user action navigation.
• UserActionNavAppUsage: string
  Title: Application Usage

  Maximum Length: 50

  The user action navigation application usage.
• UserActionNavBody: string
  Title: Navigation Metadata

  Maximum Length: 1000

  The body of user action navigation.
• UserActionNavType: string
  Title: Navigation Type

  Maximum Length: 100

  The type of user action navigation.

{
    "type":"object",
    "properties":{
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The system action flag of the user action navigation.",
            "nullable":true,
            "default":false
        },
        "UserActionNavType":{
            "title":"Navigation Type",
            "maxLength":100,
            "type":"string",
            "description":"The type of user action navigation.",
            "nullable":false
        },
        "UserActionNavBody":{
            "title":"Navigation Metadata",
            "maxLength":1000,
            "type":"string",
            "description":"The body of user action navigation.",
            "nullable":true
        },
        "UserActionNavAppUsage":{
            "title":"Application Usage",
            "maxLength":50,
            "type":"string",
            "description":"The user action navigation application usage.",
            "nullable":false
        }
    }
}

Nested Schema : subscriptionProducts-smartActions-UserActionRequestPayload-item-patch-request

Type: object

Show Source

• Binding: string
  Title: Payload Value Binding Type

  Maximum Length: 64

  The binding of the user action payload.
• MandatoryFlag: boolean
  Title: Mandatory

  Maximum Length: 1

  The mandatory flag of the user action payload.
• RequestPayloadName: string
  Title: Request Payload Attribute Name

  Maximum Length: 256

  The request payload name of the user action.
• SmartSuggestPath: string
  Title: Smart Suggest Path

  Maximum Length: 2048

  The smart suggest path of the user action payload.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  The system action flag of the user action request payload.
• Value: string
  Title: Request Payload Attribute Value

  Maximum Length: 1000

  The value of the user action payload.
• ValueStruct: string
  Title: Payload Value Structure

  Maximum Length: 20

  The value structure of the user action payload.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"Payload Value Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"The binding of the user action payload.",
            "nullable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The system action flag of the user action request payload.",
            "nullable":true,
            "default":false
        },
        "ValueStruct":{
            "title":"Payload Value Structure",
            "maxLength":20,
            "type":"string",
            "description":"The value structure of the user action payload.",
            "nullable":true
        },
        "Value":{
            "title":"Request Payload Attribute Value",
            "maxLength":1000,
            "type":"string",
            "description":"The value of the user action payload.",
            "nullable":true
        },
        "SmartSuggestPath":{
            "title":"Smart Suggest Path",
            "maxLength":2048,
            "type":"string",
            "description":"The smart suggest path of the user action payload.",
            "nullable":true
        },
        "RequestPayloadName":{
            "title":"Request Payload Attribute Name",
            "maxLength":256,
            "type":"string",
            "description":"The request payload name of the user action.",
            "nullable":false
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":1,
            "type":"boolean",
            "description":"The mandatory flag of the user action payload.",
            "nullable":true
        }
    }
}

Nested Schema : subscriptionProducts-smartActions-UserActionURLBinding-item-patch-request

Type: object

Show Source

• Binding: string
  Title: URL Binding Type

  Maximum Length: 64

  The URL binding of user action.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  The system action flag of the user action URL binding.
• URLBindingName: string
  Title: URL Binding Parameter Name

  Maximum Length: 256

  The name of URL binding of user action.
• Value: string
  Title: URL Binding Parameter Value

  Maximum Length: 1000

  The value of URL binding of user action.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"URL Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"The URL binding of user action.",
            "nullable":true
        },
        "Value":{
            "title":"URL Binding Parameter Value",
            "maxLength":1000,
            "type":"string",
            "description":"The value of URL binding of user action.",
            "nullable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The system action flag of the user action URL binding.",
            "nullable":true,
            "default":false
        },
        "URLBindingName":{
            "title":"URL Binding Parameter Name",
            "maxLength":256,
            "type":"string",
            "description":"The name of URL binding of user action.",
            "nullable":false
        }
    }
}

Back to Top

Response

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.

Body ()

Root Schema : subscriptionProducts-item-response

Type: object

Show Source

• AccountingRuleId: integer (int64)
  Title: Accounting Rule ID

  The unique identifier of the accounting rule.
• AccountingRuleName: string
  Title: Accounting Rule

  The name of the accounting rule.
• AlignBillingDay: number
  Title: Align Billing Day

  The day part of the align billing from the date of a subscription product.
• AlignBillingFrom: string (date)
  Title: Align Billing From

  The from date of the billing alignment.
• AllowanceGrantFlag: string
  Indicates whether allowance type of plan is associated with the product.
• 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.
• AmendSourceProductPuid: string
  Title: Amended Subscription Product PUID

  Maximum Length: 255

  Amend Source Product Puid
• 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.
• AsyncFlag: boolean
  Read Only: true

  Indicates whether the subscription product will undergo asynchronous process for operations such as duplicate, generate billing schedule etc.
• AutoExtendFlag: boolean
  Indicates if the product should be auto extended.
• BalanceManagementError: string
  Title: Balance Management Error

  Maximum Length: 2000

  The balance management error.
• BalanceProfileName: string
  Title: Profile Name

  The name of the balance profile associated with the product.
• BalanceRegisterId: integer (int64)
  Title: Balance Register ID

  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.
• BatchTag: string
  Title: Batch Tag

  Maximum Length: 30

  Batch Tag
• 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: Account Id

  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 ID

  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
  Title: Bill-to Contact Number

  The bill-to contact number of the subscription product.
• BillToPartyId: integer (int64)
  Title: Bill-to Party ID

  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
  Title: Bill-to Party Number

  Read Only: true

  Maximum Length: 30

  The bill-to customer number of the subscription product.
• BillToSite: string
  Title: Bill-to Site

  Bill To Site
• BillToSiteName: string
  Title: Bill-to Site

  Maximum Length: 255

  The bill-to site name of the subscription product.
• BillToSiteNumber: string
  Title: Bill-to Site Number

  The bill-to site number of the subscription product.
• BillToSiteUseId: integer (int64)
  Title: Site Use Id

  The unique identifier of the bill-to site use.
• CalculatedCreditAmount: number
  Title: Calculated Credit Amount

  The calculated credit amount of the subscription product.
• CalculateEstimatedTaxFlag: boolean
  Indicates whether estimated tax will be calculated for 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.
• ChargeRulesFlag: string
  Title: Charge Rules

  Indicates whether volume pricing rule is associated with the product.
• 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.
• CheckActiveExpiredAssetsExists: string
  Indicates whether any underlying assets are active or expired for the subscription product.
• CheckHoldAssetsExists: string
  Indicates whether any underlying assets are on hold for the subscription product.
• ChurnPredictionTrend: integer (int32)
  Title: Churn Prediction Trend

  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.
• CommitmentFlag: string
  Indicates whether commitment type of plan is associated with the product.
• CorpCurrencyCode: string
  Title: Currency Code

  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)
  Title: Coverage Schedule ID

  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)
  Title: Creation Date

  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.
• CreditType: string
  Title: Credit Type

  Maximum Length: 30

  Indicates the type of credit to be issued to the customer on close and amend.
• CurcyConvRateType: string
  Title: Conversion Rate Type

  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.
• CustomerPONumber: string
  Title: Customer PO Number

  Maximum Length: 50

  The customer PO number reference of a subscription product.
• CustomerTrxTypeSequenceId: integer (int64)
  Title: Sequence

  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)
  Title: Inventory Organization

  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

  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.
• EnableAdvBipTemplateFlag: boolean
  Title: Enable Advanced Configuration

  Maximum Length: 1

  Default Value: false

  Indicates whether advanced BIP configuration for usage invoice templates is enabled.
• 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.
• EntitlementPlanDescription: string
  Title: Description

  The description of the entitlement plan associated with the product.
• EntitlementPlanId: integer (int64)
  Title: Entitlement Plan ID

  The ID of the entitlement plan associated with the product.
• EntitlementPlanName: string
  Title: Name

  The name 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.
• EstimateFlag: string
  Indicates whether estimate type of plan is associated with 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
  Title: External Asset Key

  Maximum Length: 120

  The external asset key
• ExternalParentAssetKey: string
  Title: External Parent Asset Key

  Maximum Length: 120

  The external parent asset key
• ExternalPriceListId: string
  Title: External Price List ID

  Maximum Length: 120

  The unique identifier of the external price list.
• ExternalRootAssetKey: string
  Title: External Root Asset Key

  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.
• GenBillSchReqdFlag: boolean
  Title: Billing schedule update required

  Maximum Length: 1

  Generate Bill Schedule Required Flag
• 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.
• GroupingRuleNumberUsed: string
  Title: Grouping Rule Number

  Maximum Length: 120

  Grouping Rule Number Used
• InflightFlag: boolean
  Title: Subscription In-Process

  Maximum Length: 1

  Indicates whether the subscription product is inflight or not.
• InterfaceOffsetDays: integer (int32)
  Title: Billing Interface Offset Days

  The number of days that the interface needs to be offset for.
• InventoryItemId: integer (int64)
  Title: Item ID

  The unique identifier of the inventory item.
• InvoiceBipReportCode: string
  Title: BIP Data Source

  Maximum Length: 30

  The code of the type of template to pick for the invoice report.
• InvoicedAmount: number
  Title: Invoiced Amount

  The amount specified in the invoice.
• InvoiceText: string
  Title: Invoice Text

  Maximum Length: 4000

  The text in the billing invoice.
• InvoicingRuleId: integer (int64)
  Title: Invoicing Rule Id

  The unique identifier of the invoicing rule.
• InvoicingRuleName: string
  Title: Invoicing Rule

  The name of the invoicing rule.
• IsProductCreatedFromAmendFlag: boolean
  Indicates whether subscription product is created from amend action.
• ItemUnitOfMeasure: string
  Title: Pricing UOM Code

  Maximum Length: 15

  The unit of measure used to measure the items.
• ItemUnitOfMeasureMeaning: string
  Title: Pricing UOM

  The display name of item unit of measure.
• LastLifecycleUpdateDate: string (date-time)
  Title: Last Lifecycle Update Date

  Last Lifecycle Update Date
• 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
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login details of the user who last updated the subscription product.
• LegacyRetrospectiveFlag: string
  Maximum Length: 1

  Indicates whether the product had legacy retrospective accounting.
• 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.
• MilestoneBasedChargeFlag: boolean
  Indicates whether the charge for the product is milestone based.
• 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.
• negotiatedVolumePricingRules: array Subscription Entitlement Pricing Rules
  Title: Subscription Entitlement Pricing Rules

  The subscription entitlement plan charge rules resource is used to view, create, update, and delete a negotiated entitlement plan charge rule which is used for the rating of a subscription product.
• NextBillStartDate: string (date)
  Title: Next Bill Start Date

  Next Bill Start Date
• NextPricingDate: string (date)
  Title: Next Pricing Date

  The date when the next pricing will occur.
• OrderFulfillLineId: integer (int64)
  Title: Order Fulfillment Line ID

  The ID of the sales order fulfillment line associated with the subscription product.
• OrderFulfillLineNumber: integer (int32)
  Title: Order Fulfillment Line Number

  The number of the sales order fulfillment line associated with the subscription product.
• OriginalSubscriptionProductPuid: string
  Read Only: true

  Maximum Length: 240

  The PUID of the original subscription product.
• OutputTaxClassification: string
  Title: Output Tax Class

  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 ID

  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)
  Title: Price List

  The unique identifier of the price list.
• PriceListName: string
  Title: Price List Name

  Maximum Length: 120

  The name of the price list.
• PriceTransactionOn: string (date)
  Title: Price Transaction on Date

  The date when the price transaction occurred.
• PricingError: string
  Maximum Length: 2000

  The pricing error associated with the product.
• PricingSystem: string
  The pricing system of 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.
• PrimaryPartyName: string
  Title: Customer

  Read Only: true

  Maximum Length: 255

  The primary party name 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.
• ProductChangeSequenceNumber: integer
  Read Only: true

  The sequence number of the subscription product change.
• ProductFiscClassification: string
  Title: Product Fiscal Classification

  Maximum Length: 30

  The product fiscal classification.
• ProductName: string
  Title: Product Name

  Maximum Length: 300

  The name of the product.
• productRelationships: array Product Relationships
  Title: Product Relationships

  The product relationships resource is used to view the relationship between a source and a target product. These relationships include amendment, renewal, suspension relationships.
• 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.
• QuoteId: integer (int64)
  Title: Quote Id

  The quote ID associated with the subscription product.
• QuoteLineId: integer (int64)
  Title: Quote Line ID

  The quote line ID associated with the subscription product.
• RatePlanDocument: string (byte)
  The JSON representing the rate plan.
• RatePlanDocumentId: integer (int64)
  The identifier of the rate plan document.
• RatePlanId: integer (int64)
  Title: Rate Plan ID

  The unique identifier of the rate plan.
• RatePlanName: string
  Title: Rate Plan

  The name of the rate plan.
• RatePlanNumber: string
  Title: Rate Plan Number

  The number of the rate plan.
• RatePlanYn: string
  Indicates whether pricing for the subscription product is based on 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.
• RelationShipExistFlag: string
  Indicates whether relationship exists for the 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.
• RenewalPriceListId: integer (int64)
  The identifier of the renewal price list.
• RenewalPriceListName: string
  Title: Renewal Price List

  Maximum Length: 255

  The name of the renewal price list.
• RenewalRatePlanId: integer (int64)
  The identifier of the renewal rate plan.
• RenewalRatePlanNumber: string
  The renewal rate plan number.
• RenewalSequenceNumber: integer
  Read Only: true

  The renewal sequence number.
• 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.
• RenewSourceProductPuid: string
  Title: Renewed Subscription Product PUID

  Maximum Length: 255

  Renew Source Product Puid
• 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)
  Title: Requested Entitlement Plan ID

  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.
• RequestedPriceListId: integer (int64)
  Title: Override Price List

  The identifier of the requested price list.
• RequestedProgramId: integer (int64)
  Title: Requested Preventive Maintenance Program ID

  Read Only: true

  The unique identifier of the requested preventive maintenance program.
• RequestedRatePlanId: integer (int64)
  Title: Requested Rate Plan ID

  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.
• RetainSubsOnRenewFlag: boolean
  Title: Don't Create New Renewal Subscription

  Maximum Length: 1

  Indicates whether the renewal should happen in the source subscription.
• RevenueOption: string
  Title: Revenue Accounting Option

  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)
  Title: Sales Order ID

  The ID of the sales order associated with the subscription product.
• SalesOrderLineId: integer (int64)
  Title: Sales Order Line ID

  The sales order line ID 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 ID

  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 ID

  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
  Title: Ship-to Contact Number

  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 ID

  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 Party Site ID

  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.
• smartActions: array Subscription Product User Actions
  Title: Subscription Product User Actions

  The smart actions resource stores the endpoint and security details for every user action.
• SourceKey: string
  Title: Source Key

  Maximum Length: 120

  The identifier of the product in the source system.
• SourceLineKey: string
  Title: Source Line Key

  Maximum Length: 120

  The source line key
• SourceLineNumber: string
  Title: External Source Line Number

  Maximum Length: 120

  The source line number
• SourceNumber: string
  Title: External Source Number

  Maximum Length: 120

  The alternate identifier of the product in the source system.
• SourceSystem: string
  Title: Source System

  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.
• SummarizedRatingFlag: boolean
  Title: Enable summarize rating

  Indicates whether the entitlement plan is associated with the product is eligibile for summarized rating.
• 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
  Title: Tax Error

  Maximum Length: 2000

  The tax error, if any, in the calculated amount.
• TaxExemptionHandling: string
  Title: Tax Exemption Handling

  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.
• UpdateFlag: boolean
  Indicates whether the subscription product is updated.
• UsageEventAllowanceInvTemplate: string
  Title: Allowance

  Maximum Length: 200

  The template to show the invoice data for allowance type of balance management.
• UsageEventCommitmentInvTemplate: string
  Title: Commitment

  Maximum Length: 200

  The template to show the invoice data for commitment type of balance management.
• UsageEventEstimateInvTemplate: string
  Title: Estimate

  Maximum Length: 200

  The template to show the invoice data for estimate type of balance management.
• UsageEventRegularInvTemplate: string
  Title: Basic

  Maximum Length: 200

  The common template to show the invoice data.
• UsageInvoiceLayoutTemplate: string
  Title: BIP Template

  Maximum Length: 200

  The layout template of the usage invoice.
• ValidationStatus: string
  Title: Validation Status

  Maximum Length: 1

  The validation status of the subscription product.
• VolumeRatingFlag: boolean
  Title: Enable volume pricing

  Indicates whether the entitlement plan is associated with the product is eligibile for volume pricing.
• 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.

{
    "type":"object",
    "properties":{
        "EntitlementPlanDescription":{
            "title":"Description",
            "type":"string",
            "description":"The description of the entitlement plan associated with the product.",
            "nullable":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "CalculatedCreditAmount":{
            "title":"Calculated Credit Amount",
            "type":"number",
            "description":"The calculated credit amount of the subscription product.",
            "nullable":true,
            "x-queryable":true
        },
        "TcvWithTotalUsageCharge":{
            "title":"TCV with Total Usage Charge",
            "type":"number",
            "description":"Tcv With Total Usage Charge",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NextPricingDate":{
            "title":"Next Pricing Date",
            "type":"string",
            "description":"The date when the next pricing will occur.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "CurcyConvRateType":{
            "title":"Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "EarlyTerminationPenalty":{
            "title":"Early Termination Penalty",
            "maxLength":30,
            "type":"string",
            "description":"The early termination penalty.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CancelDescription":{
            "title":"Cancellation Description",
            "maxLength":2000,
            "type":"string",
            "description":"The cancellation reason description of the subscription product.",
            "nullable":true,
            "x-queryable":true
        },
        "ResumeDate":{
            "type":"string",
            "description":"The date when the product should be resumed.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ChurnProbability":{
            "title":"Churn Probability",
            "type":"number",
            "description":"The probability of churn associated with the product.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceKey":{
            "title":"Source Key",
            "maxLength":120,
            "type":"string",
            "description":"The identifier of the product in the source system.",
            "nullable":true,
            "x-queryable":false
        },
        "CheckActiveExpiredAssetsExists":{
            "type":"string",
            "description":"Indicates whether any underlying assets are active or expired for the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LegacyRetrospectiveFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the product had legacy retrospective accounting.",
            "nullable":true,
            "x-queryable":true
        },
        "Currency":{
            "maxLength":15,
            "type":"string",
            "description":"The currency associated with the subscription product.",
            "nullable":false,
            "x-queryable":false
        },
        "RenewalSequenceNumber":{
            "type":"integer",
            "description":"The renewal sequence number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesOrderLineId":{
            "title":"Sales Order Line ID",
            "type":"integer",
            "description":"The sales order line ID associated with the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the subscription product.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the subscription product.",
            "nullable":false,
            "default":"DRAFT",
            "x-queryable":true
        },
        "AlignBillingFrom":{
            "title":"Align Billing From",
            "type":"string",
            "description":"The from date of the billing alignment.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription product.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SubscriptionProductPuid":{
            "title":"Subscription Product Number",
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the subscription product.",
            "nullable":false,
            "x-queryable":true
        },
        "InventoryItemId":{
            "title":"Item ID",
            "type":"integer",
            "description":"The unique identifier of the inventory item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreditedAmount":{
            "title":"Credited Amount",
            "type":"number",
            "description":"The amount credited to a account.",
            "nullable":true,
            "x-queryable":false
        },
        "PaymentTermsId":{
            "title":"Payment Terms ID",
            "type":"integer",
            "description":"The unique identifier of the payment terms.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PaymentTermsName":{
            "title":"Payment Terms",
            "type":"string",
            "description":"The name of the payment terms.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PrimaryPartyName":{
            "title":"Customer",
            "maxLength":255,
            "type":"string",
            "description":"The primary party name of the subscription product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AmendDescription":{
            "title":"Amendment Description",
            "maxLength":2000,
            "type":"string",
            "description":"A brief description of the amended credit.",
            "nullable":true,
            "x-queryable":false
        },
        "RenewalPaymentMethod":{
            "title":"Renewal Payment Method",
            "maxLength":30,
            "type":"string",
            "description":"The internal code for the renewal payment method used in the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RenewPerpetuallyFlag":{
            "title":"Renew forever",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the subscription product should be renewed forever.",
            "nullable":true,
            "x-queryable":true
        },
        "charges":{
            "title":"Charges",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-charges-item-response"
            }
        },
        "ShipToPartySiteName":{
            "title":"Ship-to Site",
            "type":"string",
            "description":"The name of the ship-to party site.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "PriceListId":{
            "title":"Price List",
            "type":"integer",
            "description":"The unique identifier of the price list.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AutoExtendFlag":{
            "type":"boolean",
            "description":"Indicates if the product should be auto extended.",
            "nullable":true,
            "x-queryable":false
        },
        "GracePeriod":{
            "title":"Grace Period in Days",
            "type":"integer",
            "description":"The grace period.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AmendReasonName":{
            "type":"string",
            "description":"The name of the amend reason.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the subscription product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OutputTaxClassification":{
            "title":"Output Tax Class",
            "maxLength":50,
            "type":"string",
            "description":"The tax classification to use when calculating the output tax.",
            "nullable":true,
            "x-queryable":false
        },
        "MonthlyRecurringRevenue":{
            "title":"MRR",
            "type":"number",
            "description":"The monthly recurring revenue associated with the product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "enableInGenAI":"true"
            }
        },
        "CanceledAmount":{
            "title":"Canceled Amount",
            "type":"number",
            "description":"The transaction amount that was canceled.",
            "nullable":true,
            "x-queryable":false
        },
        "QuoteId":{
            "title":"Quote Id",
            "type":"integer",
            "description":"The quote ID associated with the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastLifecycleUpdateDate":{
            "title":"Last Lifecycle Update Date",
            "type":"string",
            "description":"Last Lifecycle Update Date",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "AsyncFlag":{
            "type":"boolean",
            "description":"Indicates whether the subscription product will undergo asynchronous process for operations such as duplicate, generate billing schedule etc.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RequestedPriceListId":{
            "title":"Override Price List",
            "type":"integer",
            "description":"The identifier of the requested price list.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "DefaultRevenueAction":{
            "maxLength":30,
            "type":"string",
            "description":"The revenue management rule of the subscription product used during the amendment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UsageEventCommitmentInvTemplate":{
            "title":"Commitment",
            "maxLength":200,
            "type":"string",
            "description":"The template to show the invoice data for commitment type of balance management.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "InvoiceBipReportCode"
                ]
            },
            "x-queryable":true
        },
        "CustomerPONumber":{
            "title":"Customer PO Number",
            "maxLength":50,
            "type":"string",
            "description":"The customer PO number reference of a subscription product.",
            "nullable":true,
            "x-queryable":true
        },
        "BalanceRegisterNumber":{
            "title":"Register Number",
            "maxLength":255,
            "type":"string",
            "description":"The number of the balance register associated with the product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UsageInvoiceLayoutTemplate":{
            "title":"BIP Template",
            "maxLength":200,
            "type":"string",
            "description":"The layout template of the usage invoice.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "TaxClassificationMeaning":{
            "type":"string",
            "description":"The meaning of the tax classification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OrderFulfillLineNumber":{
            "title":"Order Fulfillment Line Number",
            "type":"integer",
            "description":"The number of the sales order fulfillment line associated with the subscription product.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "BillingDateCode":{
            "title":"Billing Date",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the billing date.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EstimateFlag":{
            "type":"string",
            "description":"Indicates whether estimate type of plan is associated with the product.",
            "nullable":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "billLines":{
            "title":"Bill Lines",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-billLines-item-response"
            }
        },
        "PendingActivationFlag":{
            "title":"Pending activation",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the activation of the subscription product is pending or not.",
            "nullable":true,
            "x-queryable":false
        },
        "ExternalParentAssetKey":{
            "title":"External Parent Asset Key",
            "maxLength":120,
            "type":"string",
            "description":"The external parent asset key",
            "nullable":true,
            "x-queryable":true
        },
        "RequestedEntitlementPlanId":{
            "title":"Requested Entitlement Plan ID",
            "type":"integer",
            "description":"The ID of the requested entitlement plan associated with the product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "negotiatedEntitlementPlanCommitments":{
            "title":"Subscription Entitlement Plan Commitments",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-negotiatedEntitlementPlanCommitments-item-response"
            }
        },
        "PricingTermsDuration":{
            "title":"Pricing Term Duration",
            "type":"number",
            "description":"The duration for which the pricing terms last.",
            "nullable":true,
            "x-queryable":false
        },
        "WarehouseId":{
            "title":"Warehouse",
            "type":"integer",
            "description":"The warehouse ID associated with the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"Product End Date",
            "type":"string",
            "description":"The date when the subscriptions ends.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "enableInGenAI":"true"
            },
            "x-queryable":true
        },
        "DocumentTypeId":{
            "title":"Document Type",
            "type":"integer",
            "description":"TheuUnique identifier of a source document type in Oracle Revenue Management Cloud.",
            "format":"int64",
            "nullable":true,
            "default":10,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ClosedAmount":{
            "title":"Closed Amount",
            "type":"number",
            "description":"The amount at which the transaction was closed.",
            "nullable":true,
            "x-queryable":false
        },
        "RelatedProductName":{
            "title":"Product Name",
            "maxLength":300,
            "type":"string",
            "description":"The name of the replacement subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "OverrideCreditAmount":{
            "title":"Override Credit Amount",
            "type":"number",
            "description":"The override credit amount of the subscription product.",
            "nullable":true,
            "x-queryable":true
        },
        "ValidationStatus":{
            "title":"Validation Status",
            "maxLength":1,
            "type":"string",
            "description":"The validation status of the subscription product.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitPrice":{
            "type":"number",
            "description":"The price of the unit.",
            "nullable":true,
            "x-queryable":false
        },
        "ExternalRootAssetKey":{
            "title":"External Root Asset Key",
            "maxLength":120,
            "type":"string",
            "description":"The external root asset key",
            "nullable":true,
            "x-queryable":true
        },
        "ResumeDuration":{
            "type":"integer",
            "description":"The duration after which the the product should be resumed.",
            "nullable":true,
            "x-queryable":false
        },
        "PriceTransactionOn":{
            "title":"Price Transaction on Date",
            "type":"string",
            "description":"The date when the price transaction occurred.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "GenerateBillingSchedule":{
            "title":"Generate billing schedule for full period",
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the billing schedule is to be generated or not.",
            "nullable":true,
            "x-queryable":false
        },
        "CloseDescription":{
            "title":"Close Description",
            "maxLength":2000,
            "type":"string",
            "description":"The close reason description of the subscription product.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Line Last Update Date",
            "type":"string",
            "description":"The date when the subscription was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AmendReason":{
            "title":"Amendment Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason why the credit was amended.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BillingOffsetDays":{
            "title":"Billing Offset Days",
            "type":"integer",
            "description":"The billing offset days.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeRulesFlag":{
            "title":"Charge Rules",
            "type":"string",
            "description":"Indicates whether volume pricing rule is associated with the product.",
            "nullable":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "TaxExemptionHandlingName":{
            "type":"string",
            "description":"The tax exemption handling name.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BillToAccountNumber":{
            "title":"Billing Account",
            "maxLength":30,
            "type":"string",
            "description":"The account number of the bill-to account.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "BillingDateName":{
            "type":"string",
            "description":"The name of the billing date.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PenaltyChargeName":{
            "type":"string",
            "description":"The penalty charge name.",
            "nullable":true,
            "x-queryable":true
        },
        "TaxExemptionHandling":{
            "title":"Tax Exemption Handling",
            "maxLength":30,
            "type":"string",
            "description":"The tax exemption handling.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "smartActions":{
            "title":"Subscription Product User Actions",
            "type":"array",
            "description":"The smart actions resource stores the endpoint and security details for every user action.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-smartActions-item-response"
            }
        },
        "RelatedInventoryItemId":{
            "title":"Related Inventory Item ID",
            "type":"integer",
            "description":"The unique identifier of the item associated to the replacement subscription product.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RatePlanDocumentId":{
            "type":"integer",
            "description":"The identifier of the rate plan document.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "productRelationships":{
            "title":"Product Relationships",
            "type":"array",
            "description":"The product relationships resource is used to view the relationship between a source and a target product. These relationships include amendment, renewal, suspension relationships.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-productRelationships-item-response"
            }
        },
        "ShipToAccountNumber":{
            "title":"Ship-to Account",
            "type":"string",
            "description":"The ship-to account number of the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "sortable":false,
                "dependencies":[
                    "ShipToAccountNumber1"
                ]
            }
        },
        "negotiatedVolumePricingRules":{
            "title":"Subscription Entitlement Pricing Rules",
            "type":"array",
            "description":"The subscription entitlement plan charge rules resource is used to view, create, update, and delete a negotiated entitlement plan charge rule which is used for the rating of a subscription product.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-negotiatedVolumePricingRules-item-response"
            }
        },
        "ShipToContactId":{
            "title":"Ship-to Contact ID",
            "type":"integer",
            "description":"The ship-to contact ID of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AlignBillingDay":{
            "title":"Align Billing Day",
            "type":"number",
            "description":"The day part of the align billing from the date of a subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Duration":{
            "title":"Duration",
            "type":"integer",
            "description":"Product Duration",
            "nullable":true,
            "x-queryable":false
        },
        "RequestedRatePlanId":{
            "title":"Requested Rate Plan ID",
            "type":"integer",
            "description":"The unique identifier of the requested rate plan.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ProductChangeSequenceNumber":{
            "type":"integer",
            "description":"The sequence number of the subscription product change.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RenewalType":{
            "title":"Product Renewal Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of subscription renewal.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ProgramName":{
            "title":"Program Name",
            "maxLength":120,
            "type":"string",
            "description":"The name of the preventive maintenance program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"input_text_lov"
            }
        },
        "CommitmentFlag":{
            "type":"string",
            "description":"Indicates whether commitment type of plan is associated with the product.",
            "nullable":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "PriceAdjustmentType":{
            "title":"Price Adjustment Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the price adjustment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EarlyTerminationFee":{
            "title":"Early Termination Fee",
            "type":"number",
            "description":"The early termination fee.",
            "nullable":true,
            "x-queryable":false
        },
        "AmendSourceProductPuid":{
            "title":"Amended Subscription Product PUID",
            "maxLength":255,
            "type":"string",
            "description":"Amend Source Product Puid",
            "nullable":true,
            "x-queryable":true
        },
        "RenewalPoNumber":{
            "title":"Product Renewal PO Number",
            "maxLength":50,
            "type":"string",
            "description":"The purchase order number of the renewed subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "RenewalPaymentMethod"
                ]
            }
        },
        "SourceLineNumber":{
            "title":"External Source Line Number",
            "maxLength":120,
            "type":"string",
            "description":"The source line number",
            "nullable":true,
            "x-queryable":false
        },
        "SalesProductType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the sales product.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PriceAsOf":{
            "title":"Price as of Date",
            "type":"string",
            "description":"The price of the product as of a certain date.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "CoverageName":{
            "title":"Template Name",
            "type":"string",
            "description":"The name of the coverage associated with the product.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "CoverageName1"
                ]
            },
            "x-queryable":true
        },
        "ShipToContactPartyId":{
            "type":"integer",
            "description":"The ship-to contact party ID of the subscription product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "PartyId_ShipToContact"
                ]
            }
        },
        "IsProductCreatedFromAmendFlag":{
            "type":"boolean",
            "description":"Indicates whether subscription product is created from amend action.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryPartyId":{
            "type":"integer",
            "description":"The primary party ID of the subscription product.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RatePlanNumber":{
            "title":"Rate Plan Number",
            "type":"string",
            "description":"The number of the rate plan.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ShipToContactNumber":{
            "title":"Ship-to Contact Number",
            "type":"string",
            "description":"The ship-to contact number of the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "ShipToContactNumber1"
                ]
            }
        },
        "ProductChangeSchedule":{
            "title":"Apply Change",
            "maxLength":30,
            "type":"string",
            "description":"The product change schedule is applicable on RENEWAL, ANNIVERSARY or SPECIFIC_DATE.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipToAccountId":{
            "title":"Ship-to Account ID",
            "type":"integer",
            "description":"The ship-to account ID of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AccountingRuleName":{
            "title":"Accounting Rule",
            "type":"string",
            "description":"The name of the accounting rule.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the subscription product is updated.",
            "nullable":true,
            "x-queryable":true
        },
        "SalesOrderId":{
            "title":"Sales Order ID",
            "type":"integer",
            "description":"The ID of the sales order associated with the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PricingTermsAdjustmentPCT":{
            "title":"Pricing Term Adjustment Percentage",
            "type":"number",
            "description":"The adjustment in the pricing terms.",
            "nullable":true,
            "x-queryable":false
        },
        "TaxError":{
            "title":"Tax Error",
            "maxLength":2000,
            "type":"string",
            "description":"The tax error, if any, in the calculated amount.",
            "nullable":true,
            "x-queryable":false
        },
        "InterfaceOffsetDays":{
            "title":"Billing Interface Offset Days",
            "type":"integer",
            "description":"The number of days that the interface needs to be offset for.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "CreditType":{
            "title":"Credit Type",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of credit to be issued to the customer on close and amend.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "GenBillSchReqdFlag":{
            "title":"Billing schedule update required",
            "maxLength":1,
            "type":"boolean",
            "description":"Generate Bill Schedule Required Flag",
            "nullable":true,
            "x-queryable":true
        },
        "SourceLineKey":{
            "title":"Source Line Key",
            "maxLength":120,
            "type":"string",
            "description":"The source line key",
            "nullable":true,
            "x-queryable":false
        },
        "EnableUpfrontBillingFlag":{
            "title":"Bill immediately",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether billing is done upfront or not.",
            "nullable":true,
            "x-queryable":false
        },
        "RepriceFlag":{
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionNumber":{
            "title":"Subscription Number",
            "maxLength":120,
            "type":"string",
            "description":"The subscription number of the product.",
            "nullable":false,
            "default":"Subscriptions.SubscriptionNumber",
            "x-hints":{
                "enableInGenAI":"true"
            },
            "x-queryable":true
        },
        "ShipToPartyNumber":{
            "title":"Ship-to Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The ship-to party number of the subscription product.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "RenewalRatePlanNumber":{
            "type":"string",
            "description":"The renewal rate plan number.",
            "nullable":true,
            "x-queryable":false
        },
        "ExemptCertificateNumber":{
            "title":"Tax Exemption Certificate Number",
            "maxLength":80,
            "type":"string",
            "description":"The number of the exempt certificate.",
            "nullable":true,
            "x-queryable":false
        },
        "BillToContactId":{
            "title":"Bill-to Contact ID",
            "type":"integer",
            "description":"The bill-to contact ID of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequestedEntitlementPlanNumber":{
            "title":"Entitlement Plan Number",
            "type":"string",
            "description":"The number of the requested entitlement plan associated with the product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "RequestedEntitlementPlanNumber1",
                    "RequestedEntitlementPlanId"
                ]
            }
        },
        "ShipToPartySiteNumber":{
            "title":"Ship-to Site Number",
            "type":"string",
            "description":"The ship-to party site number of the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "StatusMeaning":{
            "title":"Product Status",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the product status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EnablePricingTermsFlag":{
            "title":"Enable pricing term",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the pricing terms are enabled or not.",
            "nullable":true,
            "x-queryable":true
        },
        "RenewalWireNumber":{
            "title":"Product Renewal Wire Number",
            "maxLength":30,
            "type":"string",
            "description":"The wire number that identifies the electronic funds transfer used to pay for a renewed subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "RenewalPaymentMethod"
                ]
            }
        },
        "GroupingRuleNumberUsed":{
            "title":"Grouping Rule Number",
            "maxLength":120,
            "type":"string",
            "description":"Grouping Rule Number Used",
            "nullable":true,
            "x-queryable":true
        },
        "associatedAsset":{
            "title":"Associated Assets",
            "type":"array",
            "description":"The associated assets resource is used to view, create, update, and delete the assets linked to a subscription product of subscription type.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-associatedAsset-item-response"
            }
        },
        "RenewalRatePlanId":{
            "type":"integer",
            "description":"The identifier of the renewal rate plan.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BatchTag":{
            "title":"Batch Tag",
            "maxLength":30,
            "type":"string",
            "description":"Batch Tag",
            "nullable":true,
            "x-queryable":true
        },
        "PONumber":{
            "title":"PO Number",
            "maxLength":50,
            "type":"string",
            "description":"The number of the purchase order.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PaymentMethod"
                ]
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the subscription was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CheckHoldAssetsExists":{
            "type":"string",
            "description":"Indicates whether any underlying assets are on hold for the subscription product.",
            "nullable":true,
            "x-queryable":false
        },
        "AllowanceGrantFlag":{
            "type":"string",
            "description":"Indicates whether allowance type of plan is associated with the product.",
            "nullable":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "RenewSourceProductPuid":{
            "title":"Renewed Subscription Product PUID",
            "maxLength":255,
            "type":"string",
            "description":"Renew Source Product Puid",
            "nullable":true,
            "x-queryable":true
        },
        "RenewalPriceListId":{
            "type":"integer",
            "description":"The identifier of the renewal price list.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "InflightFlag":{
            "title":"Subscription In-Process",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the subscription product is inflight or not.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipToPartyId":{
            "title":"Ship-to Party ID",
            "type":"integer",
            "description":"The unique identifier of the ship-to party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResumePeriod":{
            "type":"string",
            "description":"The period of time after which the product will resume.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChurnPredictionTrend":{
            "title":"Churn Prediction Trend",
            "type":"integer",
            "description":"The churn prediction trend.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "ProductChangeScheduleFrom":{
            "title":"Product Change Schedule Effective Date",
            "type":"string",
            "description":"The date from which the product change schedule is  applicable.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "PrePaymentNumber":{
            "title":"Prepayment Number",
            "type":"integer",
            "description":"The prepayment number.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "relationships":{
            "title":"Relationships",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-relationships-item-response"
            }
        },
        "CloseReason":{
            "title":"Product Close Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason why the product was closed.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "InvoiceBipReportCode":{
            "title":"BIP Data Source",
            "maxLength":30,
            "type":"string",
            "description":"The code of  the type of template to pick for the invoice report.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SummarizedBillingFlag":{
            "title":"Summarized billing",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the billing is to be summarized.",
            "nullable":true,
            "x-queryable":true
        },
        "BillToPartyId":{
            "title":"Bill-to Party ID",
            "type":"integer",
            "description":"The bill-to customer ID of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceNumber":{
            "title":"External Source Number",
            "maxLength":120,
            "type":"string",
            "description":"The alternate identifier of the product in the source system.",
            "nullable":true,
            "x-queryable":false
        },
        "PricingTermsPeriod":{
            "title":"Pricing Term",
            "maxLength":15,
            "type":"string",
            "description":"The period for which the pricing terms last.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CanceledDate":{
            "title":"Product Canceled Date",
            "type":"string",
            "description":"The date when the product was canceled.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "WareHouseName":{
            "title":"Warehouse",
            "type":"string",
            "description":"The warehouse name of the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "sortable":false
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PriceAdjustmentPercent":{
            "title":"Price Adjustment Value",
            "type":"number",
            "description":"The price adjustment percent.",
            "nullable":true,
            "x-queryable":false
        },
        "BillingFrequency":{
            "title":"Billing Frequency",
            "maxLength":30,
            "type":"string",
            "description":"The billing frequency.",
            "nullable":false,
            "x-queryable":false
        },
        "RenewalPaymentMethodName":{
            "title":"Renewal Payment Method Name",
            "type":"string",
            "description":"The method of payment for renewed subscription product. The payment method could be a purchase order, wire, or credit card.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RenewalDurationPeriodName":{
            "title":"Renewal Period",
            "type":"string",
            "description":"The name of the subscription product level renewal duration period override that will be used while renewing through automatic or manual renewal.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "RenewalDurationPeriodName1"
                ]
            }
        },
        "EstimatedTax":{
            "title":"Estimated Tax",
            "type":"number",
            "description":"The estimated tax on the product.",
            "nullable":true,
            "x-queryable":false
        },
        "BillToPartyName":{
            "title":"Bill-to Customer",
            "maxLength":360,
            "type":"string",
            "description":"The bill-to customer name of the subscription product.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "sortable":false
            }
        },
        "SalesOrderNumber":{
            "title":"Sales Order Number",
            "maxLength":200,
            "type":"string",
            "description":"The number of the sales order associated with the subscription product.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestedAlignBillingDate":{
            "title":"Requested Align Billing From",
            "type":"string",
            "description":"The requested align billing date for the product.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PricingTermsPricingMethod":{
            "title":"Pricing Method",
            "maxLength":30,
            "type":"string",
            "description":"The method used to set the terms of the product pricing.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "serviceResources":{
            "title":"Service Resources",
            "type":"array",
            "description":"The service resources resouce is used to view, create, update, and delete the service identifier for a subscription product.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-serviceResources-item-response"
            }
        },
        "EntitlementPlanName":{
            "title":"Name",
            "type":"string",
            "description":"The name of the entitlement plan associated with the product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "InvoicedAmount":{
            "title":"Invoiced Amount",
            "type":"number",
            "description":"The amount specified in the invoice.",
            "nullable":true,
            "x-queryable":false
        },
        "SuspendedDate":{
            "title":"Suspend Date",
            "type":"string",
            "description":"The date when the product was suspended.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "negotiatedEntitlementPlanEstimates":{
            "title":"Subscription Entitlement Plan Estimates",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-negotiatedEntitlementPlanEstimates-item-response"
            }
        },
        "RenewalDuration":{
            "title":"Renewal Duration",
            "type":"integer",
            "description":"The subscription product level renewal duration override that will be used while renewing through automatic or manual renewal.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PricingSystem":{
            "type":"string",
            "description":"The pricing system of the product.",
            "nullable":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Product Description",
            "type":"string",
            "description":"A brief description of the subscription product.",
            "nullable":true,
            "x-queryable":false
        },
        "RelatedProductDescription":{
            "title":"Description",
            "type":"string",
            "description":"The description of the replacement subscription product.",
            "nullable":true,
            "x-queryable":false
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"number",
            "description":"The display sequence of the subscription product.",
            "nullable":true,
            "x-queryable":false
        },
        "InvoicingRuleName":{
            "title":"Invoicing Rule",
            "type":"string",
            "description":"The name of the invoicing rule.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CustomerTrxTypeSequenceId":{
            "title":"Sequence",
            "type":"integer",
            "description":"The customer transaction type sequence ID of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillToPartyNumber":{
            "title":"Bill-to Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The bill-to customer number of the subscription product.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LineNumber":{
            "title":"Product Line Number",
            "maxLength":300,
            "type":"string",
            "description":"The line number of the product.",
            "nullable":false,
            "x-queryable":true
        },
        "PaymentMethodName":{
            "title":"Payment Method Name",
            "type":"string",
            "description":"The name of the payment method.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ExternalAssetKey":{
            "title":"External Asset Key",
            "maxLength":120,
            "type":"string",
            "description":"The external asset key",
            "nullable":true,
            "x-queryable":true
        },
        "PmProgramId":{
            "title":"Preventive Maintenance Program ID",
            "type":"integer",
            "description":"The identifier of the preventive maintenance program.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExternalPriceListId":{
            "title":"External Price List ID",
            "maxLength":120,
            "type":"string",
            "description":"The unique identifier of the external price list.",
            "nullable":true,
            "x-queryable":true
        },
        "SalesOrderLineNumber":{
            "title":"Sales Order Line Number",
            "maxLength":100,
            "type":"string",
            "description":"Sales Order Line Number",
            "nullable":true,
            "x-queryable":true
        },
        "RevenueOption":{
            "title":"Revenue Accounting Option",
            "maxLength":30,
            "type":"string",
            "description":"Revenue Option",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "flexFields":{
            "title":"Descriptive Flexfields",
            "type":"array",
            "description":"The descriptive flexfields resource is used to view, create, update, and delete a descriptive flexfield.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-flexFields-item-response"
            },
            "x-cardinality":"1"
        },
        "EarlyTerminationPenaltyName":{
            "type":"string",
            "description":"The name of the early termination penalty.",
            "nullable":true,
            "x-queryable":true
        },
        "VolumeRatingFlag":{
            "title":"Enable volume pricing",
            "type":"boolean",
            "description":"Indicates whether the entitlement plan is associated with the product is eligibile for volume pricing.",
            "nullable":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "ShipToContactName":{
            "title":"Ship-to Contact",
            "type":"string",
            "description":"The ship-to contact name of the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "sortable":false,
                "dependencies":[
                    "ShipToContactName1"
                ]
            }
        },
        "TotalContractValue":{
            "title":"Product Contract Value",
            "type":"number",
            "description":"The value of the total contract.",
            "nullable":true,
            "x-hints":{
                "enableInGenAI":"true"
            },
            "x-queryable":true
        },
        "SuspendReason":{
            "title":"Suspend Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason to suspend the product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DropOneTimeChargeFlag":{
            "title":"Don't copy one-time charges",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether one time charges have to be removed when the product is changed.",
            "nullable":true,
            "x-queryable":false
        },
        "SummarizedRatingFlag":{
            "title":"Enable summarize rating",
            "type":"boolean",
            "description":"Indicates whether the entitlement plan is associated with the product is eligibile for summarized rating.",
            "nullable":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "coveredLevels":{
            "title":"Covered Levels",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-item-response"
            }
        },
        "CloseCreditMethod":{
            "title":"Close Credit Method",
            "maxLength":30,
            "type":"string",
            "description":"The method used to close the credit.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RelationShipExistFlag":{
            "type":"string",
            "description":"Indicates whether relationship exists for the product.",
            "nullable":true,
            "x-queryable":true
        },
        "TotalUsageCharge":{
            "title":"Total Usage Charges",
            "type":"number",
            "description":"Total Usage Charge",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BillToSiteNumber":{
            "title":"Bill-to Site Number",
            "type":"string",
            "description":"The bill-to site number of the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ShipToPartySiteId":{
            "title":"Ship-to Party Site ID",
            "type":"integer",
            "description":"The unique identifier of the ship-to party site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CalculateEstimatedTaxFlag":{
            "type":"boolean",
            "description":"Indicates whether estimated tax will be calculated for the subscription product.",
            "nullable":true,
            "x-queryable":false
        },
        "ProductFiscClassification":{
            "title":"Product Fiscal Classification",
            "maxLength":30,
            "type":"string",
            "description":"The product fiscal classification.",
            "nullable":true,
            "x-queryable":false
        },
        "AccountingRuleId":{
            "title":"Accounting Rule ID",
            "type":"integer",
            "description":"The unique identifier of the accounting rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillToAccountId":{
            "title":"Account Id",
            "type":"integer",
            "description":"The unique identifier of the bill-to account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UsageEventRegularInvTemplate":{
            "title":"Basic",
            "maxLength":200,
            "type":"string",
            "description":"The common template to show the invoice data.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "InvoiceBipReportCode"
                ]
            },
            "x-queryable":true
        },
        "PenaltyValue":{
            "title":"Penalty Value",
            "type":"number",
            "description":"The penalty value.",
            "nullable":true,
            "x-queryable":false
        },
        "EntitlementPlanNumber":{
            "title":"Number",
            "type":"string",
            "description":"The number of the entitlement plan associated with the product.",
            "nullable":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "RatePlanName":{
            "title":"Rate Plan",
            "type":"string",
            "description":"The name of the rate plan.",
            "nullable":true,
            "x-queryable":false
        },
        "ClosedDate":{
            "title":"Product Close Date",
            "type":"string",
            "description":"The date when the product was closed.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystem":{
            "title":"Source System",
            "maxLength":30,
            "type":"string",
            "description":"The reference of the product in the source system.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductChangeReason":{
            "title":"Change Reason",
            "maxLength":300,
            "type":"string",
            "description":"The reason for the product change.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TransactionTypeName":{
            "title":"Transaction Type",
            "maxLength":30,
            "type":"string",
            "description":"The name of the transaction type.",
            "nullable":false,
            "x-queryable":false
        },
        "ProductName":{
            "title":"Product Name",
            "maxLength":300,
            "type":"string",
            "description":"The name of the product.",
            "nullable":true,
            "x-hints":{
                "controlType":"input_text_lov",
                "enableInGenAI":"true"
            },
            "x-queryable":true
        },
        "BalanceManagementError":{
            "title":"Balance Management Error",
            "maxLength":2000,
            "type":"string",
            "description":"The balance management error.",
            "nullable":true,
            "x-queryable":true
        },
        "QuoteLineId":{
            "title":"Quote Line ID",
            "type":"integer",
            "description":"The quote line ID associated with the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillToAccountDescription":{
            "type":"string",
            "description":"A brief description of the bill-to account.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "BillToAccountDescription1"
                ]
            }
        },
        "SuspendCreditMethod":{
            "title":"Suspend Credit Method",
            "maxLength":30,
            "type":"string",
            "description":"Indicates if the credit method has to be suspended.",
            "nullable":true,
            "x-queryable":false
        },
        "StartDate":{
            "title":"Product Start Date",
            "type":"string",
            "description":"The date when the subscriptions starts.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "enableInGenAI":"true"
            },
            "x-queryable":true
        },
        "BillToAddress":{
            "title":"Bill-to Address",
            "type":"string",
            "description":"The bill-to address.",
            "nullable":true,
            "x-queryable":false
        },
        "ExemptReason":{
            "title":"Exemption Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason for the tax exemption.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipToAccountDescription":{
            "type":"string",
            "description":"The ship-to account description of the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "ShipToAccountDescription1"
                ]
            }
        },
        "PricingTermsStartDate":{
            "title":"Starting On",
            "type":"string",
            "description":"The date when the pricing terms starts.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "PriceAdjustmentBasis":{
            "title":"Price Adjustment Basis",
            "maxLength":30,
            "type":"string",
            "description":"The basis on the which the price is adjusted.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RequestedRatePlanNumber":{
            "type":"string",
            "description":"The alternate unique identifier of the requested rate plan.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"input_text_lov",
                "sortable":false,
                "dependencies":[
                    "RequestedRatePlanNumber1"
                ]
            }
        },
        "MilestoneBasedChargeFlag":{
            "type":"boolean",
            "description":"Indicates whether the charge for the product is milestone based.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ItemUnitOfMeasureMeaning":{
            "title":"Pricing UOM",
            "type":"string",
            "description":"The display name of item unit of measure.",
            "nullable":true,
            "x-queryable":false
        },
        "CorpCurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "RetainSubsOnRenewFlag":{
            "title":"Don't Create New Renewal Subscription",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the renewal should happen in the source subscription.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemUnitOfMeasure":{
            "title":"Pricing UOM Code",
            "maxLength":15,
            "type":"string",
            "description":"The unit of measure used to measure the items.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BillToSiteName":{
            "title":"Bill-to Site",
            "maxLength":255,
            "type":"string",
            "description":"The bill-to site name of the subscription product.",
            "nullable":true,
            "x-queryable":true
        },
        "EnableProrateByDay":{
            "title":"Prorate by day",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether proration by day is enabled or not.",
            "nullable":true,
            "x-queryable":false
        },
        "CoverageScheduleId":{
            "title":"Coverage Schedule ID",
            "type":"integer",
            "description":"Coverage Scheduled",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UsageEventEstimateInvTemplate":{
            "title":"Estimate",
            "maxLength":200,
            "type":"string",
            "description":"The template to show the invoice data for estimate type of balance management.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "InvoiceBipReportCode"
                ]
            },
            "x-queryable":true
        },
        "BillToSiteUseId":{
            "title":"Site Use Id",
            "type":"integer",
            "description":"The unique identifier of the bill-to site use.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Period":{
            "title":"Period",
            "type":"string",
            "description":"The period for which the product has been subscribed.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RenewalPriceListName":{
            "title":"Renewal Price List",
            "maxLength":255,
            "type":"string",
            "description":"The name of the renewal price list.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "negotiatedEntitlementPlanDetails":{
            "title":"Subscription Entitlement Plan Details",
            "type":"array",
            "description":"The subscription entitlement plan details resource is used to view, create, update, and delete an entitlement plan detail.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-negotiatedEntitlementPlanDetails-item-response"
            }
        },
        "DropAllowanceFlag":{
            "title":"No Allowance",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether allowances alone are dropped for a subscription product.",
            "nullable":true,
            "x-queryable":true
        },
        "BillOnDay":{
            "title":"Bill on Day",
            "type":"number",
            "description":"The day on which the product should be billed.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "WireNumber":{
            "title":"Wire Number",
            "maxLength":30,
            "type":"string",
            "description":"The wire number.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PaymentMethod"
                ]
            }
        },
        "RatePlanId":{
            "title":"Rate Plan ID",
            "type":"integer",
            "description":"The unique identifier of the rate plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CancelReason":{
            "title":"Cancellation Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason why the product was canceled.",
            "nullable":true,
            "x-queryable":false
        },
        "creditCards":{
            "title":"Credit Cards",
            "type":"array",
            "description":"The credit cards resource is used to view, create, and update the credit cards associated with a subscription.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-creditCards-item-response"
            }
        },
        "GenerateBillFullPeriodFlag":{
            "title":"Generate billing schedule for full period",
            "maxLength":1,
            "type":"boolean",
            "description":"Generate Bill Full Period Flag",
            "nullable":true,
            "x-queryable":false
        },
        "BillToContactNumber":{
            "title":"Bill-to Contact Number",
            "type":"string",
            "description":"The bill-to contact number of the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "BillToContactNumber1"
                ]
            }
        },
        "PaymentMethod":{
            "title":"Payment Method",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the payment method.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BalanceRegisterId":{
            "title":"Balance Register ID",
            "type":"integer",
            "description":"The ID of the balance register associated with the product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DefinitionOrganizationId":{
            "title":"Inventory Organization",
            "type":"integer",
            "description":"The unique identifier of the item master organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AmendCreditMethod":{
            "title":"Amendment Credit Method",
            "maxLength":30,
            "type":"string",
            "description":"The method used to amend the credit.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RenewalDurationPeriod":{
            "title":"Renewal Period",
            "maxLength":30,
            "type":"string",
            "description":"The code of the subscription product level renewal duration period override that will be used while renewing through automatic or manual renewal.",
            "nullable":true,
            "x-queryable":true
        },
        "BalanceProfileName":{
            "title":"Profile Name",
            "type":"string",
            "description":"The name of the balance profile associated with the product.",
            "nullable":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "ShipToPartyName":{
            "title":"Ship-to Party",
            "type":"string",
            "description":"The name of the ship-to party.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "ShipToPartyName1"
                ]
            }
        },
        "RatePlanYn":{
            "type":"string",
            "description":"Indicates whether pricing for the subscription product is based on rate plan.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "InvoiceText":{
            "title":"Invoice Text",
            "maxLength":4000,
            "type":"string",
            "description":"The text in the billing invoice.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BillToSite":{
            "title":"Bill-to Site",
            "type":"string",
            "description":"Bill To Site",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "AmendCreditMethodName":{
            "type":"string",
            "description":"The name of the method used to amend the credit .",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "NextBillStartDate":{
            "title":"Next Bill Start Date",
            "type":"string",
            "description":"Next Bill Start Date",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "AmendEffectiveDate":{
            "title":"Amendment Effective Date",
            "type":"string",
            "description":"The date when the amended credit becomes effective.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "OrderFulfillLineId":{
            "title":"Order Fulfillment Line ID",
            "type":"integer",
            "description":"The ID of the sales order fulfillment line associated with the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EntitlementType":{
            "title":"Entitlement Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the entitlement associated with the product.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PriceListName":{
            "title":"Price List Name",
            "maxLength":120,
            "type":"string",
            "description":"The name of the price list.",
            "nullable":true,
            "x-queryable":false
        },
        "UsageEventAllowanceInvTemplate":{
            "title":"Allowance",
            "maxLength":200,
            "type":"string",
            "description":"The template to show the invoice data for allowance type of balance management.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "InvoiceBipReportCode"
                ]
            },
            "x-queryable":true
        },
        "InvoicingRuleId":{
            "title":"Invoicing Rule Id",
            "type":"integer",
            "description":"The unique identifier of the invoicing rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RenewedDate":{
            "title":"Renewed On",
            "type":"string",
            "description":"The date when the product was renewed.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "OriginalSubscriptionProductPuid":{
            "maxLength":240,
            "type":"string",
            "description":"The PUID of the original subscription product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity of the product.",
            "nullable":true,
            "x-queryable":false
        },
        "BillingFrequencyName":{
            "title":"Billing Frequency",
            "type":"string",
            "description":"The name of the billing frequency.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BillingFrequencyName1"
                ]
            }
        },
        "ProgramCode":{
            "title":"Program Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the preventive maintenance program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EntitlementPlanId":{
            "title":"Entitlement Plan ID",
            "type":"integer",
            "description":"The ID of the entitlement plan associated with the product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "salesCredits":{
            "title":"Sales Credits",
            "type":"array",
            "description":"The sales credits resource to view, create, update, and delete the sales credits defined for a subscription or a subscription product.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-salesCredits-item-response"
            }
        },
        "RequestedProgramId":{
            "title":"Requested Preventive Maintenance Program ID",
            "type":"integer",
            "description":"The unique identifier of the requested preventive maintenance program.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":80,
                "dependencies":[
                    "PmRequestedProgramId"
                ]
            },
            "x-queryable":true
        },
        "BillToContactName":{
            "title":"Bill-to Contact",
            "type":"string",
            "description":"The bill-to contact name of the subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "enableInGenAI":"true",
                "sortable":false,
                "dependencies":[
                    "BillToContactName1"
                ]
            }
        },
        "EnableAdvBipTemplateFlag":{
            "title":"Enable Advanced Configuration",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether advanced BIP configuration for usage invoice templates is enabled.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ProgramOrganizationId":{
            "title":"Organization",
            "type":"integer",
            "description":"The organization identifier of the preventive maintenance program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RatePlanDocument":{
            "type":"string",
            "description":"The JSON representing the rate plan.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "PricingError":{
            "maxLength":2000,
            "type":"string",
            "description":"The pricing error associated with the product.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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

• Array of: object subscriptionProducts-associatedAsset-item-response

{
    "title":"Associated Assets",
    "type":"array",
    "description":"The associated assets resource is used to view, create, update, and delete the assets linked to a subscription product of subscription type.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-associatedAsset-item-response"
    }
}

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

• Array of: object subscriptionProducts-billLines-item-response

{
    "title":"Bill Lines",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-billLines-item-response"
    }
}

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

• Array of: object subscriptionProducts-charges-item-response

{
    "title":"Charges",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-charges-item-response"
    }
}

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

• Array of: object subscriptionProducts-coveredLevels-item-response

{
    "title":"Covered Levels",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-item-response"
    }
}

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

• Array of: object subscriptionProducts-creditCards-item-response

{
    "title":"Credit Cards",
    "type":"array",
    "description":"The credit cards resource is used to view, create, and update the credit cards associated with a subscription.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-creditCards-item-response"
    }
}

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

• Array of: object subscriptionProducts-flexFields-item-response

{
    "title":"Descriptive Flexfields",
    "type":"array",
    "description":"The descriptive flexfields resource is used to view, create, update, and delete a descriptive flexfield.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-flexFields-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object subscriptionProducts-negotiatedEntitlementPlanCommitments-item-response

{
    "title":"Subscription Entitlement Plan Commitments",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-negotiatedEntitlementPlanCommitments-item-response"
    }
}

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

• Array of: object subscriptionProducts-negotiatedEntitlementPlanDetails-item-response

{
    "title":"Subscription Entitlement Plan Details",
    "type":"array",
    "description":"The subscription entitlement plan details resource is used to view, create, update, and delete an entitlement plan detail.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-negotiatedEntitlementPlanDetails-item-response"
    }
}

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

• Array of: object subscriptionProducts-negotiatedEntitlementPlanEstimates-item-response

{
    "title":"Subscription Entitlement Plan Estimates",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-negotiatedEntitlementPlanEstimates-item-response"
    }
}

Nested Schema : Subscription Entitlement Pricing Rules

Type: array

Title: Subscription Entitlement Pricing Rules

The subscription entitlement plan charge rules resource is used to view, create, update, and delete a negotiated entitlement plan charge rule which is used for the rating of a subscription product.

Show Source

• Array of: object subscriptionProducts-negotiatedVolumePricingRules-item-response

{
    "title":"Subscription Entitlement Pricing Rules",
    "type":"array",
    "description":"The subscription entitlement plan charge rules resource is used to view, create, update, and delete a negotiated entitlement plan charge rule which is used for the rating of a subscription product.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-negotiatedVolumePricingRules-item-response"
    }
}

Nested Schema : Product Relationships

Type: array

Title: Product Relationships

The product relationships resource is used to view the relationship between a source and a target product. These relationships include amendment, renewal, suspension relationships.

Show Source

• Array of: object subscriptionProducts-productRelationships-item-response

{
    "title":"Product Relationships",
    "type":"array",
    "description":"The product relationships resource is used to view the relationship between a source and a target product. These relationships include amendment, renewal, suspension relationships.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-productRelationships-item-response"
    }
}

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

• Array of: object subscriptionProducts-relationships-item-response

{
    "title":"Relationships",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-relationships-item-response"
    }
}

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

• Array of: object subscriptionProducts-salesCredits-item-response

{
    "title":"Sales Credits",
    "type":"array",
    "description":"The sales credits resource to view, create, update, and delete the sales credits defined for a subscription or a subscription product.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-salesCredits-item-response"
    }
}

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

• Array of: object subscriptionProducts-serviceResources-item-response

{
    "title":"Service Resources",
    "type":"array",
    "description":"The service resources resouce is used to view, create, update, and delete the service identifier for a subscription product.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-serviceResources-item-response"
    }
}

Nested Schema : Subscription Product User Actions

Type: array

Title: Subscription Product User Actions

The smart actions resource stores the endpoint and security details for every user action.

Show Source

• Array of: object subscriptionProducts-smartActions-item-response

{
    "title":"Subscription Product User Actions",
    "type":"array",
    "description":"The smart actions resource stores the endpoint and security details for every user action.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-smartActions-item-response"
    }
}

Nested Schema : subscriptionProducts-associatedAsset-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the associated asset was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasureCode":{
            "title":"UOM",
            "type":"string",
            "description":"The unit of measure code of the associated asset.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "sortable":false,
                "dependencies":[
                    "AssetId"
                ]
            }
        },
        "ProductName":{
            "title":"Product Name",
            "type":"string",
            "description":"The name of the product.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AssetId"
                ]
            },
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "LineNumber":{
            "title":"Number",
            "type":"integer",
            "description":"The line number of the associated asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The currency code such as USD or INR.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceKey":{
            "maxLength":120,
            "type":"string",
            "description":"The source key of the associated asset.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "SubscriptionProductId"
                ]
            },
            "x-queryable":true
        },
        "SourceNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The source number of the associated asset.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscurption product.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceLineKey":{
            "maxLength":120,
            "type":"string",
            "description":"The source line key of the associated asset.",
            "nullable":true,
            "x-queryable":true
        },
        "CorpCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the associated asset.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the associated asset.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociatedAssetId":{
            "type":"integer",
            "description":"The unique identifier of the associated asset.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"UOM",
            "type":"string",
            "description":"The unit of measure of the associated asset.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "UnitOfMeasureCode"
                ]
            }
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"The unique identifier of the inventory item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity of the associated asset.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "AssetId"
                ]
            }
        },
        "AssetName":{
            "title":"Asset Name",
            "type":"string",
            "description":"The name of the asset.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "sortable":false,
                "dependencies":[
                    "AssetId"
                ]
            },
            "x-queryable":true
        },
        "AssetSerialNumber":{
            "title":"Asset Serial Number",
            "type":"string",
            "description":"The serial number of the asset.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AssetId"
                ]
            },
            "x-queryable":true
        },
        "AssociatedAssetPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The PUID of the associated asset.",
            "nullable":false,
            "x-queryable":true
        },
        "AssetId":{
            "type":"integer",
            "description":"The unique identifier of the asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceLineNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The source line number of the associated asset.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystem":{
            "maxLength":30,
            "type":"string",
            "description":"The source system of the associated asset.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the associated asset was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the associated asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : subscriptionProducts-billLines-item-response

Type: object

Show Source

• AdhocBillLineFlag: boolean
  Default Value: false

  Adhoc BillLine Flag
• Amount: number
  Title: Amount

  The amount for which the bill is generated.
• BatchTag: string
  Title: Batch Tag

  Maximum Length: 30

  Batch Tag
• 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
  Title: Charge PUID

  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
  Title: Credit Memo Reason Code

  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
  Title: Milestone Name

  The name of the milestone event associated with the bill line.
• MilestoneEventPuid: string
  Title: Milestone Event PUID

  Milestone Event Puid
• NewCreditMemoPUID: string
  The unique public identifier of the new credit memo.
• PricedQuantity: number
  Title: Priced Quantity

  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)
  Title: Usage Capture Date

  The date when the usage was captured.
• UsageChargeType: string
  Title: Usage Charge Type

  Maximum Length: 30

  The type of usage charge.
• UsageChargeTypeName: string
  Title: Usage Charge Type

  The name of the usage charge type.
• UsageFlag: boolean
  Maximum Length: 1

  Indicates whether the line is a usage line or not.
• UsageInvoiceAttachmentYn: string
  Maximum Length: 1

  Indicates whether usage events invoice attachment is associated with the bill line.
• 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.
• UsageRatingProcess: string
  Title: Usage Rating Process

  Maximum Length: 30

  Usage Rating Process

{
    "type":"object",
    "properties":{
        "TrxId":{
            "type":"integer",
            "description":"The AR transaction ID.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the billing line was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionTypeName":{
            "type":"string",
            "description":"The transaction type name of the subscription bill line.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargePuid":{
            "title":"Charge PUID",
            "type":"string",
            "description":"The public unique identifier of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeDefinition":{
            "maxLength":30,
            "type":"string",
            "description":"The definition that indicates the purpose of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "SentDate":{
            "title":"Sent Date",
            "type":"string",
            "description":"The date invoice information is sent to receivables.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "UsagePricedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the usage line has been priced or not.",
            "nullable":true,
            "x-queryable":true
        },
        "UsageRatingProcess":{
            "title":"Usage Rating Process",
            "maxLength":30,
            "type":"string",
            "description":"Usage Rating Process",
            "nullable":true,
            "x-queryable":true
        },
        "ListPrice":{
            "type":"number",
            "description":"The list price of the product associated with the bill line.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionTax":{
            "title":"Tax",
            "type":"number",
            "description":"The tax levied on the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "RevenueLineId":{
            "type":"integer",
            "description":"The unique identifier of the revenue line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreditMemoReason":{
            "type":"string",
            "description":"The reason to raise the credit memo.",
            "nullable":true,
            "x-queryable":false
        },
        "MilestoneEventPuid":{
            "title":"Milestone Event PUID",
            "type":"string",
            "description":"Milestone Event Puid",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillLinePuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the bill line.",
            "nullable":false,
            "x-queryable":true
        },
        "UsageFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the line is a usage line or not.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the billing line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UsageChargeTypeName":{
            "title":"Usage Charge Type",
            "type":"string",
            "description":"The name of the usage charge type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "billAdjustments":{
            "title":"Bill Adjustments",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-billLines-billAdjustments-item-response"
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the billing line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BillingPeriod":{
            "title":"Sequence",
            "type":"number",
            "description":"The period for which the bill is generated.",
            "nullable":false,
            "x-queryable":true
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"The ID of the business unit associated with the bill line.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargeName":{
            "title":"Charge Name",
            "maxLength":120,
            "type":"string",
            "description":"The name of the charge associated with the bill line.",
            "nullable":true,
            "x-queryable":true
        },
        "RetrieveInvoiceFlag":{
            "title":"Retrieve Invoice from Receivables",
            "maxLength":1,
            "type":"boolean",
            "description":"Retrieve Invoice Flag",
            "nullable":true,
            "x-queryable":true
        },
        "MilestoneEventId":{
            "type":"integer",
            "description":"The ID of the milestone event associated with the bill line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TrxLineId":{
            "type":"integer",
            "description":"The AR transaction line ID.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SummarizedBillLineId":{
            "title":"Summarized Bill Line ID",
            "type":"integer",
            "description":"Summarized Bill Line ID",
            "nullable":true,
            "x-queryable":true
        },
        "UsageCaptureDate":{
            "title":"Usage Capture Date",
            "type":"string",
            "description":"The date when the usage was captured.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "RevenuePeriod":{
            "title":"Revenue Effectivity Periods",
            "maxLength":30,
            "type":"string",
            "description":"Revenue Period",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the billing line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditMemoFlag":{
            "type":"string",
            "description":"Indicates if there is a credit memo associated with the bill line.",
            "nullable":true,
            "x-queryable":false
        },
        "DateToInterface":{
            "title":"Interface Date",
            "type":"string",
            "description":"The date to interface for the bill line.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "UsageChargeType":{
            "title":"Usage Charge Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of usage charge.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionNumber":{
            "title":"Invoice Number",
            "maxLength":30,
            "type":"string",
            "description":"The number of the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "NewCreditMemoPUID":{
            "type":"string",
            "description":"The unique public identifier of the new credit memo.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargePeriodFactor":{
            "type":"number",
            "description":"The change period factor associated with the bill line.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerTrxTypeSequenceId":{
            "type":"integer",
            "description":"Customer Transaction Type Sequence Id",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TruedUpYn":{
            "maxLength":3,
            "type":"string",
            "description":"Indicates if the bill line has a trueup period.",
            "nullable":true,
            "x-queryable":true
        },
        "CreditMemoReasonCode":{
            "title":"Credit Memo Reason Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the credit memo reason code.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InvoiceText":{
            "title":"Invoice Text",
            "maxLength":240,
            "type":"string",
            "description":"The text in the bill line invoice.",
            "nullable":true,
            "x-queryable":true
        },
        "CreditMemoAmount":{
            "type":"number",
            "description":"The amount for the credit memo.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionClass":{
            "title":"Transaction Class",
            "maxLength":30,
            "type":"string",
            "description":"The class of the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "UsageInvoiceAttachmentYn":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether usage events invoice attachment is associated with the bill line.",
            "nullable":true,
            "x-queryable":true
        },
        "AdhocBillLineFlag":{
            "type":"boolean",
            "description":"Adhoc BillLine Flag",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "RevenueOption":{
            "title":"Revenue Accounting Option",
            "maxLength":30,
            "type":"string",
            "description":"Revenue Option",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InvoiceDate":{
            "type":"string",
            "description":"The date when the invoice was raised.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ChargePeriod":{
            "title":"Period",
            "type":"number",
            "description":"The usage period that was charged.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionDate":{
            "title":"Invoice Date",
            "type":"string",
            "description":"The date when the transaction occurred.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceBillLineId":{
            "type":"integer",
            "description":"The unique identifier of the invoice bill line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UsageAcquiredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the usage has been acquired or not.",
            "nullable":true,
            "x-queryable":true
        },
        "InterfacedFlag":{
            "title":"Interfaced",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the bill line is interfaced or not.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount for which the bill is generated.",
            "nullable":true,
            "x-queryable":true
        },
        "DateBilledTo":{
            "title":"Bill-to Date",
            "type":"string",
            "description":"The date up to which the bill is generated.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "UsageQuantity":{
            "title":"Usage Quantity",
            "type":"number",
            "description":"The quantity of the usage.",
            "nullable":true,
            "x-queryable":true
        },
        "CoveredLevelId":{
            "type":"integer",
            "description":"The unique identifier of the covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PricedQuantity":{
            "title":"Priced Quantity",
            "type":"number",
            "description":"The quantity for which the bill line was charged.",
            "nullable":true,
            "x-queryable":true
        },
        "MilestoneEventName":{
            "title":"Milestone Name",
            "type":"string",
            "description":"The name of the milestone event associated with the bill line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TransactionAmount":{
            "title":"Invoice Amount",
            "type":"number",
            "description":"The amount for which the transaction occurred.",
            "nullable":true,
            "x-queryable":true
        },
        "RecurringFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the line is recurring or not.",
            "nullable":false,
            "x-queryable":true
        },
        "BillLineId":{
            "type":"integer",
            "description":"The unique identifier of the bill line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DateBilledFrom":{
            "title":"Bill-from Date",
            "type":"string",
            "description":"The date from which the bill was generated.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "TransactionClassMeaning":{
            "title":"Class",
            "type":"string",
            "description":"The meaning of transaction class lookup.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The unique identifier of the charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PricingError":{
            "maxLength":1000,
            "type":"string",
            "description":"The error in pricing, if any.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the billing line was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BatchTag":{
            "title":"Batch Tag",
            "maxLength":30,
            "type":"string",
            "description":"Batch Tag",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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

• Array of: object subscriptionProducts-billLines-billAdjustments-item-response

{
    "title":"Bill Adjustments",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-billLines-billAdjustments-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionProducts-billLines-billAdjustments-item-response

Type: object

Show Source

• 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.
• ChargeAdjustmentPuid: string
  Title: Charge Adjustment PUID

  Maximum Length: 120

  Charge Adjustment Puid
• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the bill adjustment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AutoAdjustmentFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Indicates whether the adjustment is automatic or not.",
            "nullable":false,
            "x-queryable":true
        },
        "AdjustmentBasis":{
            "title":"Basis",
            "maxLength":30,
            "type":"string",
            "description":"The basis on which the bill is adjusted.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RevenueAdjustmentToDate":{
            "title":"Revenue Effective End Date",
            "type":"string",
            "description":"Revenue Adjustment To Date",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Reason":{
            "title":"Reason Details",
            "maxLength":120,
            "type":"string",
            "description":"The reason why the bill is adjusted.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "type":"string",
            "description":"The current code used for the bill adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"number",
            "description":"The sequence number of the bill adjustment.",
            "nullable":false,
            "x-queryable":true
        },
        "NumberOfPeriods":{
            "type":"number",
            "description":"The number of periods",
            "nullable":true,
            "x-queryable":true
        },
        "RevenueOption":{
            "title":"Revenue Accounting Option",
            "maxLength":30,
            "type":"string",
            "description":"Revenue Option",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillAdjustmentPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the bill adjustment.",
            "nullable":false,
            "x-queryable":true
        },
        "PeriodUntil":{
            "type":"number",
            "description":"The period until which the bill is adjusted.",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodFrom":{
            "type":"number",
            "description":"The period from which the bill was adjusted.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the bill adjustment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BillAdjustmentId":{
            "type":"integer",
            "description":"The unique identifier of the bill adjustment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RevenueAdjustmentFromDate":{
            "title":"Revenue Effective Start Date",
            "type":"string",
            "description":"Revenue Adjustment From Date",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the bill adjustment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeAdjustmentPuid":{
            "title":"Charge Adjustment PUID",
            "maxLength":120,
            "type":"string",
            "description":"Charge Adjustment Puid",
            "nullable":true,
            "x-queryable":false
        },
        "ChargeAdjustmentId":{
            "type":"integer",
            "description":"The unique identifier of the charge adjustment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AdjustmentReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code of the adjustment reason.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Effectivity":{
            "maxLength":30,
            "type":"string",
            "description":"The effectivity of the bill adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the bill adjustment.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdjustmentValue":{
            "title":"Value",
            "type":"number",
            "description":"The value by which the bill is adjusted.",
            "nullable":false,
            "x-queryable":true
        },
        "BillLineId":{
            "type":"integer",
            "description":"The unique identifier of the bill line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RevenuePeriod":{
            "title":"Revenue Effectivity Periods",
            "maxLength":30,
            "type":"string",
            "description":"Revenue Period",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdjustmentName":{
            "title":"Adjustment",
            "maxLength":120,
            "type":"string",
            "description":"The name of the bill adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "BasisEnableFlag":{
            "type":"boolean",
            "description":"Indicates if the base has been enabled for the bill adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the bill adjustment was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the bill adjustment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionProducts-charges-item-response

Type: object

Show Source

• 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
  Title: Aggregation Method

  Maximum Length: 30

  The aggregation method used for the charges.
• Allowance: number
  Title: Allowance

  The allowance part of the charge.
• AssetMeterYn: boolean
  Title: Asset Meter Flag

  Maximum Length: 1

  The flag whether it is an asset meter or not.
• BatchTag: string
  Title: Batch Tag

  Maximum Length: 30

  Batch Tag
• BillingFreq: string
  Title: Billing Frequency

  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.
• chargeComponents: array Subcription Product Charge Components Records
  Title: Subcription Product Charge Components Records

  The subscription product charge components records resoure is used to view the price details of the individual charge components of subscription products.
• ChargeDefinition: string
  Title: Charge Name

  Maximum Length: 30

  The definition that indicates the purpose of the charge.
• ChargeDefinitionName: string
  Title: Charge Definition

  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
  Title: Charge Period Code

  Maximum Length: 30

  The code of the charge period associated with the charge.
• ChargePuid: string
  Title: Charge PUID

  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)
  Title: Covered Level ID

  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
  Title: Enable Proration

  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
  Title: External Key

  Maximum Length: 120

  The external key used to measure the charge.
• ExternalParentKey: string
  Title: External Parent Key

  Maximum Length: 120

  The external parent key.
• InitialMeterReadingId: integer (int64)
  Title: Initial Meter Reading ID

  The initial meter reading identifier value.
• InvoicingRuleId: integer (int64)
  Title: Invoicing Rule Id

  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)
  Title: Meter Definition ID

  The unique identifier of the meter definition associated with the charges.
• MeterId: integer (int64)
  Title: Meter ID

  The unique identifier of the meter associated with the charges.
• MilestoneBillingFlag: boolean
  Title: Enable Milestone Based Billing

  Indicates whether the billing is impacted by milestone events or not.
• MilestoneRevenueFlag: boolean
  Title: Enable Milestone Based Revenue Recognition

  Indicates whether the revenue is impacted by milestone events or not.
• MilestoneTemplateId: integer (int64)
  Title: Template

  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
  Title: Enable Periodic Billing

  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
  Title: Periodicity

  The name of the price periodicity.
• PriceType: string
  Title: Price Type

  Maximum Length: 30

  The price type associated with the charge.
• QuotedTcv: number
  Title: Total Charge Amount

  The quoted TCV of the charge.
• RecurringPricePeriodicityCode: string
  Title: Recurring Price Periodicity Code

  Maximum Length: 30

  The recurring price periodicity code of the charge.
• RollupFlag: boolean
  Title: Rollup Flag

  Maximum Length: 1

  Indicates if the charge needs to be rolled up.
• SequenceNumber: integer (int32)
  Title: Sequence Number

  The sequence number for the charge.
• SubscriptionId: integer (int64)
  Title: Subscription ID

  The unique identifier of the subscription.
• SubscriptionProductId: integer (int64)
  Title: Subscription Product ID

  The unique identifier of the subscription product.
• TieredFlag: boolean
  Title: Tiered

  Maximum Length: 3

  Indicates whether the charge has tiers.
• TieredPricingHeaderId: integer
  Title: Tiered Pricing Header ID

  Tiered Pricing Header Id
• 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
  Title: Usage Price Lock

  Maximum Length: 3

  Indicates whether the usage price is locked or not.
• UsageUnitOfMeasure: string
  Title: Usage UOM

  Maximum Length: 3

  The usage unit of measure of the charge.

{
    "type":"object",
    "properties":{
        "AggregationMethod":{
            "title":"Aggregation Method",
            "maxLength":30,
            "type":"string",
            "description":"The aggregation method used for the charges.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the charge was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargePuid":{
            "title":"Charge PUID",
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "chargeMilestoneEvents":{
            "title":"Charge Milestone Events",
            "type":"array",
            "description":"The charge milestone events resource is used to view, create, update, and delete the milestone events associated with a charge of a subscription.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-charges-chargeMilestoneEvents-item-response"
            }
        },
        "adjustments":{
            "title":"Adjustments",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-charges-adjustments-item-response"
            }
        },
        "ChargeDefinition":{
            "title":"Charge Name",
            "maxLength":30,
            "type":"string",
            "description":"The definition that indicates the purpose of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "AssetMeterYn":{
            "title":"Asset Meter Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"The flag whether it is an asset meter or not.",
            "nullable":true,
            "x-queryable":true
        },
        "EstimatedAmount":{
            "title":"Estimated Amount",
            "type":"number",
            "description":"The estimated amount of the charges.",
            "nullable":true,
            "x-queryable":true
        },
        "PricePeriodicityName":{
            "title":"Periodicity",
            "type":"string",
            "description":"The name of the price periodicity.",
            "nullable":true,
            "x-queryable":true
        },
        "PrePaymentNumber":{
            "title":"Prepayment Number",
            "type":"integer",
            "description":"The prepayment number for the charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "BillingFreq":{
            "title":"Billing Frequency",
            "maxLength":30,
            "type":"string",
            "description":"Billing Frequency",
            "nullable":true,
            "x-queryable":true
        },
        "MeterDefinitionId":{
            "title":"Meter Definition ID",
            "type":"integer",
            "description":"The unique identifier of the meter definition associated with the charges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EstimationMethod":{
            "title":"Estimation Method",
            "maxLength":30,
            "type":"string",
            "description":"The method used to estimate the amount.",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodicBillingFlag":{
            "title":"Enable Periodic Billing",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether periodic billing is allowed or not.",
            "nullable":true,
            "x-queryable":true
        },
        "MilestoneBillingFlag":{
            "title":"Enable Milestone Based Billing",
            "type":"boolean",
            "description":"Indicates whether the billing is impacted by milestone events or not.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "ExternalParentKey":{
            "title":"External Parent Key",
            "maxLength":120,
            "type":"string",
            "description":"The external parent key.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitListPrice":{
            "title":"List Price",
            "type":"number",
            "description":"The price of the unit list.",
            "nullable":true,
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence Number",
            "type":"integer",
            "description":"The sequence number for the charge.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "InitialMeterReadingId":{
            "title":"Initial Meter Reading ID",
            "type":"integer",
            "description":"The initial meter reading identifier value.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscriptionProductId":{
            "title":"Subscription Product ID",
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the charge.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EstimatedQuantity":{
            "title":"Estimated Quantity",
            "type":"number",
            "description":"The estimated quantity for the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "chargeComponents":{
            "title":"Subcription Product Charge Components Records",
            "type":"array",
            "description":"The subscription product charge components records resoure is used to view the price details of the individual charge components of subscription products.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-charges-chargeComponents-item-response"
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the charge.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeName":{
            "title":"Charge Name",
            "maxLength":120,
            "type":"string",
            "description":"The name of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "RecurringPricePeriodicityCode":{
            "title":"Recurring Price Periodicity Code",
            "maxLength":30,
            "type":"string",
            "description":"The recurring price periodicity code of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "QuotedTcv":{
            "title":"Total Charge Amount",
            "type":"number",
            "description":"The quoted TCV of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "TieredFlag":{
            "title":"Tiered",
            "maxLength":3,
            "type":"boolean",
            "description":"Indicates whether the charge has tiers.",
            "nullable":true,
            "x-queryable":true
        },
        "UsagePriceLockFlag":{
            "title":"Usage Price Lock",
            "maxLength":3,
            "type":"boolean",
            "description":"Indicates whether the usage price is locked or not.",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodicRevenueFlag":{
            "title":"Enable Periodic Revenue Recognition",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the periodic revenue recognition of one-time charges.",
            "nullable":true,
            "x-queryable":true
        },
        "MilestoneRevenueFlag":{
            "title":"Enable Milestone Based Revenue Recognition",
            "type":"boolean",
            "description":"Indicates whether the revenue is impacted by milestone events or not.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "chargeTiers":{
            "title":"Charge Tiers",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-charges-chargeTiers-item-response"
            }
        },
        "MinimumAmount":{
            "title":"Minimum Amount",
            "type":"number",
            "description":"The minimum amount to be charged.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceType":{
            "title":"Price Type",
            "maxLength":30,
            "type":"string",
            "description":"The price type associated with the charge.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RollupFlag":{
            "title":"Rollup Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the charge needs to be rolled up.",
            "nullable":true,
            "x-queryable":true
        },
        "TierType":{
            "title":"Tier Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the charge tier.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TieredPricingHeaderId":{
            "title":"Tiered Pricing Header ID",
            "type":"integer",
            "description":"Tiered Pricing Header Id",
            "nullable":true,
            "x-queryable":false
        },
        "InvoicingRuleName":{
            "title":"Invoicing Rule",
            "type":"string",
            "description":"The name of the invoice rule.",
            "nullable":true,
            "x-queryable":false
        },
        "MeterId":{
            "title":"Meter ID",
            "type":"integer",
            "description":"The unique identifier of the meter associated with the charges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeDefinitionName":{
            "title":"Charge Definition",
            "type":"string",
            "description":"The name of the charge definition.",
            "nullable":true,
            "x-queryable":true
        },
        "UsageUnitOfMeasure":{
            "title":"Usage UOM",
            "maxLength":3,
            "type":"string",
            "description":"The usage unit of measure of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "title":"Subscription ID",
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EnableProration":{
            "title":"Enable Proration",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether proration is enabled or not.",
            "nullable":true,
            "x-queryable":true
        },
        "TrueUpPeriodName":{
            "title":"True Up Period",
            "type":"string",
            "description":"The name of the trueup period.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ExternalKey":{
            "title":"External Key",
            "maxLength":120,
            "type":"string",
            "description":"The external key used to measure the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargePeriodCode":{
            "title":"Charge Period Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the charge period associated with the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "Allowance":{
            "title":"Allowance",
            "type":"number",
            "description":"The allowance part of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoicingRuleId":{
            "title":"Invoicing Rule Id",
            "type":"integer",
            "description":"The ID of the invoice rule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MilestoneTemplateName":{
            "maxLength":120,
            "type":"string",
            "description":"The name of the milestone template associated with a charge.",
            "nullable":true,
            "x-queryable":false
        },
        "MilestoneTemplateId":{
            "title":"Template",
            "type":"integer",
            "description":"The ID of the milestone event associated with a charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "CoveredLevelId":{
            "title":"Covered Level ID",
            "type":"integer",
            "description":"The unique identifier of the covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillingFreqName":{
            "title":"Billing Frequency",
            "maxLength":255,
            "type":"string",
            "description":"Billing Frequency Name",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MinimumQuantity":{
            "title":"Minimum Quantity",
            "type":"number",
            "description":"The minimum quantity that is allowed.",
            "nullable":true,
            "x-queryable":true
        },
        "EstimatedMethodName":{
            "title":"Estimation Method",
            "type":"string",
            "description":"The method used to estimate the amount.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PricePeriodicity":{
            "title":"Periodicity",
            "maxLength":30,
            "type":"string",
            "description":"The price periodicity for the charge. Indicates the frequency when the charge has to be applied.",
            "nullable":true,
            "x-queryable":true
        },
        "TrueUpPeriod":{
            "title":"True Up Period",
            "maxLength":30,
            "type":"string",
            "description":"The identifier of the trueup period.",
            "nullable":true,
            "default":"ORA_OSS_USAGE_BILLING_PERIOD",
            "x-queryable":true
        },
        "BillLineId":{
            "type":"integer",
            "description":"The unique identifier of the bill line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The unique identifier of the charge.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BlockSize":{
            "title":"Block Size",
            "type":"number",
            "description":"The block size of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the charge was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BatchTag":{
            "title":"Batch Tag",
            "maxLength":30,
            "type":"string",
            "description":"Batch Tag",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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

• Array of: object subscriptionProducts-charges-adjustments-item-response

{
    "title":"Adjustments",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-charges-adjustments-item-response"
    }
}

Nested Schema : Subcription Product Charge Components Records

Type: array

Title: Subcription Product Charge Components Records

The subscription product charge components records resoure is used to view the price details of the individual charge components of subscription products.

Show Source

• Array of: object subscriptionProducts-charges-chargeComponents-item-response

{
    "title":"Subcription Product Charge Components Records",
    "type":"array",
    "description":"The subscription product charge components records resoure is used to view the price details of the individual charge components of subscription products.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-charges-chargeComponents-item-response"
    }
}

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

• Array of: object subscriptionProducts-charges-chargeMilestoneEvents-item-response

{
    "title":"Charge Milestone Events",
    "type":"array",
    "description":"The charge milestone events resource is used to view, create, update, and delete the milestone events associated with a charge of a subscription.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-charges-chargeMilestoneEvents-item-response"
    }
}

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

• Array of: object subscriptionProducts-charges-chargeTiers-item-response

{
    "title":"Charge Tiers",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-charges-chargeTiers-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionProducts-charges-adjustments-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the adjustment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AutoAdjustmentFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Indicates whether the adjustment is automatic or not.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentBasis":{
            "title":"Basis",
            "maxLength":30,
            "type":"string",
            "description":"The basis of the adjustment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Reason":{
            "title":"Reason Description",
            "maxLength":120,
            "type":"string",
            "description":"The reason for the adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"integer",
            "description":"The sequence number of the adjustment.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "NumberOfPeriods":{
            "type":"number",
            "description":"The number of periods",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PeriodUntil":{
            "type":"number",
            "description":"The period until which the adjustment is initiated.",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodFrom":{
            "type":"number",
            "description":"The period from which the adjustment was initiated.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the adjustment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the adjustment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeAdjustmentPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the charge adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeAdjustmentId":{
            "type":"integer",
            "description":"The unique identifier of the charge adjustment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AdjustmentReasonCode":{
            "title":"Reason",
            "maxLength":30,
            "type":"string",
            "description":"The code of the adjustment reason.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Effectivity":{
            "title":"Effectivity",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment effectivity",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdjustmentType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the adjustment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdjustmentValue":{
            "title":"Value",
            "type":"number",
            "description":"The value of the adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The unique identifier of the charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AdjustmentReasonMeaning":{
            "title":"Reason",
            "type":"string",
            "description":"The translated adjustment reason.",
            "nullable":true,
            "x-queryable":false
        },
        "AdjustmentName":{
            "title":"Adjustment",
            "maxLength":120,
            "type":"string",
            "description":"The name of the adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the adjustment was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the adjustment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionProducts-charges-chargeComponents-item-response

Type: object

Show Source

• ChargeComponentId: integer (int64)
  The identifier of the charge component.
• ChargeComponentPuid: string
  Maximum Length: 120

  The PUID of the charge component.
• ChargeCurrency: string
  Title: Currency

  Maximum Length: 15

  The charge currency of the charge component.
• ChargeCurrencyExtAmount: number
  Title: Extended Amount

  The extended amount of the charge component in charge currency.
• ChargeCurrencyName: string
  Title: Currency

  Read Only: true

  Maximum Length: 80

  The name of the charge currency.
• ChargeCurrencyUnitPrice: number
  Title: Currency Unit Price

  The unit price of the charge component in charge currency.
• ChargeId: integer (int64)
  Title: Charge ID

  The identifier of the charge.
• CoverageExtendedAmount: number
  Title: Coverage Extended Amount

  The extended coverage amount of the charge component.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Read Only: true

  The date when the record was created.
• Explanation: string
  Title: Explanation

  Maximum Length: 1000

  The explanation for the charge component.
• ExplanationMessageName: string
  Title: Explanation Message

  Maximum Length: 30

  The explanation message name of the charge component.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the subscription was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the subscription.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the subscription.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  The object version number of the charge component.
• Price: number
  Title: Amount

  The price of the charge component.
• PriceElement: string
  Title: Price Element

  Maximum Length: 30

  The price element of the charge component.
• PriceElementName: string
  Title: Price Element

  Read Only: true

  Maximum Length: 80

  The name of the price element associated with the charge component.
• PriceElementUsage: string
  Title: Price Element Usage

  Maximum Length: 30

  The price element usage of the charge component.
• PriceElementUsageName: string
  Title: Price Element Usage

  Read Only: true

  Maximum Length: 80

  The name of the price element usage associated with the charge component.
• PriceforQuantity: number
  Title: Price

  The price for quantity of the charge component.
• PricingSourceId: integer (int64)
  The identifier of the pricing source of the charge component.
• PricingSourceType: string
  Title: Pricing Source Type

  Maximum Length: 30

  The type of pricing source of the charge component.
• PricingSourceTypeName: string
  Title: Pricing Source Type

  Read Only: true

  Maximum Length: 80

  The name of the pricing source type.
• RollupFlag: boolean
  Title: Rollup Flag

  Maximum Length: 1

  The indicator of whether charge component should be rolled up or not.
• SequenceNumber: integer (int32)
  Title: Sequence Number

  The sequence number of the charge component.
• SubscriptionCurrency: string
  Title: Subscription Currency

  Maximum Length: 15

  The subscription currency of the charge component.
• SubscriptionCurrencyName: string
  Title: Subscription Currency

  Read Only: true

  Maximum Length: 80

  The name of the subscription currency.
• SubscriptionId: integer (int64)
  Title: Subscription ID

  The identifier of the subscription.
• TaxIncludedFlag: boolean
  Title: Tax Included Flag

  Maximum Length: 1

  The indicator of whether tax is included for the charge component or not.
• UnitPrice: number
  Title: Unit Price

  The unit price of the charge component.

{
    "type":"object",
    "properties":{
        "ChargeComponentPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The PUID of the charge component.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RollupFlag":{
            "title":"Rollup Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"The indicator of whether charge component should be rolled up or not.",
            "nullable":true,
            "x-queryable":true
        },
        "Explanation":{
            "title":"Explanation",
            "maxLength":1000,
            "type":"string",
            "description":"The explanation for the charge component.",
            "nullable":true,
            "x-queryable":true
        },
        "PricingSourceId":{
            "type":"integer",
            "description":"The identifier of the pricing source of the charge component.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaxIncludedFlag":{
            "title":"Tax Included Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"The indicator of whether tax is included for the charge component or not.",
            "nullable":true,
            "x-queryable":true
        },
        "CoverageExtendedAmount":{
            "title":"Coverage Extended Amount",
            "type":"number",
            "description":"The extended coverage amount of the charge component.",
            "nullable":true,
            "x-queryable":true
        },
        "PricingSourceType":{
            "title":"Pricing Source Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of pricing source of the charge component.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeCurrencyUnitPrice":{
            "title":"Currency Unit Price",
            "type":"number",
            "description":"The unit price of the charge component in charge currency.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "title":"Subscription ID",
            "type":"integer",
            "description":"The identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeComponentId":{
            "type":"integer",
            "description":"The identifier of the charge component.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the charge component.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence Number",
            "type":"integer",
            "description":"The sequence number of the charge component.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PricingSourceTypeName":{
            "title":"Pricing Source Type",
            "maxLength":80,
            "type":"string",
            "description":"The name of the pricing source type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PriceforQuantity":{
            "title":"Price",
            "type":"number",
            "description":"The price for quantity of the charge component.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceElementUsage":{
            "title":"Price Element Usage",
            "maxLength":30,
            "type":"string",
            "description":"The price element usage of the charge component.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the subscription.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExplanationMessageName":{
            "title":"Explanation Message",
            "maxLength":30,
            "type":"string",
            "description":"The explanation message name of the charge component.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeCurrency":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The charge currency of the charge component.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceElementUsageName":{
            "title":"Price Element Usage",
            "maxLength":80,
            "type":"string",
            "description":"The name of the price element usage associated with the charge component.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PriceElementName":{
            "title":"Price Element",
            "maxLength":80,
            "type":"string",
            "description":"The name of the price element associated with the charge component.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriptionCurrencyName":{
            "title":"Subscription Currency",
            "maxLength":80,
            "type":"string",
            "description":"The name of the subscription currency.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitPrice":{
            "title":"Unit Price",
            "type":"number",
            "description":"The unit price of the charge component.",
            "nullable":true,
            "x-queryable":true
        },
        "Price":{
            "title":"Amount",
            "type":"number",
            "description":"The price of the charge component.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceElement":{
            "title":"Price Element",
            "maxLength":30,
            "type":"string",
            "description":"The price element of the charge component.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionCurrency":{
            "title":"Subscription Currency",
            "maxLength":15,
            "type":"string",
            "description":"The subscription currency of the charge component.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeCurrencyName":{
            "title":"Currency",
            "maxLength":80,
            "type":"string",
            "description":"The name of the charge currency.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeCurrencyExtAmount":{
            "title":"Extended Amount",
            "type":"number",
            "description":"The extended amount of the charge component in charge currency.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeId":{
            "title":"Charge ID",
            "type":"integer",
            "description":"The identifier of the charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the subscription.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionProducts-charges-chargeMilestoneEvents-item-response

Type: object

Show Source

• BillingOffset: number
  The billing offset associated with a milestone event.
• BillLineId: integer (int64)
  The bill line ID associated with the milestone event.
• BillLinePuid: string
  Title: Bill Line PUID

  Maximum Length: 120

  Bill Line Puid
• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who updated the milestone event the last.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date on which the milestone event was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BillingOffset":{
            "type":"number",
            "description":"The billing offset associated with a milestone event.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargePuid":{
            "maxLength":120,
            "type":"string",
            "description":"The PUID of the charge to which the milestone event is associated.",
            "nullable":true,
            "default":"Charges.ChargePuid",
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The login of the user who created the milestone event.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpectedCompletionDate":{
            "type":"string",
            "description":"The expected completion date of a milestone event.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "EventType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of the milestone event.",
            "nullable":false,
            "x-queryable":true
        },
        "Percentage":{
            "type":"number",
            "description":"The percentage associated with a milestone event.",
            "nullable":false,
            "x-hints":{
                "precision":5,
                "scale":2
            },
            "x-queryable":true
        },
        "MilestoneName":{
            "maxLength":30,
            "type":"string",
            "description":"The name of the milestone event.",
            "nullable":false,
            "x-queryable":true
        },
        "MilestoneComment":{
            "maxLength":300,
            "type":"string",
            "description":"The milestone event comment.",
            "nullable":true,
            "x-queryable":true
        },
        "MilestonePuid":{
            "maxLength":120,
            "type":"string",
            "description":"The milestone event PUID.",
            "nullable":true,
            "x-queryable":true
        },
        "EventSource":{
            "maxLength":30,
            "type":"string",
            "description":"The source of the milestone event.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the milestone event.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "EventId":{
            "type":"integer",
            "description":"The ID of the milestone event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EventSourceReference":{
            "maxLength":120,
            "type":"string",
            "description":"The source reference of the milestone event.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BillLineId":{
            "type":"integer",
            "description":"The bill line ID associated with the milestone event.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The charge ID with which the milestone event is associated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillLinePuid":{
            "title":"Bill Line PUID",
            "maxLength":120,
            "type":"string",
            "description":"Bill Line Puid",
            "nullable":true,
            "x-queryable":false
        },
        "CompletionDate":{
            "type":"string",
            "description":"The completion date of the milestone event.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BillingOffset"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date of which the milestone event was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login which updated the milestone event the last.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionProducts-charges-chargeTiers-item-response

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the charge tier was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdditionalTimestampTwo":{
            "title":"Additional Time-stamp Two",
            "type":"string",
            "description":"Additional timestamp, if any, for the charge tier.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeTierPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the charge tier.",
            "nullable":false,
            "x-queryable":true
        },
        "AdditionalNumberThree":{
            "title":"Additional Number Three",
            "type":"number",
            "description":"Additional number, if any, for the charge tier.",
            "nullable":true,
            "x-queryable":true
        },
        "ListPrice":{
            "title":"List Price",
            "type":"number",
            "description":"The list price",
            "nullable":false,
            "x-queryable":true
        },
        "AdditionalNumberFive":{
            "title":"Additional Number Five",
            "type":"number",
            "description":"Additional number, if any, for the charge tier.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TierTo":{
            "title":"Tier To",
            "type":"number",
            "description":"The tier to",
            "nullable":true,
            "x-queryable":true
        },
        "AddtionalTextThree":{
            "title":"Additional Text Three",
            "maxLength":4000,
            "type":"string",
            "description":"Additional text, if any, for the charge tier.",
            "nullable":true,
            "x-queryable":true
        },
        "SequenceNumber":{
            "type":"number",
            "description":"The sequence number",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TierFrom":{
            "title":"Tier From",
            "type":"number",
            "description":"The tier from",
            "nullable":false,
            "x-queryable":true
        },
        "AdditionalNumberTwo":{
            "title":"Additional Number Two",
            "type":"number",
            "description":"Additional number, if any, for the charge tier.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the charge tier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeTierId":{
            "type":"integer",
            "description":"The unique identifier of the charge tier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the charge tier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdditionalNumberFour":{
            "title":"Additional Number Four",
            "type":"number",
            "description":"Additional number, if any, for the charge tier.",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalTimestampOne":{
            "title":"Additional Time-stamp One",
            "type":"string",
            "description":"Additional timestamp, if any, for the charge tier.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PriceFormat":{
            "title":"Price Format",
            "maxLength":30,
            "type":"string",
            "description":"The display format of the price.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdditionalTextOne":{
            "title":"Additional Text One",
            "maxLength":4000,
            "type":"string",
            "description":"Additional text, if any, for the charge tier.",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalNumberSix":{
            "title":"Additional Number Six",
            "type":"number",
            "description":"Additional number, if any, for the charge tier.",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalNumberOne":{
            "title":"Additional Number One",
            "type":"number",
            "description":"Additional number, if any, for the charge tier.",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalTextTwo":{
            "title":"Additional Text Two",
            "maxLength":4000,
            "type":"string",
            "description":"Additional text, if any, for the charge tier.",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalTimestampThree":{
            "title":"Additional Time-stamp Three",
            "type":"string",
            "description":"Additional timestamp, if any, for the charge tier.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The unique identifier of the charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BlockSize":{
            "title":"Block Size",
            "type":"number",
            "description":"The block size",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the charge tier was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the charge tier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionProducts-coveredLevels-item-response

Type: object

Show Source

• Address: string
  Title: Address

  The address of the party site.
• AssetGroupId: integer (int64)
  Title: Asset Group ID

  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)
  Title: Asset ID

  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.
• BatchTag: string
  Title: Batch Tag

  Maximum Length: 30

  Batch Tag
• 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.
• CalculateEstimatedTaxFlag: boolean
  Indicates whether estimated tax will be calculated for the subscription covered level.
• CancelDescription: string
  Title: Cancellation Description

  Maximum Length: 2000

  The cancellation description associated with a covered level.
• CanceledAmount: number
  Title: Canceled Amount

  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
  Title: Closed Amount

  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
  Title: Currency Code

  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)
  Title: Covered Level ID

  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
  Title: Covered Level PUID

  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
  Title: Credited Amount

  The amount that was credited.
• CreditType: string
  Title: Credit Type

  Maximum Length: 30

  Indicates the type of credit to be issued to the customer on close and amend.
• CurcyConvRateType: string
  Title: Conversion Rate Type

  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
  Title: Currency Code

  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)
  Title: Customer Account ID

  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.
• GenBillSchReqdFlag: boolean
  Title: Billing schedule update required

  Maximum Length: 1

  Generate Bill Schedule Required Flag
• GenerateBillingSchedule: string
  Indicates whether the billing schedule is to be generated.
• HierarchyTotal: number
  The total covered level of the hierarchy.
• InventoryItemId: integer (int64)
  Title: Item ID

  The unique identifier of the inventory item.
• InvoicedAmount: number
  Title: Invoiced Amount

  The amount for which the invoice was created.
• InvoiceText: string
  Maximum Length: 2000

  The text included in the invoice.
• ItemUnitOfMeasure: string
  Title: UOM

  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)
  Title: Parent Covered Asset ID

  The unique identifier of the parent covered asset.
• ParentCoveredLevelId: integer (int64)
  Title: Parent Covered Level ID

  The unique identifier of the parent covered level.
• PartyId: integer (int64)
  Title: Party ID

  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)
  Title: Party Site ID

  The unique identifier of the party site.
• Period: string
  Maximum Length: 80

  The period of the covered level.
• PriceAsOf: string (date)
  Title: Price as of Date

  The price as of a certain date.
• PriceListId: integer (int64)
  Title: Price List

  The unique identifier of the price list.
• PriceUnitOfMeasure: string
  Title: Pricing UOM

  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
  Title: Pricing Error

  Maximum Length: 1000

  The error in the pricing, if any.
• productAssetRelationships: array Covered Level Relationships
  Title: Covered Level Relationships

  The covered level relationships resource is used to view the relationship between a source and a target covered level. These relationships include amendment, renewal, suspension relationships.
• ProductGroupId: integer (int64)
  Title: Product Group ID

  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)
  Title: Renewed On

  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.
• RequestedPriceListId: integer (int64)
  Title: Override Price List

  The identifier of the requested price list.
• 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
  Title: Configured Asset Amount

  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
  Title: Source Key

  Maximum Length: 120

  The source key of the covered level.
• SourceLineKey: string
  Title: Source Line Key

  Maximum Length: 120

  The source line key of the covered level.
• SourceLineNumber: string
  Title: External Source Line Number

  Maximum Length: 120

  The source line number of the covered level.
• SourceNumber: string
  Title: External Source Number

  Maximum Length: 120

  The source number of the covered level.
• SourceSystem: string
  Title: External Source System

  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)
  Title: Subscription ID

  The unique identifier of the subscription.
• SubscriptionProductId: integer (int64)
  Title: Subscription Product ID

  The unique identifier of the subscription product.
• SuppressedCreditAmount: number
  Title: Suppressed Credit Amount

  The credit amount that was suppressed.
• SuspendCreditMethod: string
  Title: Suspend Credit Method

  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
  Title: Tax Amount

  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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the covered level was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CalculatedCreditAmount":{
            "title":"Calculated Credit Amount",
            "type":"number",
            "description":"The calculated credit amount of the covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "Address":{
            "title":"Address",
            "type":"string",
            "description":"The address of the party site.",
            "nullable":true,
            "x-queryable":false
        },
        "CancelDescription":{
            "title":"Cancellation Description",
            "maxLength":2000,
            "type":"string",
            "description":"The cancellation description associated with a covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductGroupName":{
            "title":"Product Group Name",
            "type":"string",
            "description":"The name of the product group.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "RollupTotal":{
            "title":"Configured Asset Amount",
            "type":"number",
            "description":"The rollup total of covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentCoveredAssetId":{
            "title":"Parent Covered Asset ID",
            "type":"integer",
            "description":"The unique identifier of the parent covered asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "relationships":{
            "title":"Relationships",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-relationships-item-response"
            }
        },
        "TaxAmount":{
            "title":"Tax Amount",
            "type":"number",
            "description":"The tax amount levied on the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceKey":{
            "title":"Source Key",
            "maxLength":120,
            "type":"string",
            "description":"The source key of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CloseReason":{
            "title":"Covered Level Close Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason why the covered level was closed.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CoveredLevelParentPuid":{
            "type":"string",
            "description":"The alternate unique identifier of the covered level parent.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceNumber":{
            "title":"External Source Number",
            "maxLength":120,
            "type":"string",
            "description":"The source number of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "PartySiteId":{
            "title":"Party Site ID",
            "type":"integer",
            "description":"The unique identifier of the party site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CanceledDate":{
            "title":"Canceled Date",
            "type":"string",
            "description":"The date when the covered level was canceled.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ExplodeAssetHierarchy":{
            "type":"string",
            "description":"Indicates if the assest hierarchy should be copied to other hierarchies.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionProductId":{
            "title":"Subscription Product ID",
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the covered level.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Covered Level Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the covered level.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetGroupNumber":{
            "title":"Asset Group Number",
            "type":"string",
            "description":"The alternate identifier of an asset group.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "InventoryItemId":{
            "title":"Item ID",
            "type":"integer",
            "description":"The unique identifier of the inventory item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreditedAmount":{
            "title":"Credited Amount",
            "type":"number",
            "description":"The amount that was credited.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusName":{
            "title":"Status",
            "type":"string",
            "description":"The meaning of the status of the covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "charges":{
            "title":"Charges",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-charges-item-response"
            }
        },
        "SuppressedCreditAmount":{
            "title":"Suppressed Credit Amount",
            "type":"number",
            "description":"The credit amount that was suppressed.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceListId":{
            "title":"Price List",
            "type":"integer",
            "description":"The unique identifier of the price list.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssetId":{
            "title":"Asset ID",
            "type":"integer",
            "description":"The unique identifier of the asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InvoicedAmount":{
            "title":"Invoiced Amount",
            "type":"number",
            "description":"The amount for which the invoice was created.",
            "nullable":true,
            "x-queryable":true
        },
        "SuspendedDate":{
            "title":"Covered Level Suspend Date",
            "type":"string",
            "description":"The date when the covered level was suspended.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the covered level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetGroupName":{
            "title":"Asset Group Name",
            "type":"string",
            "description":"The name of the asset group.",
            "nullable":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Covered Level Description",
            "type":"string",
            "description":"A brief description of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CanceledAmount":{
            "title":"Canceled Amount",
            "type":"number",
            "description":"The amount that was canceled.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestedPriceListId":{
            "title":"Override Price List",
            "type":"integer",
            "description":"The identifier of the requested price list.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "LineNumber":{
            "title":"Number",
            "maxLength":300,
            "type":"string",
            "description":"The line number",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionId":{
            "title":"Subscription ID",
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CoveredLevelPuid":{
            "title":"Covered Level PUID",
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the covered level.",
            "nullable":false,
            "x-queryable":true
        },
        "RevenueOption":{
            "title":"Revenue Accounting Option",
            "maxLength":30,
            "type":"string",
            "description":"Revenue Option",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "billLines":{
            "title":"Bill Lines",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-billLines-item-response"
            }
        },
        "TotalContractValue":{
            "title":"Covered Level Contract Value",
            "type":"number",
            "description":"The total contract value associated with the covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "SuspendReason":{
            "title":"Covered Level Suspend Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason for suspending the credit method for the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CoveredLevelId":{
            "title":"Covered Level ID",
            "type":"integer",
            "description":"The unique identifier of the covered level.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "HierarchyTotal":{
            "type":"number",
            "description":"The total covered level of the hierarchy.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"Covered Level End Date",
            "type":"string",
            "description":"The date when the covered level ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ClosedAmount":{
            "title":"Closed Amount",
            "type":"number",
            "description":"The amount at which the covered level was closed.",
            "nullable":true,
            "x-queryable":true
        },
        "CoveredLevlName":{
            "title":"Covered Level Name",
            "type":"string",
            "description":"The name of the covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "OverrideCreditAmount":{
            "title":"Override Credit Amount",
            "type":"number",
            "description":"The override credit amount of the covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "CalculateEstimatedTaxFlag":{
            "type":"boolean",
            "description":"Indicates whether estimated tax will be calculated for the subscription covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "Type":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the covered level.",
            "nullable":false,
            "x-queryable":true
        },
        "UnitPrice":{
            "title":"Unit Price",
            "type":"number",
            "description":"The unit price of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "GenerateBillingSchedule":{
            "type":"string",
            "description":"Indicates whether the billing schedule is to be generated.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ClosedDate":{
            "title":"Covered Level Close Date",
            "type":"string",
            "description":"The date when the covered level was closed.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "CloseDescription":{
            "title":"Covered Level Close Description",
            "maxLength":2000,
            "type":"string",
            "description":"The close description associated with a covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystem":{
            "title":"External Source System",
            "maxLength":30,
            "type":"string",
            "description":"The source system of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the covered level was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TypeName":{
            "title":"Covered Level Type",
            "type":"string",
            "description":"The name of the type of the covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ProductName":{
            "title":"Product Name",
            "type":"string",
            "description":"The name of the product associated with the covered level.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "productAssetRelationships":{
            "title":"Covered Level Relationships",
            "type":"array",
            "description":"The covered level relationships resource is used to view the relationship between a source and a target covered level. These relationships include amendment, renewal, suspension relationships.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-productAssetRelationships-item-response"
            }
        },
        "ParentCoveredLevelId":{
            "title":"Parent Covered Level ID",
            "type":"integer",
            "description":"The unique identifier of the parent covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Party Name",
            "type":"string",
            "description":"The name of the party.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "SuspendCreditMethod":{
            "title":"Suspend Credit Method",
            "maxLength":30,
            "type":"string",
            "description":"Indicates if the credit method has to be suspended.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Covered Level Start Date",
            "type":"string",
            "description":"The date when the covered level starts.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "CustomerNumber":{
            "title":"Customer Account Number",
            "type":"string",
            "description":"The alternate unique identifier of the customer.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "AssetGroupId":{
            "title":"Asset Group ID",
            "type":"integer",
            "description":"The unique identifier of the asset group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CorpCurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemUnitOfMeasure":{
            "title":"UOM",
            "maxLength":15,
            "type":"string",
            "description":"The unit of measure used to measure the items in the covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "CoveredLevelName":{
            "title":"Covered Level Name",
            "maxLength":300,
            "type":"string",
            "description":"The name of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "Period":{
            "maxLength":80,
            "type":"string",
            "description":"The period of the covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Duration":{
            "type":"integer",
            "description":"The duration of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "RenewalType":{
            "title":"Renewal Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the covered level renewal.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssetName":{
            "title":"Covered Level Asset Name",
            "type":"string",
            "description":"The name of the asset.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "AssetSerialNumber":{
            "title":"Covered Asset Serial Number",
            "type":"string",
            "description":"The serial number of the asset.",
            "nullable":true,
            "x-queryable":true
        },
        "CancelReason":{
            "title":"Cancellation Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason for cancelling the covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SerialNumber":{
            "title":"Covered Asset Serial Number",
            "maxLength":80,
            "type":"string",
            "description":"The serial number of the covered level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PriceUnitOfMeasureName":{
            "title":"Pricing UOM",
            "type":"string",
            "description":"The display name of the unit of measure.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ReturnCreditMethod":{
            "title":"Close Credit Method",
            "maxLength":230,
            "type":"string",
            "description":"The method used to return the credit.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SourceLineNumber":{
            "title":"External Source Line Number",
            "maxLength":120,
            "type":"string",
            "description":"The source line number of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CoveredLevlNumber":{
            "title":"Covered Level Number",
            "type":"string",
            "description":"The alternate identifier of the covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductGroupNumber":{
            "title":"Product Group Number",
            "type":"string",
            "description":"The alternate identifier of a product group.",
            "nullable":true,
            "x-queryable":false
        },
        "PriceAsOf":{
            "title":"Price as of Date",
            "type":"string",
            "description":"The price as of a certain date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PartySite":{
            "title":"Party Site Number",
            "type":"string",
            "description":"The name of the party site.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "InvoiceText":{
            "maxLength":2000,
            "type":"string",
            "description":"The text included in the invoice.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerAccountId":{
            "title":"Customer Account ID",
            "type":"integer",
            "description":"The unique identifier of the customer account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaxError":{
            "maxLength":4000,
            "type":"string",
            "description":"The tax error, if any, in the calculated amount.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerName":{
            "title":"Customer Account",
            "type":"string",
            "description":"The name of the customer.",
            "nullable":true,
            "x-queryable":false
        },
        "CreditType":{
            "title":"Credit Type",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of credit to be issued to the customer on close and amend.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "GenBillSchReqdFlag":{
            "title":"Billing schedule update required",
            "maxLength":1,
            "type":"boolean",
            "description":"Generate Bill Schedule Required Flag",
            "nullable":true,
            "x-queryable":true
        },
        "SourceLineKey":{
            "title":"Source Line Key",
            "maxLength":120,
            "type":"string",
            "description":"The source line key of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "ProductGroupId":{
            "title":"Product Group ID",
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RepriceFlag":{
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "RenewedDate":{
            "title":"Renewed On",
            "type":"string",
            "description":"The date when the covered level was renewed.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity of the covered level.",
            "nullable":false,
            "default":1,
            "x-queryable":true
        },
        "PriceUnitOfMeasure":{
            "title":"Pricing UOM",
            "maxLength":30,
            "type":"string",
            "description":"The unit of measure used to indicate the price.",
            "nullable":true,
            "x-queryable":true
        },
        "PutOnHoldFlag":{
            "type":"boolean",
            "description":"Indicates if the covered level has been put on hold.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyNumber":{
            "title":"Party Number",
            "type":"string",
            "description":"The alternate identifier of the party.",
            "nullable":true,
            "x-queryable":false
        },
        "RemoveHoldFlag":{
            "type":"boolean",
            "description":"Indicates if the hold on the covered level has to be removed.",
            "nullable":true,
            "x-queryable":false
        },
        "PricingError":{
            "title":"Pricing Error",
            "maxLength":1000,
            "type":"string",
            "description":"The error in the pricing, if any.",
            "nullable":true,
            "x-queryable":true
        },
        "BatchTag":{
            "title":"Batch Tag",
            "maxLength":30,
            "type":"string",
            "description":"Batch Tag",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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

• Array of: object subscriptionProducts-coveredLevels-billLines-item-response

{
    "title":"Bill Lines",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-billLines-item-response"
    }
}

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

• Array of: object subscriptionProducts-coveredLevels-charges-item-response

{
    "title":"Charges",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-charges-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Covered Level Relationships

Type: array

Title: Covered Level Relationships

The covered level relationships resource is used to view the relationship between a source and a target covered level. These relationships include amendment, renewal, suspension relationships.

Show Source

• Array of: object subscriptionProducts-coveredLevels-productAssetRelationships-item-response

{
    "title":"Covered Level Relationships",
    "type":"array",
    "description":"The covered level relationships resource is used to view the relationship between a source and a target covered level. These relationships include amendment, renewal, suspension relationships.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-productAssetRelationships-item-response"
    }
}

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

• Array of: object subscriptionProducts-coveredLevels-relationships-item-response

{
    "title":"Relationships",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-relationships-item-response"
    }
}

Nested Schema : subscriptionProducts-coveredLevels-billLines-item-response

Type: object

Show Source

• AdhocBillLineFlag: boolean
  Default Value: false

  Adhoc BillLine Flag
• Amount: number
  Title: Amount

  The amount for which the bill is generated.
• BatchTag: string
  Title: Batch Tag

  Maximum Length: 30

  Batch Tag
• 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
  Title: Charge PUID

  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
  Title: Credit Memo Reason Code

  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
  Title: Milestone Name

  The name of the milestone event associated with the bill line.
• MilestoneEventPuid: string
  Title: Milestone Event PUID

  Milestone Event Puid
• NewCreditMemoPUID: string
  The unique public identifier of the new credit memo.
• PricedQuantity: number
  Title: Priced Quantity

  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)
  Title: Usage Capture Date

  The date when the usage was captured.
• UsageChargeType: string
  Title: Usage Charge Type

  Maximum Length: 30

  The type of usage charge.
• UsageChargeTypeName: string
  Title: Usage Charge Type

  The name of the usage charge type.
• UsageFlag: boolean
  Maximum Length: 1

  Indicates whether the line is a usage line or not.
• UsageInvoiceAttachmentYn: string
  Maximum Length: 1

  Indicates whether usage events invoice attachment is associated with the bill line.
• 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.
• UsageRatingProcess: string
  Title: Usage Rating Process

  Maximum Length: 30

  Usage Rating Process

{
    "type":"object",
    "properties":{
        "TrxId":{
            "type":"integer",
            "description":"The AR transaction ID.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the billing line was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionTypeName":{
            "type":"string",
            "description":"The transaction type name of the subscription bill line.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargePuid":{
            "title":"Charge PUID",
            "type":"string",
            "description":"The public unique identifier of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeDefinition":{
            "maxLength":30,
            "type":"string",
            "description":"The definition that indicates the purpose of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "SentDate":{
            "title":"Sent Date",
            "type":"string",
            "description":"The date invoice information is sent to receivables.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "UsagePricedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the usage line has been priced or not.",
            "nullable":true,
            "x-queryable":true
        },
        "UsageRatingProcess":{
            "title":"Usage Rating Process",
            "maxLength":30,
            "type":"string",
            "description":"Usage Rating Process",
            "nullable":true,
            "x-queryable":true
        },
        "ListPrice":{
            "type":"number",
            "description":"The list price of the product associated with the bill line.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionTax":{
            "title":"Tax",
            "type":"number",
            "description":"The tax levied on the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "RevenueLineId":{
            "type":"integer",
            "description":"The unique identifier of the revenue line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreditMemoReason":{
            "type":"string",
            "description":"The reason to raise the credit memo.",
            "nullable":true,
            "x-queryable":false
        },
        "MilestoneEventPuid":{
            "title":"Milestone Event PUID",
            "type":"string",
            "description":"Milestone Event Puid",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillLinePuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the bill line.",
            "nullable":false,
            "x-queryable":true
        },
        "UsageFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the line is a usage line or not.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the billing line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UsageChargeTypeName":{
            "title":"Usage Charge Type",
            "type":"string",
            "description":"The name of the usage charge type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "billAdjustments":{
            "title":"Bill Adjustments",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-billLines-billAdjustments-item-response"
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the billing line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BillingPeriod":{
            "title":"Sequence",
            "type":"number",
            "description":"The period for which the bill is generated.",
            "nullable":false,
            "x-queryable":true
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"The ID of the business unit associated with the bill line.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargeName":{
            "title":"Charge Name",
            "maxLength":120,
            "type":"string",
            "description":"The name of the charge associated with the bill line.",
            "nullable":true,
            "x-queryable":true
        },
        "RetrieveInvoiceFlag":{
            "title":"Retrieve Invoice from Receivables",
            "maxLength":1,
            "type":"boolean",
            "description":"Retrieve Invoice Flag",
            "nullable":true,
            "x-queryable":true
        },
        "MilestoneEventId":{
            "type":"integer",
            "description":"The ID of the milestone event associated with the bill line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TrxLineId":{
            "type":"integer",
            "description":"The AR transaction line ID.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SummarizedBillLineId":{
            "title":"Summarized Bill Line ID",
            "type":"integer",
            "description":"Summarized Bill Line ID",
            "nullable":true,
            "x-queryable":true
        },
        "UsageCaptureDate":{
            "title":"Usage Capture Date",
            "type":"string",
            "description":"The date when the usage was captured.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "RevenuePeriod":{
            "title":"Revenue Effectivity Periods",
            "maxLength":30,
            "type":"string",
            "description":"Revenue Period",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the billing line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditMemoFlag":{
            "type":"string",
            "description":"Indicates if there is a credit memo associated with the bill line.",
            "nullable":true,
            "x-queryable":false
        },
        "DateToInterface":{
            "title":"Interface Date",
            "type":"string",
            "description":"The date to interface for the bill line.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "UsageChargeType":{
            "title":"Usage Charge Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of usage charge.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionNumber":{
            "title":"Invoice Number",
            "maxLength":30,
            "type":"string",
            "description":"The number of the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "NewCreditMemoPUID":{
            "type":"string",
            "description":"The unique public identifier of the new credit memo.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargePeriodFactor":{
            "type":"number",
            "description":"The change period factor associated with the bill line.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerTrxTypeSequenceId":{
            "type":"integer",
            "description":"Customer Transaction Type Sequence Id",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TruedUpYn":{
            "maxLength":3,
            "type":"string",
            "description":"Indicates if the bill line has a trueup period.",
            "nullable":true,
            "x-queryable":true
        },
        "CreditMemoReasonCode":{
            "title":"Credit Memo Reason Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the credit memo reason code.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InvoiceText":{
            "title":"Invoice Text",
            "maxLength":240,
            "type":"string",
            "description":"The text in the bill line invoice.",
            "nullable":true,
            "x-queryable":true
        },
        "CreditMemoAmount":{
            "type":"number",
            "description":"The amount for the credit memo.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionClass":{
            "title":"Transaction Class",
            "maxLength":30,
            "type":"string",
            "description":"The class of the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "UsageInvoiceAttachmentYn":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether usage events invoice attachment is associated with the bill line.",
            "nullable":true,
            "x-queryable":true
        },
        "AdhocBillLineFlag":{
            "type":"boolean",
            "description":"Adhoc BillLine Flag",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "RevenueOption":{
            "title":"Revenue Accounting Option",
            "maxLength":30,
            "type":"string",
            "description":"Revenue Option",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InvoiceDate":{
            "type":"string",
            "description":"The date when the invoice was raised.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ChargePeriod":{
            "title":"Period",
            "type":"number",
            "description":"The usage period that was charged.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionDate":{
            "title":"Invoice Date",
            "type":"string",
            "description":"The date when the transaction occurred.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceBillLineId":{
            "type":"integer",
            "description":"The unique identifier of the invoice bill line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UsageAcquiredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the usage has been acquired or not.",
            "nullable":true,
            "x-queryable":true
        },
        "InterfacedFlag":{
            "title":"Interfaced",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the bill line is interfaced or not.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount for which the bill is generated.",
            "nullable":true,
            "x-queryable":true
        },
        "DateBilledTo":{
            "title":"Bill-to Date",
            "type":"string",
            "description":"The date up to which the bill is generated.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "UsageQuantity":{
            "title":"Usage Quantity",
            "type":"number",
            "description":"The quantity of the usage.",
            "nullable":true,
            "x-queryable":true
        },
        "CoveredLevelId":{
            "type":"integer",
            "description":"The unique identifier of the covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PricedQuantity":{
            "title":"Priced Quantity",
            "type":"number",
            "description":"The quantity for which the bill line was charged.",
            "nullable":true,
            "x-queryable":true
        },
        "MilestoneEventName":{
            "title":"Milestone Name",
            "type":"string",
            "description":"The name of the milestone event associated with the bill line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TransactionAmount":{
            "title":"Invoice Amount",
            "type":"number",
            "description":"The amount for which the transaction occurred.",
            "nullable":true,
            "x-queryable":true
        },
        "RecurringFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the line is recurring or not.",
            "nullable":false,
            "x-queryable":true
        },
        "BillLineId":{
            "type":"integer",
            "description":"The unique identifier of the bill line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DateBilledFrom":{
            "title":"Bill-from Date",
            "type":"string",
            "description":"The date from which the bill was generated.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "TransactionClassMeaning":{
            "title":"Class",
            "type":"string",
            "description":"The meaning of transaction class lookup.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The unique identifier of the charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PricingError":{
            "maxLength":1000,
            "type":"string",
            "description":"The error in pricing, if any.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the billing line was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BatchTag":{
            "title":"Batch Tag",
            "maxLength":30,
            "type":"string",
            "description":"Batch Tag",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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

• Array of: object subscriptionProducts-coveredLevels-billLines-billAdjustments-item-response

{
    "title":"Bill Adjustments",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-billLines-billAdjustments-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionProducts-coveredLevels-billLines-billAdjustments-item-response

Type: object

Show Source

• 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.
• ChargeAdjustmentPuid: string
  Title: Charge Adjustment PUID

  Maximum Length: 120

  Charge Adjustment Puid
• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the bill adjustment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AutoAdjustmentFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Indicates whether the adjustment is automatic or not.",
            "nullable":false,
            "x-queryable":true
        },
        "AdjustmentBasis":{
            "title":"Basis",
            "maxLength":30,
            "type":"string",
            "description":"The basis on which the bill is adjusted.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RevenueAdjustmentToDate":{
            "title":"Revenue Effective End Date",
            "type":"string",
            "description":"Revenue Adjustment To Date",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Reason":{
            "title":"Reason Details",
            "maxLength":120,
            "type":"string",
            "description":"The reason why the bill is adjusted.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "type":"string",
            "description":"The current code used for the bill adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"number",
            "description":"The sequence number of the bill adjustment.",
            "nullable":false,
            "x-queryable":true
        },
        "NumberOfPeriods":{
            "type":"number",
            "description":"The number of periods",
            "nullable":true,
            "x-queryable":true
        },
        "RevenueOption":{
            "title":"Revenue Accounting Option",
            "maxLength":30,
            "type":"string",
            "description":"Revenue Option",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillAdjustmentPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the bill adjustment.",
            "nullable":false,
            "x-queryable":true
        },
        "PeriodUntil":{
            "type":"number",
            "description":"The period until which the bill is adjusted.",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodFrom":{
            "type":"number",
            "description":"The period from which the bill was adjusted.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the bill adjustment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BillAdjustmentId":{
            "type":"integer",
            "description":"The unique identifier of the bill adjustment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RevenueAdjustmentFromDate":{
            "title":"Revenue Effective Start Date",
            "type":"string",
            "description":"Revenue Adjustment From Date",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the bill adjustment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeAdjustmentPuid":{
            "title":"Charge Adjustment PUID",
            "maxLength":120,
            "type":"string",
            "description":"Charge Adjustment Puid",
            "nullable":true,
            "x-queryable":false
        },
        "ChargeAdjustmentId":{
            "type":"integer",
            "description":"The unique identifier of the charge adjustment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AdjustmentReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code of the adjustment reason.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Effectivity":{
            "maxLength":30,
            "type":"string",
            "description":"The effectivity of the bill adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the bill adjustment.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdjustmentValue":{
            "title":"Value",
            "type":"number",
            "description":"The value by which the bill is adjusted.",
            "nullable":false,
            "x-queryable":true
        },
        "BillLineId":{
            "type":"integer",
            "description":"The unique identifier of the bill line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RevenuePeriod":{
            "title":"Revenue Effectivity Periods",
            "maxLength":30,
            "type":"string",
            "description":"Revenue Period",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdjustmentName":{
            "title":"Adjustment",
            "maxLength":120,
            "type":"string",
            "description":"The name of the bill adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "BasisEnableFlag":{
            "type":"boolean",
            "description":"Indicates if the base has been enabled for the bill adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the bill adjustment was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the bill adjustment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionProducts-coveredLevels-charges-item-response

Type: object

Show Source

• 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
  Title: Aggregation Method

  Maximum Length: 30

  The aggregation method used for the charges.
• Allowance: number
  Title: Allowance

  The allowance part of the charge.
• AssetMeterYn: boolean
  Title: Asset Meter Flag

  Maximum Length: 1

  The flag whether it is an asset meter or not.
• BatchTag: string
  Title: Batch Tag

  Maximum Length: 30

  Batch Tag
• BillingFreq: string
  Title: Billing Frequency

  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.
• chargeComponents: array Subcription Product Charge Components Records
  Title: Subcription Product Charge Components Records

  The subscription product charge components records resoure is used to view the price details of the individual charge components of subscription products.
• ChargeDefinition: string
  Title: Charge Name

  Maximum Length: 30

  The definition that indicates the purpose of the charge.
• ChargeDefinitionName: string
  Title: Charge Definition

  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
  Title: Charge Period Code

  Maximum Length: 30

  The code of the charge period associated with the charge.
• ChargePuid: string
  Title: Charge PUID

  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)
  Title: Covered Level ID

  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
  Title: Enable Proration

  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
  Title: External Key

  Maximum Length: 120

  The external key used to measure the charge.
• ExternalParentKey: string
  Title: External Parent Key

  Maximum Length: 120

  The external parent key.
• InitialMeterReadingId: integer (int64)
  Title: Initial Meter Reading ID

  The initial meter reading identifier value.
• InvoicingRuleId: integer (int64)
  Title: Invoicing Rule Id

  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)
  Title: Meter Definition ID

  The unique identifier of the meter definition associated with the charges.
• MeterId: integer (int64)
  Title: Meter ID

  The unique identifier of the meter associated with the charges.
• MilestoneBillingFlag: boolean
  Title: Enable Milestone Based Billing

  Indicates whether the billing is impacted by milestone events or not.
• MilestoneRevenueFlag: boolean
  Title: Enable Milestone Based Revenue Recognition

  Indicates whether the revenue is impacted by milestone events or not.
• MilestoneTemplateId: integer (int64)
  Title: Template

  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
  Title: Enable Periodic Billing

  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
  Title: Periodicity

  The name of the price periodicity.
• PriceType: string
  Title: Price Type

  Maximum Length: 30

  The price type associated with the charge.
• QuotedTcv: number
  Title: Total Charge Amount

  The quoted TCV of the charge.
• RecurringPricePeriodicityCode: string
  Title: Recurring Price Periodicity Code

  Maximum Length: 30

  The recurring price periodicity code of the charge.
• RollupFlag: boolean
  Title: Rollup Flag

  Maximum Length: 1

  Indicates if the charge needs to be rolled up.
• SequenceNumber: integer (int32)
  Title: Sequence Number

  The sequence number for the charge.
• SubscriptionId: integer (int64)
  Title: Subscription ID

  The unique identifier of the subscription.
• SubscriptionProductId: integer (int64)
  Title: Subscription Product ID

  The unique identifier of the subscription product.
• TieredFlag: boolean
  Title: Tiered

  Maximum Length: 3

  Indicates whether the charge has tiers.
• TieredPricingHeaderId: integer
  Title: Tiered Pricing Header ID

  Tiered Pricing Header Id
• 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
  Title: Usage Price Lock

  Maximum Length: 3

  Indicates whether the usage price is locked or not.
• UsageUnitOfMeasure: string
  Title: Usage UOM

  Maximum Length: 3

  The usage unit of measure of the charge.

{
    "type":"object",
    "properties":{
        "AggregationMethod":{
            "title":"Aggregation Method",
            "maxLength":30,
            "type":"string",
            "description":"The aggregation method used for the charges.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the charge was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargePuid":{
            "title":"Charge PUID",
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "chargeMilestoneEvents":{
            "title":"Charge Milestone Events",
            "type":"array",
            "description":"The charge milestone events resource is used to view, create, update, and delete the milestone events associated with a charge of a subscription.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-charges-chargeMilestoneEvents-item-response"
            }
        },
        "adjustments":{
            "title":"Adjustments",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-charges-adjustments-item-response"
            }
        },
        "ChargeDefinition":{
            "title":"Charge Name",
            "maxLength":30,
            "type":"string",
            "description":"The definition that indicates the purpose of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "AssetMeterYn":{
            "title":"Asset Meter Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"The flag whether it is an asset meter or not.",
            "nullable":true,
            "x-queryable":true
        },
        "EstimatedAmount":{
            "title":"Estimated Amount",
            "type":"number",
            "description":"The estimated amount of the charges.",
            "nullable":true,
            "x-queryable":true
        },
        "PricePeriodicityName":{
            "title":"Periodicity",
            "type":"string",
            "description":"The name of the price periodicity.",
            "nullable":true,
            "x-queryable":true
        },
        "PrePaymentNumber":{
            "title":"Prepayment Number",
            "type":"integer",
            "description":"The prepayment number for the charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "BillingFreq":{
            "title":"Billing Frequency",
            "maxLength":30,
            "type":"string",
            "description":"Billing Frequency",
            "nullable":true,
            "x-queryable":true
        },
        "MeterDefinitionId":{
            "title":"Meter Definition ID",
            "type":"integer",
            "description":"The unique identifier of the meter definition associated with the charges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EstimationMethod":{
            "title":"Estimation Method",
            "maxLength":30,
            "type":"string",
            "description":"The method used to estimate the amount.",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodicBillingFlag":{
            "title":"Enable Periodic Billing",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether periodic billing is allowed or not.",
            "nullable":true,
            "x-queryable":true
        },
        "MilestoneBillingFlag":{
            "title":"Enable Milestone Based Billing",
            "type":"boolean",
            "description":"Indicates whether the billing is impacted by milestone events or not.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "ExternalParentKey":{
            "title":"External Parent Key",
            "maxLength":120,
            "type":"string",
            "description":"The external parent key.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitListPrice":{
            "title":"List Price",
            "type":"number",
            "description":"The price of the unit list.",
            "nullable":true,
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence Number",
            "type":"integer",
            "description":"The sequence number for the charge.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "InitialMeterReadingId":{
            "title":"Initial Meter Reading ID",
            "type":"integer",
            "description":"The initial meter reading identifier value.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscriptionProductId":{
            "title":"Subscription Product ID",
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the charge.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EstimatedQuantity":{
            "title":"Estimated Quantity",
            "type":"number",
            "description":"The estimated quantity for the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "chargeComponents":{
            "title":"Subcription Product Charge Components Records",
            "type":"array",
            "description":"The subscription product charge components records resoure is used to view the price details of the individual charge components of subscription products.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-charges-chargeComponents-item-response"
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the charge.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeName":{
            "title":"Charge Name",
            "maxLength":120,
            "type":"string",
            "description":"The name of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "RecurringPricePeriodicityCode":{
            "title":"Recurring Price Periodicity Code",
            "maxLength":30,
            "type":"string",
            "description":"The recurring price periodicity code of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "QuotedTcv":{
            "title":"Total Charge Amount",
            "type":"number",
            "description":"The quoted TCV of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "TieredFlag":{
            "title":"Tiered",
            "maxLength":3,
            "type":"boolean",
            "description":"Indicates whether the charge has tiers.",
            "nullable":true,
            "x-queryable":true
        },
        "UsagePriceLockFlag":{
            "title":"Usage Price Lock",
            "maxLength":3,
            "type":"boolean",
            "description":"Indicates whether the usage price is locked or not.",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodicRevenueFlag":{
            "title":"Enable Periodic Revenue Recognition",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the periodic revenue recognition of one-time charges.",
            "nullable":true,
            "x-queryable":true
        },
        "MilestoneRevenueFlag":{
            "title":"Enable Milestone Based Revenue Recognition",
            "type":"boolean",
            "description":"Indicates whether the revenue is impacted by milestone events or not.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "chargeTiers":{
            "title":"Charge Tiers",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-charges-chargeTiers-item-response"
            }
        },
        "MinimumAmount":{
            "title":"Minimum Amount",
            "type":"number",
            "description":"The minimum amount to be charged.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceType":{
            "title":"Price Type",
            "maxLength":30,
            "type":"string",
            "description":"The price type associated with the charge.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RollupFlag":{
            "title":"Rollup Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the charge needs to be rolled up.",
            "nullable":true,
            "x-queryable":true
        },
        "TierType":{
            "title":"Tier Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the charge tier.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TieredPricingHeaderId":{
            "title":"Tiered Pricing Header ID",
            "type":"integer",
            "description":"Tiered Pricing Header Id",
            "nullable":true,
            "x-queryable":false
        },
        "InvoicingRuleName":{
            "title":"Invoicing Rule",
            "type":"string",
            "description":"The name of the invoice rule.",
            "nullable":true,
            "x-queryable":false
        },
        "MeterId":{
            "title":"Meter ID",
            "type":"integer",
            "description":"The unique identifier of the meter associated with the charges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeDefinitionName":{
            "title":"Charge Definition",
            "type":"string",
            "description":"The name of the charge definition.",
            "nullable":true,
            "x-queryable":true
        },
        "UsageUnitOfMeasure":{
            "title":"Usage UOM",
            "maxLength":3,
            "type":"string",
            "description":"The usage unit of measure of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "title":"Subscription ID",
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EnableProration":{
            "title":"Enable Proration",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether proration is enabled or not.",
            "nullable":true,
            "x-queryable":true
        },
        "TrueUpPeriodName":{
            "title":"True Up Period",
            "type":"string",
            "description":"The name of the trueup period.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ExternalKey":{
            "title":"External Key",
            "maxLength":120,
            "type":"string",
            "description":"The external key used to measure the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargePeriodCode":{
            "title":"Charge Period Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the charge period associated with the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "Allowance":{
            "title":"Allowance",
            "type":"number",
            "description":"The allowance part of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoicingRuleId":{
            "title":"Invoicing Rule Id",
            "type":"integer",
            "description":"The ID of the invoice rule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MilestoneTemplateName":{
            "maxLength":120,
            "type":"string",
            "description":"The name of the milestone template associated with a charge.",
            "nullable":true,
            "x-queryable":false
        },
        "MilestoneTemplateId":{
            "title":"Template",
            "type":"integer",
            "description":"The ID of the milestone event associated with a charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "CoveredLevelId":{
            "title":"Covered Level ID",
            "type":"integer",
            "description":"The unique identifier of the covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillingFreqName":{
            "title":"Billing Frequency",
            "maxLength":255,
            "type":"string",
            "description":"Billing Frequency Name",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MinimumQuantity":{
            "title":"Minimum Quantity",
            "type":"number",
            "description":"The minimum quantity that is allowed.",
            "nullable":true,
            "x-queryable":true
        },
        "EstimatedMethodName":{
            "title":"Estimation Method",
            "type":"string",
            "description":"The method used to estimate the amount.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PricePeriodicity":{
            "title":"Periodicity",
            "maxLength":30,
            "type":"string",
            "description":"The price periodicity for the charge. Indicates the frequency when the charge has to be applied.",
            "nullable":true,
            "x-queryable":true
        },
        "TrueUpPeriod":{
            "title":"True Up Period",
            "maxLength":30,
            "type":"string",
            "description":"The identifier of the trueup period.",
            "nullable":true,
            "default":"ORA_OSS_USAGE_BILLING_PERIOD",
            "x-queryable":true
        },
        "BillLineId":{
            "type":"integer",
            "description":"The unique identifier of the bill line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The unique identifier of the charge.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BlockSize":{
            "title":"Block Size",
            "type":"number",
            "description":"The block size of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the charge was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BatchTag":{
            "title":"Batch Tag",
            "maxLength":30,
            "type":"string",
            "description":"Batch Tag",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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

• Array of: object subscriptionProducts-coveredLevels-charges-adjustments-item-response

{
    "title":"Adjustments",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-charges-adjustments-item-response"
    }
}

Nested Schema : Subcription Product Charge Components Records

Type: array

Title: Subcription Product Charge Components Records

The subscription product charge components records resoure is used to view the price details of the individual charge components of subscription products.

Show Source

• Array of: object subscriptionProducts-coveredLevels-charges-chargeComponents-item-response

{
    "title":"Subcription Product Charge Components Records",
    "type":"array",
    "description":"The subscription product charge components records resoure is used to view the price details of the individual charge components of subscription products.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-charges-chargeComponents-item-response"
    }
}

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

• Array of: object subscriptionProducts-coveredLevels-charges-chargeMilestoneEvents-item-response

{
    "title":"Charge Milestone Events",
    "type":"array",
    "description":"The charge milestone events resource is used to view, create, update, and delete the milestone events associated with a charge of a subscription.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-charges-chargeMilestoneEvents-item-response"
    }
}

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

• Array of: object subscriptionProducts-coveredLevels-charges-chargeTiers-item-response

{
    "title":"Charge Tiers",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-charges-chargeTiers-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionProducts-coveredLevels-charges-adjustments-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the adjustment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AutoAdjustmentFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Indicates whether the adjustment is automatic or not.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentBasis":{
            "title":"Basis",
            "maxLength":30,
            "type":"string",
            "description":"The basis of the adjustment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Reason":{
            "title":"Reason Description",
            "maxLength":120,
            "type":"string",
            "description":"The reason for the adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"integer",
            "description":"The sequence number of the adjustment.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "NumberOfPeriods":{
            "type":"number",
            "description":"The number of periods",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PeriodUntil":{
            "type":"number",
            "description":"The period until which the adjustment is initiated.",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodFrom":{
            "type":"number",
            "description":"The period from which the adjustment was initiated.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the adjustment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the adjustment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeAdjustmentPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the charge adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeAdjustmentId":{
            "type":"integer",
            "description":"The unique identifier of the charge adjustment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AdjustmentReasonCode":{
            "title":"Reason",
            "maxLength":30,
            "type":"string",
            "description":"The code of the adjustment reason.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Effectivity":{
            "title":"Effectivity",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment effectivity",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdjustmentType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the adjustment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdjustmentValue":{
            "title":"Value",
            "type":"number",
            "description":"The value of the adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The unique identifier of the charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AdjustmentReasonMeaning":{
            "title":"Reason",
            "type":"string",
            "description":"The translated adjustment reason.",
            "nullable":true,
            "x-queryable":false
        },
        "AdjustmentName":{
            "title":"Adjustment",
            "maxLength":120,
            "type":"string",
            "description":"The name of the adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the adjustment was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the adjustment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionProducts-coveredLevels-charges-chargeComponents-item-response

Type: object

Show Source

• ChargeComponentId: integer (int64)
  The identifier of the charge component.
• ChargeComponentPuid: string
  Maximum Length: 120

  The PUID of the charge component.
• ChargeCurrency: string
  Title: Currency

  Maximum Length: 15

  The charge currency of the charge component.
• ChargeCurrencyExtAmount: number
  Title: Extended Amount

  The extended amount of the charge component in charge currency.
• ChargeCurrencyName: string
  Title: Currency

  Read Only: true

  Maximum Length: 80

  The name of the charge currency.
• ChargeCurrencyUnitPrice: number
  Title: Currency Unit Price

  The unit price of the charge component in charge currency.
• ChargeId: integer (int64)
  Title: Charge ID

  The identifier of the charge.
• CoverageExtendedAmount: number
  Title: Coverage Extended Amount

  The extended coverage amount of the charge component.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Read Only: true

  The date when the record was created.
• Explanation: string
  Title: Explanation

  Maximum Length: 1000

  The explanation for the charge component.
• ExplanationMessageName: string
  Title: Explanation Message

  Maximum Length: 30

  The explanation message name of the charge component.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the subscription was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the subscription.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the subscription.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  The object version number of the charge component.
• Price: number
  Title: Amount

  The price of the charge component.
• PriceElement: string
  Title: Price Element

  Maximum Length: 30

  The price element of the charge component.
• PriceElementName: string
  Title: Price Element

  Read Only: true

  Maximum Length: 80

  The name of the price element associated with the charge component.
• PriceElementUsage: string
  Title: Price Element Usage

  Maximum Length: 30

  The price element usage of the charge component.
• PriceElementUsageName: string
  Title: Price Element Usage

  Read Only: true

  Maximum Length: 80

  The name of the price element usage associated with the charge component.
• PriceforQuantity: number
  Title: Price

  The price for quantity of the charge component.
• PricingSourceId: integer (int64)
  The identifier of the pricing source of the charge component.
• PricingSourceType: string
  Title: Pricing Source Type

  Maximum Length: 30

  The type of pricing source of the charge component.
• PricingSourceTypeName: string
  Title: Pricing Source Type

  Read Only: true

  Maximum Length: 80

  The name of the pricing source type.
• RollupFlag: boolean
  Title: Rollup Flag

  Maximum Length: 1

  The indicator of whether charge component should be rolled up or not.
• SequenceNumber: integer (int32)
  Title: Sequence Number

  The sequence number of the charge component.
• SubscriptionCurrency: string
  Title: Subscription Currency

  Maximum Length: 15

  The subscription currency of the charge component.
• SubscriptionCurrencyName: string
  Title: Subscription Currency

  Read Only: true

  Maximum Length: 80

  The name of the subscription currency.
• SubscriptionId: integer (int64)
  Title: Subscription ID

  The identifier of the subscription.
• TaxIncludedFlag: boolean
  Title: Tax Included Flag

  Maximum Length: 1

  The indicator of whether tax is included for the charge component or not.
• UnitPrice: number
  Title: Unit Price

  The unit price of the charge component.

{
    "type":"object",
    "properties":{
        "ChargeComponentPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The PUID of the charge component.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RollupFlag":{
            "title":"Rollup Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"The indicator of whether charge component should be rolled up or not.",
            "nullable":true,
            "x-queryable":true
        },
        "Explanation":{
            "title":"Explanation",
            "maxLength":1000,
            "type":"string",
            "description":"The explanation for the charge component.",
            "nullable":true,
            "x-queryable":true
        },
        "PricingSourceId":{
            "type":"integer",
            "description":"The identifier of the pricing source of the charge component.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaxIncludedFlag":{
            "title":"Tax Included Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"The indicator of whether tax is included for the charge component or not.",
            "nullable":true,
            "x-queryable":true
        },
        "CoverageExtendedAmount":{
            "title":"Coverage Extended Amount",
            "type":"number",
            "description":"The extended coverage amount of the charge component.",
            "nullable":true,
            "x-queryable":true
        },
        "PricingSourceType":{
            "title":"Pricing Source Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of pricing source of the charge component.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeCurrencyUnitPrice":{
            "title":"Currency Unit Price",
            "type":"number",
            "description":"The unit price of the charge component in charge currency.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "title":"Subscription ID",
            "type":"integer",
            "description":"The identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeComponentId":{
            "type":"integer",
            "description":"The identifier of the charge component.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the charge component.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence Number",
            "type":"integer",
            "description":"The sequence number of the charge component.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PricingSourceTypeName":{
            "title":"Pricing Source Type",
            "maxLength":80,
            "type":"string",
            "description":"The name of the pricing source type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PriceforQuantity":{
            "title":"Price",
            "type":"number",
            "description":"The price for quantity of the charge component.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceElementUsage":{
            "title":"Price Element Usage",
            "maxLength":30,
            "type":"string",
            "description":"The price element usage of the charge component.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the subscription.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExplanationMessageName":{
            "title":"Explanation Message",
            "maxLength":30,
            "type":"string",
            "description":"The explanation message name of the charge component.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeCurrency":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The charge currency of the charge component.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceElementUsageName":{
            "title":"Price Element Usage",
            "maxLength":80,
            "type":"string",
            "description":"The name of the price element usage associated with the charge component.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PriceElementName":{
            "title":"Price Element",
            "maxLength":80,
            "type":"string",
            "description":"The name of the price element associated with the charge component.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriptionCurrencyName":{
            "title":"Subscription Currency",
            "maxLength":80,
            "type":"string",
            "description":"The name of the subscription currency.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitPrice":{
            "title":"Unit Price",
            "type":"number",
            "description":"The unit price of the charge component.",
            "nullable":true,
            "x-queryable":true
        },
        "Price":{
            "title":"Amount",
            "type":"number",
            "description":"The price of the charge component.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceElement":{
            "title":"Price Element",
            "maxLength":30,
            "type":"string",
            "description":"The price element of the charge component.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionCurrency":{
            "title":"Subscription Currency",
            "maxLength":15,
            "type":"string",
            "description":"The subscription currency of the charge component.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeCurrencyName":{
            "title":"Currency",
            "maxLength":80,
            "type":"string",
            "description":"The name of the charge currency.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeCurrencyExtAmount":{
            "title":"Extended Amount",
            "type":"number",
            "description":"The extended amount of the charge component in charge currency.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeId":{
            "title":"Charge ID",
            "type":"integer",
            "description":"The identifier of the charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the subscription.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionProducts-coveredLevels-charges-chargeMilestoneEvents-item-response

Type: object

Show Source

• BillingOffset: number
  The billing offset associated with a milestone event.
• BillLineId: integer (int64)
  The bill line ID associated with the milestone event.
• BillLinePuid: string
  Title: Bill Line PUID

  Maximum Length: 120

  Bill Line Puid
• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who updated the milestone event the last.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date on which the milestone event was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BillingOffset":{
            "type":"number",
            "description":"The billing offset associated with a milestone event.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargePuid":{
            "maxLength":120,
            "type":"string",
            "description":"The PUID of the charge to which the milestone event is associated.",
            "nullable":true,
            "default":"Charges.ChargePuid",
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The login of the user who created the milestone event.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpectedCompletionDate":{
            "type":"string",
            "description":"The expected completion date of a milestone event.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "EventType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of the milestone event.",
            "nullable":false,
            "x-queryable":true
        },
        "Percentage":{
            "type":"number",
            "description":"The percentage associated with a milestone event.",
            "nullable":false,
            "x-hints":{
                "precision":5,
                "scale":2
            },
            "x-queryable":true
        },
        "MilestoneName":{
            "maxLength":30,
            "type":"string",
            "description":"The name of the milestone event.",
            "nullable":false,
            "x-queryable":true
        },
        "MilestoneComment":{
            "maxLength":300,
            "type":"string",
            "description":"The milestone event comment.",
            "nullable":true,
            "x-queryable":true
        },
        "MilestonePuid":{
            "maxLength":120,
            "type":"string",
            "description":"The milestone event PUID.",
            "nullable":true,
            "x-queryable":true
        },
        "EventSource":{
            "maxLength":30,
            "type":"string",
            "description":"The source of the milestone event.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the milestone event.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "EventId":{
            "type":"integer",
            "description":"The ID of the milestone event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EventSourceReference":{
            "maxLength":120,
            "type":"string",
            "description":"The source reference of the milestone event.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BillLineId":{
            "type":"integer",
            "description":"The bill line ID associated with the milestone event.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The charge ID with which the milestone event is associated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillLinePuid":{
            "title":"Bill Line PUID",
            "maxLength":120,
            "type":"string",
            "description":"Bill Line Puid",
            "nullable":true,
            "x-queryable":false
        },
        "CompletionDate":{
            "type":"string",
            "description":"The completion date of the milestone event.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BillingOffset"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date of which the milestone event was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login which updated the milestone event the last.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionProducts-coveredLevels-charges-chargeTiers-item-response

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the charge tier was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdditionalTimestampTwo":{
            "title":"Additional Time-stamp Two",
            "type":"string",
            "description":"Additional timestamp, if any, for the charge tier.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeTierPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the charge tier.",
            "nullable":false,
            "x-queryable":true
        },
        "AdditionalNumberThree":{
            "title":"Additional Number Three",
            "type":"number",
            "description":"Additional number, if any, for the charge tier.",
            "nullable":true,
            "x-queryable":true
        },
        "ListPrice":{
            "title":"List Price",
            "type":"number",
            "description":"The list price",
            "nullable":false,
            "x-queryable":true
        },
        "AdditionalNumberFive":{
            "title":"Additional Number Five",
            "type":"number",
            "description":"Additional number, if any, for the charge tier.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TierTo":{
            "title":"Tier To",
            "type":"number",
            "description":"The tier to",
            "nullable":true,
            "x-queryable":true
        },
        "AddtionalTextThree":{
            "title":"Additional Text Three",
            "maxLength":4000,
            "type":"string",
            "description":"Additional text, if any, for the charge tier.",
            "nullable":true,
            "x-queryable":true
        },
        "SequenceNumber":{
            "type":"number",
            "description":"The sequence number",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TierFrom":{
            "title":"Tier From",
            "type":"number",
            "description":"The tier from",
            "nullable":false,
            "x-queryable":true
        },
        "AdditionalNumberTwo":{
            "title":"Additional Number Two",
            "type":"number",
            "description":"Additional number, if any, for the charge tier.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the charge tier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeTierId":{
            "type":"integer",
            "description":"The unique identifier of the charge tier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the charge tier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdditionalNumberFour":{
            "title":"Additional Number Four",
            "type":"number",
            "description":"Additional number, if any, for the charge tier.",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalTimestampOne":{
            "title":"Additional Time-stamp One",
            "type":"string",
            "description":"Additional timestamp, if any, for the charge tier.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PriceFormat":{
            "title":"Price Format",
            "maxLength":30,
            "type":"string",
            "description":"The display format of the price.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdditionalTextOne":{
            "title":"Additional Text One",
            "maxLength":4000,
            "type":"string",
            "description":"Additional text, if any, for the charge tier.",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalNumberSix":{
            "title":"Additional Number Six",
            "type":"number",
            "description":"Additional number, if any, for the charge tier.",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalNumberOne":{
            "title":"Additional Number One",
            "type":"number",
            "description":"Additional number, if any, for the charge tier.",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalTextTwo":{
            "title":"Additional Text Two",
            "maxLength":4000,
            "type":"string",
            "description":"Additional text, if any, for the charge tier.",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalTimestampThree":{
            "title":"Additional Time-stamp Three",
            "type":"string",
            "description":"Additional timestamp, if any, for the charge tier.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The unique identifier of the charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BlockSize":{
            "title":"Block Size",
            "type":"number",
            "description":"The block size",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the charge tier was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the charge tier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionProducts-coveredLevels-productAssetRelationships-item-response

Type: object

Show Source

• AmendmentReason: string
  Title: Amendment Reason

  Read Only: true

  Maximum Length: 4000

  The amendment reason of the product asset relationship.
• AmendmentReasonCode: string
  Read Only: true

  Maximum Length: 30

  The amendment reason code of the product asset relationship.
• AssociationNumber: string
  Title: Related Covered Level

  Read Only: true

  Maximum Length: 300

  The association number of the source subscription.
• AssociationPuid: string
  Read Only: true

  Maximum Length: 120

  The association PUID of the source subscription.
• EffectiveDate: string (date)
  Title: Effective Date

  Read Only: true

  The effective date of the relationship.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProductAssociationId: integer (int64)
  Read Only: true

  The product association ID of the source subscription.
• ProductId: integer (int64)
  Read Only: true

  The source product ID of the product asset relationship.
• ProductPuid: string
  Read Only: true

  Maximum Length: 120

  The source product PUID of the product asset relationship.
• RelatedLineName: string
  Title: Related Line

  Read Only: true

  Maximum Length: 300

  The name of the related product asset.
• RelatedLineNumber: string
  Read Only: true

  Maximum Length: 300

  The number of the related product asset.
• RelatedLinePuid: string
  Read Only: true

  Maximum Length: 120

  The PUID of the related product asset.
• RelatedLineStatus: string
  Title: Related Line Status

  Read Only: true

  Maximum Length: 4000

  The status of the related product asset.
• RelatedLineStatusCode: string
  Read Only: true

  Maximum Length: 30

  The status code of the related product asset.
• RelatedLineSubscriptionId: integer (int64)
  Read Only: true

  The subscription ID of the related product asset.
• RelatedProdAssId: integer (int64)
  Read Only: true

  The related product association ID of the product asset relationship.
• RelatedSubscriptionNumber: string
  Title: Related Subscription Number

  Read Only: true

  Maximum Length: 120

  The subscription number of the related product asset.
• Relationship: string
  Title: Relationship

  Read Only: true

  Maximum Length: 4000

  The relationship of the product asset relationship.
• RelationshipCode: string
  Read Only: true

  Maximum Length: 16

  The relationship code of the product asset relationship.
• SubscriptionId: integer (int64)
  Read Only: true

  The source subscription ID of the product asset relationship.
• SubscriptionProductId: integer (int64)
  Read Only: true

  The subscription product ID of the source subscription.

{
    "type":"object",
    "properties":{
        "AmendmentReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"The amendment reason code of the product asset relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelatedLineNumber":{
            "maxLength":300,
            "type":"string",
            "description":"The number of the related product asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductId":{
            "type":"integer",
            "description":"The source product ID of the product asset relationship.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssociationPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The association PUID of the source subscription.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelatedLineStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"The status code of the related product asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelatedLineName":{
            "title":"Related Line",
            "maxLength":300,
            "type":"string",
            "description":"The name of the related product asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelatedProdAssId":{
            "type":"integer",
            "description":"The related product association ID of the product asset relationship.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProductPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The source product PUID of the product asset relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelatedLineStatus":{
            "title":"Related Line Status",
            "maxLength":4000,
            "type":"string",
            "description":"The status of the related product asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociationNumber":{
            "title":"Related Covered Level",
            "maxLength":300,
            "type":"string",
            "description":"The association number of the source subscription.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The source subscription ID of the product asset relationship.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AmendmentReason":{
            "title":"Amendment Reason",
            "maxLength":4000,
            "type":"string",
            "description":"The amendment reason of the product asset relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipCode":{
            "maxLength":16,
            "type":"string",
            "description":"The relationship code of the product asset relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Relationship":{
            "title":"Relationship",
            "maxLength":4000,
            "type":"string",
            "description":"The relationship of the product asset relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelatedLinePuid":{
            "maxLength":120,
            "type":"string",
            "description":"The PUID of the related product asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductAssociationId":{
            "type":"integer",
            "description":"The product association ID of the source subscription.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RelatedSubscriptionNumber":{
            "title":"Related Subscription Number",
            "maxLength":120,
            "type":"string",
            "description":"The subscription number of the related product asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The subscription product ID of the source subscription.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RelatedLineSubscriptionId":{
            "type":"integer",
            "description":"The subscription ID of the related product asset.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EffectiveDate":{
            "title":"Effective Date",
            "type":"string",
            "description":"The effective date of the relationship.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionProducts-coveredLevels-relationships-item-response

Type: object

Show Source

• 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
  Title: Operation Links PUID

  Maximum Length: 120

  The public unique identifier of the operation links.
• RelationshipTypeCode: string
  Title: Type

  Maximum Length: 30

  The code indicating the type of the relationship.
• SourceAssetKey: string
  Title: Source Asset Key

  Maximum Length: 120

  The source asset key
• SourceProdAssociationId: integer (int64)
  Title: Source Product Association ID

  The unique identifier of the source product association.
• SourceProdAssociationPuid: string
  Title: Source Product Association PUID

  Maximum Length: 120

  The public unique identifier of the source product association.
• SourceProductPuid: string
  Title: Source Product PUID

  Maximum Length: 120

  The public unique identifier of the source product.
• SourceRootAssetKey: string
  Title: Source Root Asset Key

  Maximum Length: 120

  The source root asset key
• TargetProdAssociationId: integer (int64)
  Title: Target Product Association ID

  The unique identifier of the target product association.
• TargetProdAssociationPuid: string
  Title: Target Product Association PUID

  Maximum Length: 120

  The public unique identifier of the target product association.
• TargetProductPuid: string
  Title: Target Product PUID

  Maximum Length: 120

  The public unique identifier of the target product.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the relationship.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the relationship was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the relationship.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceProdAssociationId":{
            "title":"Source Product Association ID",
            "type":"integer",
            "description":"The unique identifier of the source product association.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TargetProdAssociationId":{
            "title":"Target Product Association ID",
            "type":"integer",
            "description":"The unique identifier of the target product association.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceAssetKey":{
            "title":"Source Asset Key",
            "maxLength":120,
            "type":"string",
            "description":"The source asset key",
            "nullable":true,
            "x-queryable":true
        },
        "SourceProductPuid":{
            "title":"Source Product PUID",
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the source product.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipTypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of the relationship.",
            "nullable":false,
            "x-queryable":true
        },
        "OperationLinksPuid":{
            "title":"Operation Links PUID",
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the operation links.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SourceRootAssetKey":{
            "title":"Source Root Asset Key",
            "maxLength":120,
            "type":"string",
            "description":"The source root asset key",
            "nullable":true,
            "x-queryable":true
        },
        "SourceProdAssociationPuid":{
            "title":"Source Product Association PUID",
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the source product association.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetProductPuid":{
            "title":"Target Product PUID",
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the target product.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetProdAssociationPuid":{
            "title":"Target Product Association PUID",
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the target product association.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the relationship was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionProducts-creditCards-item-response

Type: object

Show Source

• 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 instrument assignment ID associated with the credit card.
• 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.
• TrxnExtensionId: integer (int64)
  Transaction Extension Id
• VoiceAuthCode: string
  The credit card voice authorization information.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the credit card was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "CardIssuerName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the card issuer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InstrAssignmentId":{
            "title":"Number",
            "type":"integer",
            "description":"The instrument assignment ID associated with the credit card.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "CreditCardPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the credit card.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "PostalCode":{
            "maxLength":255,
            "type":"string",
            "description":"The postal code of the billing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentSystemOrderNumber":{
            "type":"string",
            "description":"The order number for the credit card payment.",
            "nullable":true,
            "x-queryable":false
        },
        "CardHolderName":{
            "title":"Cardholder Name",
            "type":"string",
            "description":"The name of the credit card holder.",
            "nullable":true,
            "x-queryable":true
        },
        "AddToBillingAccountFlag":{
            "type":"boolean",
            "description":"Indicates whether the party can be added as a billing account.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "precision":18
            },
            "x-queryable":true
        },
        "TrxnExtensionId":{
            "type":"integer",
            "description":"Transaction Extension Id",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "VoiceAuthCode":{
            "type":"string",
            "description":"The credit card voice authorization information.",
            "nullable":true,
            "x-queryable":false
        },
        "AuthRequestId":{
            "type":"string",
            "description":"The card authorization request identifier.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The public unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "precision":18
            },
            "x-queryable":true
        },
        "RenewalCreditCardFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the credit card is used as Renewal Payment Method.",
            "nullable":true,
            "x-queryable":true
        },
        "CreditCardId":{
            "type":"integer",
            "description":"The unique identifier of the credit card.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "precision":18,
                "SUPPORTS_RANGE_PAGING":"true"
            },
            "x-queryable":true
        },
        "Notes":{
            "title":"Notes",
            "maxLength":300,
            "type":"string",
            "description":"The notes, if any, associated with the credit card.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the credit card.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the credit card.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "FirstName":{
            "type":"string",
            "description":"The first name of the credit card holder.",
            "nullable":true,
            "x-queryable":false
        },
        "MaskedNumber":{
            "type":"string",
            "description":"The masked credit card number.",
            "nullable":true,
            "x-queryable":false
        },
        "CardBillingAddressId":{
            "type":"number",
            "description":"The ID of the card billing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssuerCode":{
            "type":"string",
            "description":"The credit card issuing company.",
            "nullable":true,
            "x-queryable":false
        },
        "City":{
            "maxLength":255,
            "type":"string",
            "description":"The city of the billing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressLine2":{
            "maxLength":255,
            "type":"string",
            "description":"The address line 2 of the billing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressLine1":{
            "maxLength":255,
            "type":"string",
            "description":"The address line 1 of the billing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpirationDate":{
            "type":"string",
            "description":"The credit card expiration date used for processing.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "State":{
            "maxLength":255,
            "type":"string",
            "description":"The state of the billing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Country":{
            "maxLength":255,
            "type":"string",
            "description":"The country of the billing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AuthorizedAmount":{
            "type":"number",
            "description":"The amount the transaction was authorized for.",
            "nullable":true,
            "x-queryable":false
        },
        "LastName":{
            "type":"string",
            "description":"The last name of the credit card holder.",
            "nullable":true,
            "x-queryable":false
        },
        "TokenNumber":{
            "type":"string",
            "description":"The credit card token number used for processing.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the credit card was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the credit card.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionProducts-flexFields-item-response

Type: object

Show Source

• __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.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"The display name for structure definition of the user descriptive flexfield.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"The structure definition of the user descriptive flexfield.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionProducts-negotiatedEntitlementPlanCommitments-item-response

Type: object

Show Source

• 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)
  Title: Balance Code

  The unique identifier of balance code under subscription entitlement plan commitments.
• BalanceCodeMaxPrecision: integer (int32)
  Title: Maximum Precision

  Read Only: true

  The maximum precision of balance code of the commitment rating model setup for the product.
• BalanceCodeType: string
  Title: Balance Code Type

  Maximum Length: 30

  The balance code type of the commitment rating model setup for the product.
• BalanceProfileId: integer (int64)
  Read Only: true

  The unique identifier of the balance profile of the commitment rating model setup for the product.
• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date of creation of the subscription entitlement plan commitments.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RelatedPeriod":{
            "title":"Related Charge Periodicity",
            "type":"string",
            "description":"The related period of the related charge. Indicates the related charge name from which the estimates or commitments are granted.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "sortable":false
            }
        },
        "EntitlementPlanCommitmentId":{
            "type":"integer",
            "description":"The unique identifier of subscription entitlement plan commitments.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The charge definition code under subscription entitlement plan commitments.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BalanceCode":{
            "title":"Balance Code",
            "maxLength":30,
            "type":"string",
            "description":"The balance code of subscription entitlement plan commitments.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "RoundedQuantity":{
            "title":"Rounded Quantity",
            "type":"number",
            "description":"The rounded quantity under subscription entitlement plan commitments.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The currency code of amount type balance code under subscription entitlement plan commitments.",
            "nullable":true,
            "x-queryable":true
        },
        "BalanceCodeId":{
            "title":"Balance Code",
            "type":"integer",
            "description":"The unique identifier of balance code under subscription entitlement plan commitments.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The version number of subscription entitlement plan commitments.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "RelatedChargeDefinitionId":{
            "type":"integer",
            "description":"The unique identifier of charge definition of the related charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RelatedChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The charge definition code of the related charge identifier.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BalanceCodeType":{
            "title":"Balance Code Type",
            "maxLength":30,
            "type":"string",
            "description":"The balance code type of the commitment rating model setup for the product.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EntitlementPlanCommitmentNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The unique number of subscription entitlement plan commitments.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The subscription product identifier of subscription entitlement plan commitments.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who has last updated the subscription entitlement plan commitments.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription entitlement plan commitments.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BalanceCodeMaxPrecision":{
            "title":"Maximum Precision",
            "type":"integer",
            "description":"The maximum precision of balance code of the commitment rating model setup for the product.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"UOM",
            "maxLength":3,
            "type":"string",
            "description":"The unit of measure of allowance under subscription entitlement plan commitments.",
            "nullable":true,
            "x-queryable":true
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount under subscription entitlement plan commitments.",
            "nullable":true,
            "x-queryable":true
        },
        "Period":{
            "title":"Periodicity",
            "type":"string",
            "description":"The period under subscription entitlement plan commitments.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity under subscription entitlement plan commitments.",
            "nullable":true,
            "x-queryable":true
        },
        "EntitlementPlanId":{
            "type":"integer",
            "description":"The unique identifier of subscription entitlement plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BalanceProfileId":{
            "type":"integer",
            "description":"The unique identifier of the balance profile of the commitment rating model setup for the product.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeDefinitionId":{
            "type":"integer",
            "description":"The unique identifier for charge definition under subscription entitlement plan commitments.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription entitlement plan commitments was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the subscription entitlement plan commitments.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionProducts-negotiatedEntitlementPlanDetails-item-response

Type: object

Show Source

• 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)
  Title: Balance Code

  The unique identifier of balance code under subscription entitlement plan details.
• BalanceCodeMaxPrecision: integer (int32)
  Title: Maximum Precision

  Read Only: true

  The maximum precision of balance code of the allowance rating model setup for the product.
• BalanceCodeType: string
  Title: Balance Code Type

  Maximum Length: 30

  The balance code type of the allowance rating model setup for the product.
• BalanceProfileId: integer (int64)
  Read Only: true

  The unique identifier of the balance profile of the allowance rating model setup for the product.
• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date of creation of the subscription entitlement plan details.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AllowancePeriodicity":{
            "title":"Periodicity",
            "maxLength":30,
            "type":"string",
            "description":"The periodicity factor of allowance under subscription entitlement plan details.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AllowanceValidityPeriodUnitOfMeasure":{
            "title":"Validity Period UOM",
            "maxLength":3,
            "type":"string",
            "description":"The unit of measure of allowance validity under subscription entitlement plan details.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for charge definition under subscription entitlement plan details.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PrecisionType":{
            "title":"Rounding Type",
            "maxLength":30,
            "type":"string",
            "description":"The precision type of subscription entitlement plan details.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BalanceCode":{
            "title":"Balance Code",
            "maxLength":30,
            "type":"string",
            "description":"The balance code of subscription entitlement plan details.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the balance code of amount type of a negotiated entitlement plan.",
            "nullable":true,
            "x-queryable":true
        },
        "PrecisionFactor":{
            "title":"Rounding Factor",
            "type":"number",
            "description":"The precision factor of subscription entitlement plan details.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BalanceCodeId":{
            "title":"Balance Code",
            "type":"integer",
            "description":"The unique identifier of balance code under subscription entitlement plan details.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The version number of subscription entitlement plan details.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "BalanceCodeType":{
            "title":"Balance Code Type",
            "maxLength":30,
            "type":"string",
            "description":"The balance code type of the allowance rating model setup for the product.",
            "nullable":true,
            "x-queryable":true
        },
        "AllowanceValidityPeriod":{
            "title":"Validity Period",
            "type":"integer",
            "description":"The allowance validity period under subscription entitlement plan details.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The subscription product identifier of subscription entitlement plan details.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BalanceCodeDescription":{
            "title":"Name",
            "maxLength":120,
            "type":"string",
            "description":"The description of balance code under subscription entitlement plan details.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who has last updated the subscription entitlement plan details.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription entitlement plan details.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BalanceCodeMaxPrecision":{
            "title":"Maximum Precision",
            "type":"integer",
            "description":"The maximum precision of balance code of the allowance rating model setup for the product.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "AllowanceRolloverPeriodUnitOfMeasure":{
            "title":"Rollover Period UOM",
            "maxLength":3,
            "type":"string",
            "description":"The unit of measure of allowance rollover under subscription entitlement plan details.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount negotiated for an entitlement plan.",
            "nullable":true,
            "x-queryable":true
        },
        "EntitlementPlanDetailNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The alternate unique number of subscription entitlement plan details.",
            "nullable":false,
            "x-queryable":true
        },
        "AllowanceQuantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The allowance quantity under subscription entitlement plan details.",
            "nullable":true,
            "x-queryable":true
        },
        "EntitlementPlanId":{
            "type":"integer",
            "description":"The unique identifier of subscription entitlement plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BalanceProfileId":{
            "type":"integer",
            "description":"The unique identifier of the balance profile of the allowance rating model setup for the product.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AllowanceUnitOfMeasure":{
            "title":"UOM",
            "maxLength":3,
            "type":"string",
            "description":"The unit of measure of allowance specified for a negotiated entitlement plan.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ChargeDefinitionId":{
            "type":"integer",
            "description":"The charge definition code under subscription entitlement plan details.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EntitlementPlanDetailId":{
            "type":"integer",
            "description":"The unique identifier of subscription entitlement plan details.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AllowanceRolloverPeriod":{
            "title":"Rollover Period",
            "type":"integer",
            "description":"The allowance rollover period under subscription entitlement plan details.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription entitlement plan details was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the subscription entitlement plan details.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionProducts-negotiatedEntitlementPlanEstimates-item-response

Type: object

Show Source

• 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)
  Title: Balance Code

  The unique identifier of balance code under subscription entitlement plan estimates.
• BalanceCodeMaxPrecision: integer (int32)
  Title: Maximum Precision

  Read Only: true

  The maximum precision of balance code of the estimate rating model setup for the product.
• BalanceCodeType: string
  Title: Balance Code Type

  Maximum Length: 30

  The balance code type of the estimate rating model setup for the product.
• BalanceProfileId: integer (int64)
  Read Only: true

  The unique identifier of the balance profile of the estimate rating model setup for the product.
• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date of creation of the subscription entitlement plan estimates.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TrueupShortageFlag":{
            "title":"True-up shortage",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the flag of the subscription entitlement plan estimates is trueup shortage.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "RelatedPeriod":{
            "title":"Related Charge Periodicity",
            "type":"string",
            "description":"The related period of the related charge. Indicates the related charge name from which the estimates or commitments are granted.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "sortable":false
            }
        },
        "RolloverPeriod":{
            "title":"Rollover Period",
            "type":"integer",
            "description":"The rollover period of the subscription entitlement plan estimate.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The charge definition code under subscription entitlement plan estimates.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RolloverPeriodUnitOfMeasure":{
            "title":"Rollover Period UOM",
            "maxLength":3,
            "type":"string",
            "description":"The rollover period unit of measure of the subscription entitlement plan estimate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BalanceCode":{
            "title":"Balance Code",
            "maxLength":30,
            "type":"string",
            "description":"The balance code of subscription entitlement plan estimates.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "RoundedQuantity":{
            "title":"Rounded Quantity",
            "type":"number",
            "description":"The rounded quantity under subscription entitlement plan estimates.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The currency code of amount type balance code under subscription entitlement plan estimates.",
            "nullable":true,
            "x-queryable":true
        },
        "BalanceCodeId":{
            "title":"Balance Code",
            "type":"integer",
            "description":"The unique identifier of balance code under subscription entitlement plan estimates.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The version number of subscription entitlement plan estimates.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "RelatedChargeDefinitionId":{
            "type":"integer",
            "description":"The unique identifier of charge definition of the related charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RelatedChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The charge definition code of the related charge identifier.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BalanceCodeType":{
            "title":"Balance Code Type",
            "maxLength":30,
            "type":"string",
            "description":"The balance code type of the estimate rating model setup for the product.",
            "nullable":true,
            "x-queryable":true
        },
        "TrueupOverageFlag":{
            "title":"True-up overage",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the flag of the subscription entitlement plan estimates is overage shortage.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The subscription product identifier of subscription entitlement plan estimates.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EntitlementPlanEstimateId":{
            "type":"integer",
            "description":"The unique identifier of subscription entitlement plan estimates.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargePeriod":{
            "title":"Estimate Period",
            "type":"string",
            "description":"The estimate period of the subscription entitlement plan estimates.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "sortable":false
            }
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who has last updated the subscription entitlement plan estimates.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription entitlement plan estimates.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EnableRolloverFlag":{
            "title":"Enable rollover",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates where the rollover is enabled for the subscription entitlement plan estimate.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "BalanceCodeMaxPrecision":{
            "title":"Maximum Precision",
            "type":"integer",
            "description":"The maximum precision of balance code of the estimate rating model setup for the product.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"UOM",
            "maxLength":3,
            "type":"string",
            "description":"The unit of measure under subscription entitlement plan estimates.",
            "nullable":true,
            "x-queryable":true
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount under subscription entitlement plan estimates.",
            "nullable":true,
            "x-queryable":true
        },
        "Period":{
            "title":"Periodicity",
            "type":"string",
            "description":"The period under subscription entitlement plan estimates.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity under subscription entitlement plan estimates.",
            "nullable":true,
            "x-queryable":true
        },
        "EntitlementPlanEstimateNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The alternate unique number of subscription entitlement plan estimates.",
            "nullable":false,
            "x-queryable":true
        },
        "EntitlementPlanId":{
            "type":"integer",
            "description":"The unique identifier of subscription entitlement plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BalanceProfileId":{
            "type":"integer",
            "description":"The unique identifier of the balance profile of the estimate rating model setup for the product.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeDefinitionId":{
            "type":"integer",
            "description":"The unique identifier for charge definition under subscription entitlement plan estimates.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription entitlement plan estimates was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the subscription entitlement plan estimates.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionProducts-negotiatedVolumePricingRules-item-response

Type: object

Show Source

• AggregationBalanceCode: string
  Title: Aggregation Balance Code

  Maximum Length: 30

  The balance code which is eligible for aggregation rating.
• AggregationBalanceCodeId: integer (int64)
  Title: Aggregation Balance Code ID

  The unique identifier of the balance code which is eligible for aggregation rating.
• AggregationPeriod: string
  Title: Aggregation Period

  Maximum Length: 30

  The charge period of balance code for volume rating.
• BalanceCode: string
  Title: Balance Code

  Maximum Length: 30

  The unique identifier of the balance code which is eligible for volume rating.
• BalanceCodeId: integer (int64)
  The balance code which is eligible for volume rating.
• BalanceCodeUnitOfMeasure: string
  Title: UOM

  Maximum Length: 3

  The unit of measure of balance code for volume rating
• BalanceProfileId: integer (int64)
  Title: Balance Profile ID

  The unique identifier of the subscription balance profile.
• ChargeDefinitionCode: string
  Maximum Length: 30

  The charge definition code of the entitlement plan detail charge definition.
• ChargeDefinitionId: integer (int64)
  Title: Charge Definition ID

  The unique identifier of charge definition of the subscription entitlement plan commitments.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the subscription entitlement plan commitments.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date of creation of the subscription entitlement plan commitments.
• EligibilityBalanceCodeId: integer (int64)
  Title: Eligible Balance Code ID

  The unique identifier of the balance code which is eligible for volume rating.
• EntitlementPlanChargeRuleId: integer (int64)
  Title: Profile Charge Rule ID

  The unique identifier of the subscription entitlement plan charge rule.
• EntitlementPlanChargeRuleNumber: string
  Title: Charge Rule Number

  Maximum Length: 120

  The unique number of the subscription entitlement plan charge rule.
• EntitlementPlanId: integer (int64)
  Title: Entitlement Plan ID

  The unique identifier of entitlement plan of the subscription entitlement plan.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the subscription entitlement plan commitments was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  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)
  Title: Object Version Number

  The version number of the subscription entitlement plan commitments.
• PricingBalanceCode: string
  Title: Pricing Balance Code

  Maximum Length: 30

  The balance code which is eligible for volume rating.
• ProductEntitlementPlanId: integer (int64)
  Title: Product Entitlement Plan ID

  The unique identifier of entitlement plan product of the subscription entitlement plan.
• SubscriptionProductId: integer (int64)
  Title: Subscription Product ID

  The unique identifier of subscription product.
• VolumePricingAggregationFlag: boolean
  Title: Eligible for aggregation

  Maximum Length: 1

  Indicates whether the balance code is enabled for aggregation of volume pricing.
• VolumePricingEligibilityFlag: boolean
  Title: Eligible for volume pricing

  Maximum Length: 1

  Indicates whether the balance code is eligibile for volume pricing.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the subscription entitlement plan commitments.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date of creation of the subscription entitlement plan commitments.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AggregationPeriod":{
            "title":"Aggregation Period",
            "maxLength":30,
            "type":"string",
            "description":"The  charge period of balance code for volume rating.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription entitlement plan commitments.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BalanceCodeUnitOfMeasure":{
            "title":"UOM",
            "maxLength":3,
            "type":"string",
            "description":"The  unit of measure of balance code for volume rating",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AggregationBalanceCodeId":{
            "title":"Aggregation Balance Code ID",
            "type":"integer",
            "description":"The unique identifier of the balance code which is eligible for aggregation rating.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "VolumePricingAggregationFlag"
                ]
            },
            "x-queryable":true
        },
        "ProductEntitlementPlanId":{
            "title":"Product Entitlement Plan ID",
            "type":"integer",
            "description":"The unique identifier of entitlement plan product of the subscription entitlement plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The charge definition code of the entitlement plan detail charge definition.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PricingBalanceCode":{
            "title":"Pricing Balance Code",
            "maxLength":30,
            "type":"string",
            "description":"The balance code which is eligible for volume rating.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "BalanceCode":{
            "title":"Balance Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the balance code which is eligible for volume rating.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "EntitlementPlanId":{
            "title":"Entitlement Plan ID",
            "type":"integer",
            "description":"The unique identifier of entitlement plan of the subscription entitlement plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AggregationBalanceCode":{
            "title":"Aggregation Balance Code",
            "maxLength":30,
            "type":"string",
            "description":"The balance code which is eligible for aggregation rating.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "BalanceProfileId":{
            "title":"Balance Profile ID",
            "type":"integer",
            "description":"The unique identifier of the subscription balance profile.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BalanceCodeId":{
            "type":"integer",
            "description":"The balance code which is eligible for volume rating.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "ChargeDefinitionId"
                ]
            },
            "x-queryable":true
        },
        "VolumePricingEligibilityFlag":{
            "title":"Eligible for volume pricing",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the balance code is eligibile for volume pricing.",
            "nullable":true,
            "x-queryable":true
        },
        "VolumePricingAggregationFlag":{
            "title":"Eligible for aggregation",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the balance code is enabled for aggregation of volume pricing.",
            "nullable":true,
            "x-queryable":true
        },
        "EligibilityBalanceCodeId":{
            "title":"Eligible Balance Code ID",
            "type":"integer",
            "description":"The unique identifier of the balance code which is eligible for volume rating.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "VolumePricingEligibilityFlag"
                ]
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The version number of the subscription entitlement plan commitments.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "EntitlementPlanChargeRuleId":{
            "title":"Profile Charge Rule ID",
            "type":"integer",
            "description":"The unique identifier of the subscription entitlement plan charge rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeDefinitionId":{
            "title":"Charge Definition ID",
            "type":"integer",
            "description":"The unique identifier of charge definition of the subscription entitlement plan commitments.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EntitlementPlanChargeRuleNumber":{
            "title":"Charge Rule Number",
            "maxLength":120,
            "type":"string",
            "description":"The unique number of the subscription entitlement plan charge rule.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscriptionProductId":{
            "title":"Subscription Product ID",
            "type":"integer",
            "description":"The unique identifier of subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the subscription entitlement plan commitments was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionProducts-productRelationships-item-response

Type: object

Show Source

• AmendmentReason: string
  Title: Amendment Reason

  Read Only: true

  Maximum Length: 30

  The amendment reason of the product relationship.
• AmendmentReasonCode: string
  Read Only: true

  Maximum Length: 30

  The amendment reason code of the product relationship.
• EffectiveDate: string (date)
  Title: Effective Date

  Read Only: true

  The effective date of the product relationship.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProductId: integer (int64)
  Read Only: true

  The source product ID of the product relationship.
• ProductPuid: string
  Read Only: true

  Maximum Length: 120

  The source product PUID of the product relationship.
• RelatedLineName: string
  Title: Related Line

  Read Only: true

  Maximum Length: 300

  The name of the related product.
• RelatedLineNumber: string
  Read Only: true

  Maximum Length: 300

  The number of the related product.
• RelatedLinePuid: string
  Title: Related Line

  Read Only: true

  Maximum Length: 120

  The PUID of the related product.
• RelatedLineStatus: string
  Title: Related Line Status

  Read Only: true

  Maximum Length: 4000

  The status of the related product.
• RelatedLineStatusCode: string
  Read Only: true

  Maximum Length: 30

  The status code of the related product.
• RelatedLineSubscriptionId: integer (int64)
  Read Only: true

  The subscription ID of the related product.
• RelatedSubscriptionNumber: string
  Title: Related Subscription

  Read Only: true

  Maximum Length: 120

  The subscription number of the related product.
• Relationship: string
  Title: Relationship

  Read Only: true

  Maximum Length: 4000

  The relationship of the product relationship.
• RelationshipCode: string
  Read Only: true

  Maximum Length: 255

  The relationship code of the product relationship.
• SubscriptionId: integer (int64)
  Read Only: true

  The source subscription ID of the product relationship.
• SubscriptionProductId: integer (int64)
  Read Only: true

  The subscription product ID of the source subscription.

{
    "type":"object",
    "properties":{
        "AmendmentReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"The amendment reason code of the product relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelatedLineNumber":{
            "maxLength":300,
            "type":"string",
            "description":"The number of the related product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductId":{
            "type":"integer",
            "description":"The source product ID of the product relationship.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RelatedLineStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"The status code of the related product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelatedLineName":{
            "title":"Related Line",
            "maxLength":300,
            "type":"string",
            "description":"The name of the related product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The source product PUID of the product relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelatedLineStatus":{
            "title":"Related Line Status",
            "maxLength":4000,
            "type":"string",
            "description":"The status of the related product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The source subscription ID of the product relationship.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AmendmentReason":{
            "title":"Amendment Reason",
            "maxLength":30,
            "type":"string",
            "description":"The amendment reason of the product relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipCode":{
            "maxLength":255,
            "type":"string",
            "description":"The relationship code of the product relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Relationship":{
            "title":"Relationship",
            "maxLength":4000,
            "type":"string",
            "description":"The relationship of the product relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelatedLinePuid":{
            "title":"Related Line",
            "maxLength":120,
            "type":"string",
            "description":"The PUID of the related product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RelatedSubscriptionNumber":{
            "title":"Related Subscription",
            "maxLength":120,
            "type":"string",
            "description":"The subscription number of the related product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The subscription product ID of the source subscription.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RelatedLineSubscriptionId":{
            "type":"integer",
            "description":"The subscription ID of the related product.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EffectiveDate":{
            "title":"Effective Date",
            "type":"string",
            "description":"The effective date of the product relationship.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionProducts-relationships-item-response

Type: object

Show Source

• 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
  Title: Operation Links PUID

  Maximum Length: 120

  The public unique identifier of the operation links.
• RelationshipTypeCode: string
  Title: Type

  Maximum Length: 30

  The code indicating the type of the relationship.
• SourceAssetKey: string
  Title: Source Asset Key

  Maximum Length: 120

  The source asset key
• SourceProdAssociationId: integer (int64)
  Title: Source Product Association ID

  The unique identifier of the source product association.
• SourceProdAssociationPuid: string
  Title: Source Product Association PUID

  Maximum Length: 120

  The public unique identifier of the source product association.
• SourceProductPuid: string
  Title: Source Product PUID

  Maximum Length: 120

  The public unique identifier of the source product.
• SourceRootAssetKey: string
  Title: Source Root Asset Key

  Maximum Length: 120

  The source root asset key
• TargetProdAssociationId: integer (int64)
  Title: Target Product Association ID

  The unique identifier of the target product association.
• TargetProdAssociationPuid: string
  Title: Target Product Association PUID

  Maximum Length: 120

  The public unique identifier of the target product association.
• TargetProductPuid: string
  Title: Target Product PUID

  Maximum Length: 120

  The public unique identifier of the target product.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the relationship.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the relationship was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the relationship.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceProdAssociationId":{
            "title":"Source Product Association ID",
            "type":"integer",
            "description":"The unique identifier of the source product association.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TargetProdAssociationId":{
            "title":"Target Product Association ID",
            "type":"integer",
            "description":"The unique identifier of the target product association.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceAssetKey":{
            "title":"Source Asset Key",
            "maxLength":120,
            "type":"string",
            "description":"The source asset key",
            "nullable":true,
            "x-queryable":true
        },
        "SourceProductPuid":{
            "title":"Source Product PUID",
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the source product.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipTypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of the relationship.",
            "nullable":false,
            "x-queryable":true
        },
        "OperationLinksPuid":{
            "title":"Operation Links PUID",
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the operation links.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SourceRootAssetKey":{
            "title":"Source Root Asset Key",
            "maxLength":120,
            "type":"string",
            "description":"The source root asset key",
            "nullable":true,
            "x-queryable":true
        },
        "SourceProdAssociationPuid":{
            "title":"Source Product Association PUID",
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the source product association.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetProductPuid":{
            "title":"Target Product PUID",
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the target product.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetProdAssociationPuid":{
            "title":"Target Product Association PUID",
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the target product association.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the relationship was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionProducts-salesCredits-item-response

Type: object

Show Source

• 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)
  Title: End 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
  Title: Percent

  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
  Title: Number

  Maximum Length: 120

  The public unique identifier of the sales credit.
• SalesCreditType: string
  The type of the sales credit.
• SalesCreditTypeId: integer (int64)
  Title: Credit Type

  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)
  Title: Salesperson

  The unique identifier of the sales representative.
• StartDate: string (date)
  Title: Start Date

  The date when the sales credit started.
• SubscriptionId: integer (int64)
  The unique identifier of the subscription.
• SubscriptionProductId: integer (int64)
  Title: Subscription Product ID

  The unique identifier of the subscription product.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the sales credit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the sales credit was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the sales credit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Percentage":{
            "title":"Percent",
            "type":"number",
            "description":"The percentage",
            "nullable":false,
            "x-hints":{
                "precision":5,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "scale":2
            },
            "x-queryable":true
        },
        "SalesPerson":{
            "type":"string",
            "description":"The name of the sales person.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "SalesCreditTypeId":{
            "title":"Credit Type",
            "type":"integer",
            "description":"The unique identifier of the type of the sales credit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"choice",
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.subscriptions.subscriptionManagement.model.view.SalesCreditTypeVO",
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"Name",
                "fnd:FND_AUDIT_FK_VIEWOBJECT_QRY_FORCEEXEC":"true",
                "fnd:FND_AUDIT_FK_WHEREATTR":"SalesCreditTypeId"
            },
            "x-queryable":true
        },
        "SalesrepId":{
            "title":"Salesperson",
            "type":"integer",
            "description":"The unique identifier of the sales representative.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.subscriptions.subscriptionManagement.model.view.AllSalesrepVO",
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"PartyName",
                "fnd:FND_AUDIT_FK_VIEWOBJECT_QRY_FORCEEXEC":"true",
                "fnd:FND_AUDIT_FK_WHEREATTR":"ResourceSalesrepId"
            },
            "x-queryable":true
        },
        "SalesPersonNumber":{
            "title":"Salesperson Number",
            "type":"string",
            "description":"The alternate identifier of a salesperson.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "sortable":false
            }
        },
        "QuotaFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the quota has been fulfilled.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesCreditType":{
            "type":"string",
            "description":"The type of the sales credit.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the sales credit was ends.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the sales credit started.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.subscriptions.subscriptionManagement.subscriptionService.view.SubscriptionsVO",
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"SubscriptionNumber",
                "fnd:FND_AUDIT_FK_VIEWOBJECT_QRY_FORCEEXEC":"true",
                "fnd:FND_AUDIT_FK_WHEREATTR":"SubscriptionId"
            },
            "x-queryable":true
        },
        "SalesCreditPuid":{
            "title":"Number",
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the sales credit.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_FORCE_WRITE":"true",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscriptionProductId":{
            "title":"Subscription Product ID",
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.subscriptions.subscriptionManagement.subscriptionService.view.ProductsVO",
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"LineNumber",
                "fnd:FND_AUDIT_FK_VIEWOBJECT_QRY_FORCEEXEC":"true",
                "fnd:FND_AUDIT_FK_WHEREATTR":"SubscriptionProductId"
            },
            "x-queryable":true
        },
        "SalesCreditId":{
            "type":"integer",
            "description":"The unique identifier of the sales credit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the sales credit was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the sales credit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionProducts-serviceResources-item-response

Type: object

Show Source

• 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
  Title: Service Identifier

  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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the service resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date on which the service resource was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ServiceResourcePuid":{
            "title":"Service Identifier",
            "maxLength":120,
            "type":"string",
            "description":"The PUID of the service resource.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the service resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ServiceResourceId":{
            "type":"integer",
            "description":"The unique identifier of the service resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date of the service resource.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ServiceId":{
            "title":"Service Identifier",
            "maxLength":120,
            "type":"string",
            "description":"The unique identifier of the service.",
            "nullable":false,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the service resource.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enable Service Resource",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the service resource is enabled or not.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the service resource was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the service resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionProducts-smartActions-item-response

Type: object

Show Source

• ActionIntent: string (byte)
  Title: Action Intent

  The JSON object that describes what an action does and what context data can be passed to the action.
• ConfirmationMessage: string
  Title: Confirmation Message

  Maximum Length: 4000

  A message seeking confirmation for the action being performed.
• ContentType: string
  Title: Content Type

  Maximum Length: 50

  The content type used when invoking the REST endpoint.
• DisplayLabel: string
  Title: Action Name

  Maximum Length: 256

  The display label of the subscription smart actions.
• Entity: string
  Title: Parent Entity

  Maximum Length: 150

  The entity of the subscription smart actions.
• Href: string
  Title: REST Endpoint

  Maximum Length: 1024

  The HREF of the subscription smart actions.
• IncludedInApplication: string
  Title: Included in Application

  Maximum Length: 512

  The included in application flag of the subscription smart actions.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MassActionFlag: boolean
  Title: Mass Action

  Maximum Length: 1

  The mass action flag of the smart action.
• Method: string
  Title: HTTP Method

  Maximum Length: 15

  The method associated with the subscription smart actions.
• ObjectFunctionName: string
  Title: Object Function

  Maximum Length: 64

  The object function name of the smart action.
• PageType: string
  Title: Page Type

  Maximum Length: 256

  The page type of the smart action.
• SmartSuggestFlag: boolean
  Title: Smart Suggest

  Maximum Length: 1

  The smart suggest flag of the smart action.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  The flag indicating if the action is seeded or custom.
• UpdateOfAttributes: string
  Title: Attributes to Update

  Maximum Length: 512

  The update of attributes flag of the subscription smart actions.
• UserActionId: integer (int64)
  Title: User Action ID

  The unique identifier of the subscription user actions.
• UserActionName: string
  Title: Action Name

  Maximum Length: 256

  The name of the subscription user actions.
• UserActionNavigation: array User Action Request Payload
  Title: User Action Request Payload

  The user action navigation resource stores the UI navigation metadata striped by app usage.
• UserActionRank: integer (int64)
  Title: Priority

  The user rank action of the smart action.
• UserActionRequestPayload: array User Action URL Binding
  Title: User Action URL Binding

  The user action request payload resource stores the payload information for every user action request.
• UserActionURLBinding: array User Action Navigation
  Title: User Action Navigation

  The user action URL binding resource stores the binding metadata for a variable in the URL.

{
    "type":"object",
    "properties":{
        "SmartSuggestFlag":{
            "title":"Smart Suggest",
            "maxLength":1,
            "type":"boolean",
            "description":"The smart suggest flag of the smart action.",
            "nullable":true,
            "x-queryable":true
        },
        "Entity":{
            "title":"Parent Entity",
            "maxLength":150,
            "type":"string",
            "description":"The entity of the subscription smart actions.",
            "nullable":true,
            "x-queryable":true
        },
        "ContentType":{
            "title":"Content Type",
            "maxLength":50,
            "type":"string",
            "description":"The content type used when invoking the REST endpoint.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionURLBinding":{
            "title":"User Action Navigation",
            "type":"array",
            "description":"The user action URL binding resource stores the binding metadata for a variable in the URL.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-smartActions-UserActionURLBinding-item-response"
            }
        },
        "MassActionFlag":{
            "title":"Mass Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The mass action flag of the smart action.",
            "nullable":true,
            "x-queryable":true
        },
        "IncludedInApplication":{
            "title":"Included in Application",
            "maxLength":512,
            "type":"string",
            "description":"The included in application flag of the subscription smart actions.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavigation":{
            "title":"User Action Request Payload",
            "type":"array",
            "description":"The user action navigation resource stores the UI navigation metadata striped by app usage.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-smartActions-UserActionNavigation-item-response"
            }
        },
        "Href":{
            "title":"REST Endpoint",
            "maxLength":1024,
            "type":"string",
            "description":"The HREF of the subscription smart actions.",
            "nullable":true,
            "x-queryable":true
        },
        "Method":{
            "title":"HTTP Method",
            "maxLength":15,
            "type":"string",
            "description":"The method associated with the subscription smart actions.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayLabel":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"The display label of the subscription smart actions.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionName":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"The name of the subscription user actions.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionId":{
            "title":"User Action ID",
            "type":"integer",
            "description":"The unique identifier of the subscription user actions.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UserActionRank":{
            "title":"Priority",
            "type":"integer",
            "description":"The user rank action of the smart action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            },
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The flag indicating if the action is seeded or custom.",
            "nullable":true,
            "x-queryable":true
        },
        "ConfirmationMessage":{
            "title":"Confirmation Message",
            "maxLength":4000,
            "type":"string",
            "description":"A message seeking confirmation for the action being performed.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionRequestPayload":{
            "title":"User Action URL Binding",
            "type":"array",
            "description":"The user action request payload resource stores the payload information for every user action request.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-smartActions-UserActionRequestPayload-item-response"
            }
        },
        "UpdateOfAttributes":{
            "title":"Attributes to Update",
            "maxLength":512,
            "type":"string",
            "description":"The update of attributes flag of the subscription smart actions.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionIntent":{
            "title":"Action Intent",
            "type":"string",
            "description":"The JSON object that describes what an action does and what context data can be passed to the action.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ObjectFunctionName":{
            "title":"Object Function",
            "maxLength":64,
            "type":"string",
            "description":"The object function name of the smart action.",
            "nullable":true,
            "x-queryable":true
        },
        "PageType":{
            "title":"Page Type",
            "maxLength":256,
            "type":"string",
            "description":"The page type of the smart action.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : User Action Request Payload

Type: array

Title: User Action Request Payload

The user action navigation resource stores the UI navigation metadata striped by app usage.

Show Source

• Array of: object subscriptionProducts-smartActions-UserActionNavigation-item-response

{
    "title":"User Action Request Payload",
    "type":"array",
    "description":"The user action navigation resource stores the UI navigation metadata striped by app usage.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-smartActions-UserActionNavigation-item-response"
    }
}

Nested Schema : User Action URL Binding

Type: array

Title: User Action URL Binding

The user action request payload resource stores the payload information for every user action request.

Show Source

• Array of: object subscriptionProducts-smartActions-UserActionRequestPayload-item-response

{
    "title":"User Action URL Binding",
    "type":"array",
    "description":"The user action request payload resource stores the payload information for every user action request.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-smartActions-UserActionRequestPayload-item-response"
    }
}

Nested Schema : User Action Navigation

Type: array

Title: User Action Navigation

The user action URL binding resource stores the binding metadata for a variable in the URL.

Show Source

• Array of: object subscriptionProducts-smartActions-UserActionURLBinding-item-response

{
    "title":"User Action Navigation",
    "type":"array",
    "description":"The user action URL binding resource stores the binding metadata for a variable in the URL.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-smartActions-UserActionURLBinding-item-response"
    }
}

Nested Schema : subscriptionProducts-smartActions-UserActionNavigation-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  The system action flag of the user action navigation.
• UserActionNavAppUsage: string
  Title: Application Usage

  Maximum Length: 50

  The user action navigation application usage.
• UserActionNavBody: string
  Title: Navigation Metadata

  Maximum Length: 1000

  The body of user action navigation.
• UserActionNavId: integer (int64)
  Title: Primary Key

  The unique identifier of the subscription user action navigation.
• UserActionNavType: string
  Title: Navigation Type

  Maximum Length: 100

  The type of user action navigation.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The system action flag of the user action navigation.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "UserActionNavId":{
            "title":"Primary Key",
            "type":"integer",
            "description":"The unique identifier of the subscription user action navigation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UserActionNavType":{
            "title":"Navigation Type",
            "maxLength":100,
            "type":"string",
            "description":"The type of user action navigation.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionNavBody":{
            "title":"Navigation Metadata",
            "maxLength":1000,
            "type":"string",
            "description":"The body of user action navigation.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavAppUsage":{
            "title":"Application Usage",
            "maxLength":50,
            "type":"string",
            "description":"The user action navigation application usage.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionProducts-smartActions-UserActionRequestPayload-item-response

Type: object

Show Source

• Binding: string
  Title: Payload Value Binding Type

  Maximum Length: 64

  The binding of the user action payload.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MandatoryFlag: boolean
  Title: Mandatory

  Maximum Length: 1

  The mandatory flag of the user action payload.
• RequestPayloadId: integer (int64)
  The request payload ID of the user action.
• RequestPayloadName: string
  Title: Request Payload Attribute Name

  Maximum Length: 256

  The request payload name of the user action.
• SmartSuggestPath: string
  Title: Smart Suggest Path

  Maximum Length: 2048

  The smart suggest path of the user action payload.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  The system action flag of the user action request payload.
• Value: string
  Title: Request Payload Attribute Value

  Maximum Length: 1000

  The value of the user action payload.
• ValueStruct: string
  Title: Payload Value Structure

  Maximum Length: 20

  The value structure of the user action payload.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"Payload Value Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"The binding of the user action payload.",
            "nullable":true,
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The system action flag of the user action request payload.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ValueStruct":{
            "title":"Payload Value Structure",
            "maxLength":20,
            "type":"string",
            "description":"The value structure of the user action payload.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"Request Payload Attribute Value",
            "maxLength":1000,
            "type":"string",
            "description":"The value of the user action payload.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SmartSuggestPath":{
            "title":"Smart Suggest Path",
            "maxLength":2048,
            "type":"string",
            "description":"The smart suggest path of the user action payload.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestPayloadId":{
            "type":"integer",
            "description":"The request payload ID of the user action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequestPayloadName":{
            "title":"Request Payload Attribute Name",
            "maxLength":256,
            "type":"string",
            "description":"The request payload name of the user action.",
            "nullable":false,
            "x-queryable":true
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":1,
            "type":"boolean",
            "description":"The mandatory flag of the user action payload.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionProducts-smartActions-UserActionURLBinding-item-response

Type: object

Show Source

• Binding: string
  Title: URL Binding Type

  Maximum Length: 64

  The URL binding of user action.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  The system action flag of the user action URL binding.
• URLBindingId: integer (int64)
  The identifier of URL binding of user action.
• URLBindingName: string
  Title: URL Binding Parameter Name

  Maximum Length: 256

  The name of URL binding of user action.
• Value: string
  Title: URL Binding Parameter Value

  Maximum Length: 1000

  The value of URL binding of user action.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"URL Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"The URL binding of user action.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"URL Binding Parameter Value",
            "maxLength":1000,
            "type":"string",
            "description":"The value of URL binding of user action.",
            "nullable":true,
            "x-queryable":true
        },
        "URLBindingId":{
            "type":"integer",
            "description":"The identifier of URL binding of user action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The system action flag of the user action URL binding.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "URLBindingName":{
            "title":"URL Binding Parameter Name",
            "maxLength":256,
            "type":"string",
            "description":"The name of URL binding of user action.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

AccountingRuleVA

Operation: /crmRestApi/resources/11.13.18.05/accountingRules

Parameters:

• finder: AccountingRulebyAccStatusFinder%3BbindStatus%3DI

The list of values indicating the accounting rule names.

The following properties are defined on the LOV link relation:

• Source Attribute: AccountingRuleName; Target Attribute: Name
• Display Attribute: Name

AmendReasonVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_CLOSE_REASONS

The list of values indicating the suspend reasons.

The following properties are defined on the LOV link relation:

• Source Attribute: SuspendReason; Target Attribute: LookupCode
• Display Attribute: Meaning

BillToAccountVA

Operation: /crmRestApi/resources/11.13.18.05/billToAccounts

Parameters:

• finder: PrimaryPartyIdFinder%3BprimaryPartyId%3D{BillToPartyId}

The list of values indicating the bill to account numbers.

The following properties are defined on the LOV link relation:

• Source Attribute: BillToAccountNumber; Target Attribute: AccountNumber
• Display Attribute: AccountNumber, AccountName

BillToContactsVA

Operation: /crmRestApi/resources/11.13.18.05/billToContacts

The list of values indicating the bill to contact name.

The following properties are defined on the LOV link relation:

• Source Attribute: BillToContactName; Target Attribute: Name
• Display Attribute: Name, JobTitle, EmailAddress

BillToSiteActiveViewAccessor

Operation: /crmRestApi/resources/11.13.18.05/billToSites

Parameters:

• finder: BillToSiteFinder%3BBindCustAcctId%3D{BillToAccountId}%2CBindSiteUseCd%3DBILL_TO

The list of values indicating the bill to site.

The following properties are defined on the LOV link relation:

• Source Attribute: BillToSite; Target Attribute: Location
• Display Attribute: Location, Address, StartDate1, EndDate1, Status1

ChangeReasonVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_CLOSE_REASONS

The list of values indicating the product change reasons.

The following properties are defined on the LOV link relation:

• Source Attribute: ProductChangeReason; Target Attribute: LookupCode
• Display Attribute: Meaning

DefaultRevenueActionPVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_RMCS_RULE

The list of values indicating the default revenue option for products.

The following properties are defined on the LOV link relation:

• Source Attribute: DefaultRevenueAction; Target Attribute: LookupCode
• Display Attribute: Meaning

EarlyTerminationPenaltyVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_EARLY_TERM_FEE

The list of values indicating the early termination penalty.

The following properties are defined on the LOV link relation:

• Source Attribute: EarlyTerminationPenalty; Target Attribute: LookupCode
• Display Attribute: Meaning

EntitlementTypeVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_ENTITLEMENT_TYPE

The list of values indicating the entitlement type.

The following properties are defined on the LOV link relation:

• Source Attribute: EntitlementType; Target Attribute: LookupCode
• Display Attribute: Meaning

InvoiceRuleVA

Operation: /crmRestApi/resources/11.13.18.05/invoiceRules

Parameters:

• finder: InvoiceRuleTypeFinder%3BBindType%3DI

The list of values indicating the invoice rule name.

The following properties are defined on the LOV link relation:

• Source Attribute: InvoicingRuleName; Target Attribute: Name
• Display Attribute: Name

ItemVA

Operation: /crmRestApi/resources/11.13.18.05/itemNames

Parameters:

• finder: DefinitionOrgAndWarrantyFinder

The list of values indicating the product name.

The following properties are defined on the LOV link relation:

• Source Attribute: ProductName; Target Attribute: ItemNumber
• Display Attribute: ItemNumber, Description

NonFusionRatePlanVA

Operation: /crmRestApi/resources/11.13.18.05/eligibleRatePlans

Parameters:

• finder: EligibleRatePlanFinder

The following properties are defined on the LOV link relation:

• Source Attribute: RequestedRatePlanNumber; Target Attribute: RatePlanNumber
• Display Attribute: RatePlanNumber, RatePlanId

PaymentSetIdVA

Operation: /crmRestApi/resources/11.13.18.05/paymentSets

Parameters:

• finder: BuIdAndBillToAccountAndPrepaymentNoFinder%3BbindBillToAccount%3D{BillToAccountId}

The list of values indicating the pre payment numbers.

The following properties are defined on the LOV link relation:

• Source Attribute: PrePaymentNumber; Target Attribute: PaymentSetId
• Display Attribute: PaymentSetId

PaymentTermsLOVVA

Operation: /crmRestApi/resources/11.13.18.05/paymentTerms

Parameters:

• finder: PaymentTermsByEndDateFinder%3BBindEndDate%3D{calculated value}

The list of values indicating the payment terms names.

The following properties are defined on the LOV link relation:

• Source Attribute: PaymentTermsName; Target Attribute: Name
• Display Attribute: Name, TermId

PeriodVA

Operation: /crmRestApi/resources/11.13.18.05/timeUnitOfMeasures

The list of values indicating the resume period.

The following properties are defined on the LOV link relation:

• Source Attribute: ResumePeriod; Target Attribute: UomCode
• Display Attribute: UnitOfMeasure

PreventiveMaintenanceProgramsLOVVA

Operation: /crmRestApi/resources/11.13.18.05/preventiveMaintenancePrograms

Parameters:

• finder: PreventiveMaintenanceProgramsByEffectivityAndSubTypeFinder

The list of values indicating the program name.

The following properties are defined on the LOV link relation:

• Source Attribute: ProgramName; Target Attribute: ProgramName
• Display Attribute: ProgramName, ProgramCode, OrganizationCode, ProgramDescription

PriceAdjustmentBasisVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_RNWL_PRICE_ADJ_BASIS

The list of values indicating the price adjustment basis.

The following properties are defined on the LOV link relation:

• Source Attribute: PriceAdjustmentBasis; Target Attribute: LookupCode
• Display Attribute: Meaning

PriceAdjustmentTypeVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_RNWL_PRICE_ADJ_TYPE

The list of values indicating the price adjustment type.

The following properties are defined on the LOV link relation:

• Source Attribute: PriceAdjustmentType; Target Attribute: LookupCode
• Display Attribute: Meaning

PricingMethodVA

Operation: /crmRestApi/resources/11.13.18.05/pricingTermMethods

Parameters:

• finder: PricingSystemAndRatePlanIdFinder

The list of values indicating the indicating the pricing terms pricing methods.

The following properties are defined on the LOV link relation:

• Source Attribute: PricingTermsPricingMethod; Target Attribute: LookupCode
• Display Attribute: Meaning

PrimaryPartyVA

Operation: /crmRestApi/resources/11.13.18.05/primaryParties

Parameters:

• finder: PrimaryPartyByStatusFinder%3BbindStatus%3DA

The list of values indicating the bill to party name.

The following properties are defined on the LOV link relation:

• Source Attribute: BillToPartyName; Target Attribute: PartyName
• Display Attribute: PartyName, PartyNumber

ProductCloseCreditMethodVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

ProductCloseReasonVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

ProductCreditTypeVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_CREDIT_TYPES

The following properties are defined on the LOV link relation:

• Source Attribute: CreditType; Target Attribute: LookupCode
• Display Attribute: Meaning

RelatedItemNameVA

Operation: /crmRestApi/resources/11.13.18.05/relatedItemNames

Parameters:

• finder: OrgIdAndSalesProdTypeFinder%3BbindOrgId%3D{DefinitionOrganizationId}%2CbindSalesProdType%3D{SalesProductType}

The list of values indicating the related product names.

The following properties are defined on the LOV link relation:

• Source Attribute: RelatedProductName; Target Attribute: ItemNumber
• Display Attribute: ItemNumber

RenewalPriceListsVA

Operation: /crmRestApi/resources/11.13.18.05/requestedPriceLists

Parameters:

• finder: PriceListPickerFinder%3Bline_type_code%3DORA_BUY

The following properties are defined on the LOV link relation:

• Source Attribute: RenewalPriceListName; Target Attribute: Name
• Display Attribute: Name

RenewalTypeVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_RENEWAL_ACTION

The list of values indicating the renewal type.

The following properties are defined on the LOV link relation:

• Source Attribute: RenewalType; Target Attribute: LookupCode
• Display Attribute: Meaning

RequestedPriceListsVA

Operation: /crmRestApi/resources/11.13.18.05/requestedPriceLists

Parameters:

• finder: PriceListFinderByCurrency%3Bline_type_code%3DORA_BUY%2Citem_id%3D{InventoryItemId}%2Ccurrency_code%3D{CorpCurrencyCode}%2Cpricing_uom_code%3D{ItemUnitOfMeasure}

The following properties are defined on the LOV link relation:

• Source Attribute: RequestedPriceListId; Target Attribute: PriceListId
• Display Attribute: Name

RevenueOptionVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_REV_OPTIONS

The list of values indicating the revenue option for products.

The following properties are defined on the LOV link relation:

• Source Attribute: RevenueOption; Target Attribute: LookupCode
• Display Attribute: Meaning

SalesProductTypeLookupVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

ShipToAccountVA

Operation: /crmRestApi/resources/11.13.18.05/shipToAccounts

Parameters:

• finder: SubscriptionIdAndPrimaryPartyIdFinder%3BbindSubscriptionId%3D{SubscriptionId}%2CprimaryPartyId%3D{ShipToPartyId}

The list of values indicating the ship to account number.

The following properties are defined on the LOV link relation:

• Source Attribute: ShipToAccountNumber; Target Attribute: AccountNumber
• Display Attribute: AccountNumber, AccountName

ShipToExternalContactsVA

Operation: /crmRestApi/resources/11.13.18.05/externalContacts

Parameters:

• finder: ExternalContactsbyPartyIdFinder%3BbindPartyId%3D{ShipToPartyId}

The list of values indicating the ship to contact names.

The following properties are defined on the LOV link relation:

• Source Attribute: ShipToContactName; Target Attribute: ContactName
• Display Attribute: ContactName, EmailAddress

ShipToPartySiteActiveViewAccessor

Operation: /crmRestApi/resources/11.13.18.05/shipToPartySites

Parameters:

• finder: ShipToPartySiteByActiveAndPartyIdFinder%3BBindPartyId%3D{ShipToPartyId}

The list of values indicating the ship to party site names.

The following properties are defined on the LOV link relation:

• Source Attribute: ShipToPartySiteName; Target Attribute: Address
• Display Attribute: Location, Address, StartDate, EndDate, Status1

ShipToPartyVA

Operation: /crmRestApi/resources/11.13.18.05/shipToParties

Parameters:

• finder: ShipToPartybyStatusFinder%3BBindStatus%3DA

The list of values indicating the ship to party names.

The following properties are defined on the LOV link relation:

• Source Attribute: ShipToPartyName; Target Attribute: PartyName
• Display Attribute: PartyName, PartyNumber

SubscriptionCoverageHeaderVA

Operation: /crmRestApi/resources/11.13.18.05/subscriptionCoverageHeaders

Parameters:

• finder: coverageHeaderRowFinder

The list of values indicating the coverage names

The following properties are defined on the LOV link relation:

• Source Attribute: CoverageName; Target Attribute: CoverageName
• Display Attribute: CoverageName

TimeCodeUnitsVA

Operation: /crmRestApi/resources/11.13.18.05/timeUnitOfMesaures

The list of values indicating the renewal duration period name.

The following properties are defined on the LOV link relation:

• Source Attribute: RenewalDurationPeriodName; Target Attribute: UnitOfMeasure
• Display Attribute: UnitOfMeasure

TimeUnitOfMeasureVA

Operation: /crmRestApi/resources/11.13.18.05/timeUnitOfMeasures

The list of values indicating the billing frequency name.

The following properties are defined on the LOV link relation:

• Source Attribute: BillingFrequencyName; Target Attribute: UnitOfMeasure
• Display Attribute: UnitOfMeasure

UsageInvoiceLayoutTemplateVA

Operation: /crmRestApi/resources/11.13.18.05/subscriptionsTemplates

Parameters:

• finder: ReportPathFinder%3BReportPath%3D{UsageInvoiceLayoutReportPath}

The list of values indicating the usage invoice layout template.

The following properties are defined on the LOV link relation:

• Source Attribute: UsageInvoiceLayoutTemplate; Target Attribute: TemplateName
• Display Attribute: TemplateName

WareHouseVA

Operation: /crmRestApi/resources/11.13.18.05/wareHouses

Parameters:

• finder: WareHousebyOrganizationIdFinder%3BBindOrgId%3D{DefinitionOrganizationId}

The list of values indicating the warehouse name.

The following properties are defined on the LOV link relation:

• Source Attribute: WareHouseName; Target Attribute: OrganizationName
• Display Attribute: OrganizationCode, OrganizationName

amend

Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/action/amend

Parameters:

• SubscriptionProductPuid: $request.path.SubscriptionProductPuid

This method lets you amend a subscription product with an amendment effective date, reason, description and other inputs.

associatedAsset

Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/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.

billLines

Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/billLines

Parameters:

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

cancel

Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/action/cancel

Parameters:

• SubscriptionProductPuid: $request.path.SubscriptionProductPuid

This method lets you cancel the subscription product with a reason on a specific date.

charges

Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/charges

Parameters:

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

close

Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/action/close

Parameters:

• SubscriptionProductPuid: $request.path.SubscriptionProductPuid

This method lets you close a subscription product on a specific date with a reason

coveredLevels

Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels

Parameters:

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

creditCards

Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/creditCards

Parameters:

• SubscriptionProductPuid: $request.path.SubscriptionProductPuid

The credit cards resource is used to view, create, and update the credit cards associated with a subscription.

duplicateProduct

Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/action/duplicateProduct

Parameters:

• SubscriptionProductPuid: $request.path.SubscriptionProductPuid

This method lets you duplicate a subscription product. You must provide a Subscription Product PUID to duplicate.

flexFields

Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/flexFields

Parameters:

• SubscriptionProductPuid: $request.path.SubscriptionProductPuid

The descriptive flexfields resource is used to view, create, update, and delete a descriptive flexfield.

move

Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/action/move

Parameters:

• SubscriptionProductPuid: $request.path.SubscriptionProductPuid

This method lets you move a subscription product to a target subscription.

negotiatedEntitlementPlanCommitments

Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/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.

negotiatedEntitlementPlanDetails

Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/negotiatedEntitlementPlanDetails

Parameters:

• SubscriptionProductPuid: $request.path.SubscriptionProductPuid

The subscription entitlement plan details resource is used to view, create, update, and delete an entitlement plan detail.

negotiatedEntitlementPlanEstimates

Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/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.

negotiatedVolumePricingRules

Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/negotiatedVolumePricingRules

Parameters:

• SubscriptionProductPuid: $request.path.SubscriptionProductPuid

The subscription entitlement plan charge rules resource is used to view, create, update, and delete a negotiated entitlement plan charge rule which is used for the rating of a subscription product.

productRelationships

Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/productRelationships

Parameters:

• SubscriptionProductPuid: $request.path.SubscriptionProductPuid

The product relationships resource is used to view the relationship between a source and a target product. These relationships include amendment, renewal, suspension relationships.

putOnHold

Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/action/putOnHold

Parameters:

• SubscriptionProductPuid: $request.path.SubscriptionProductPuid

This method lets you put a subscription product on hold.

relationships

Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/relationships

Parameters:

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

removeHold

Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/action/removeHold

Parameters:

• SubscriptionProductPuid: $request.path.SubscriptionProductPuid

This method lets you remove hold on a subscription product.

resume

Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/action/resume

Parameters:

• SubscriptionProductPuid: $request.path.SubscriptionProductPuid

This method lets you resume a suspended subscription product.

salesCredits

Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/salesCredits

Parameters:

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

serviceResources

Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/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.

smartActions

Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/smartActions

Parameters:

• SubscriptionProductPuid: $request.path.SubscriptionProductPuid

The smart actions resource stores the endpoint and security details for every user action.

submitEssJobRequest

Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/action/submitEssJobRequest

Parameters:

• SubscriptionProductPuid: $request.path.SubscriptionProductPuid

This method lets you submit a scheduled process with a job name and other input parameters.

suspend

Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/action/suspend

Parameters:

• SubscriptionProductPuid: $request.path.SubscriptionProductPuid

This method lets you suspend the subscription product on a specific date with a reason.

undoClose

Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/action/undoClose

Parameters:

• SubscriptionProductPuid: $request.path.SubscriptionProductPuid

This method lets you undo close of a subscription product.

Back to Top

Examples

The following example shows how to update a subscription by submitting a PATCH request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptions/GP-5678

Example of Request Body

The following example shows the contents of the request body in JSON format.

{
    "EndDate": "2019-12-25"
}

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
    "SubscriptionId": 300100177254423,
    "SubscriptionNumber": "GP-5678",
    "BusinessUnitId": 204,
    "BusinessUnitName": "Vision Operations",
    "LegalEntityId": 204,
    "LegalEntityName": "Vision Operations",
    "SubscriptionProfileId": 300100172161473,
    "SubscriptionProfileName": "zOSS_SP_ServiceStartActual_Advance_Month",
    "PrimaryPartyId": 1001,
    "PrimaryPartyName": "A T & T SOLUTIONS INC",
    "PricedOnDate": "2019-06-04T00:00:00+00:00",
    "PricingStrategyId": null,
    "PricingStrategyExplanation": null,
    "PricingSegment": null,
    "PricingSegmentExplanation": null,
    "SegmentExplanationMessage": null,
    "Currency": "USD",
    "CurrencyName": "US Dollar",
    "CurrencyConversionRate": null,
    "CurrencyConversionRateType": null,
    "CurrencyConversionRateDate": null,
    "StartDate": "2019-01-01",
    "Duration": 359,
    "Period": "DY",
    "EndDate": "2019-12-25",
    "DefinitionOrganizationId": 204,
    "PartialPeriodType": "ORA_ACTUAL",
    "PartialPeriodStart": "ORA_SERVICE",
    "CloseReason": null,
    "ClosedDate": null,
    "CloseCreditMethod": null,
    "ApprovalNote": null,
    "CancelReason": null,
    "CanceledDate": null,
    "ApprovedDate": null,
    "RenewedDate": null,
    "ShortDescription": null,
    "Description": null,
    "Status": "ORA_DRAFT",
    "UserStatus": null,
    "BillService": "ORA_BILL",
    "BillServiceName": "Bill",
    "InvoicingRuleId": -2,
    "InvoicingRuleName": "Advance Invoice",
    "BillingDateCode": "ORA_PERIOD_START",
    "BillingDateName": "Period start",
    "BillOnDay": null,
    "BillingOffsetDays": null,
    "BillingFrequency": "0zG",
    "BillingFrequencyName": "MONTH",
    "AccountingRuleId": 300100033038413,
    "AccountingRuleName": "3 Months, Deferred",
    "TransactionTypeName": "ORA_OSS_Invoice",
    "BillingSystem": null,
    "SubscriptionInvoiceText": "[$Item Name]: [$Charge Name] [$Bill from Date]-[$Bill to Date]",
    "CoverageInvoiceText": null,
    "BillToAccountId": 1001,
    "BillToAccountNumber": "1001",
    "BillToAccountDescription": "A T & T SOLUTIONS INC",
    "BillToSiteUseId": 1006,
    "BillToAddress": "32 Ave of the Americas,NEW YORK, NY 10013",
    "ShipToParty": null,
    "ShipToPartyName": null,
    "ShipToPartySiteId": null,
    "ShipToSite": null,
    "PaymentMethod": null,
    "PaymentMethodName": null,
    "PONumber": null,
    "WireNumber": null,
    "PaymentTermsId": 1064,
    "PaymentTermsName": "Immediate",
    "TaxClassificationCode": null,
    "TaxClassificationMeaning": null,
    "ExemptCertificateNumber": null,
    "ExemptReason": null,
    "ExemptReasonMeaning": null,
    "TaxExemptionHandling": "S",
    "TaxExemptionHandlingName": "Standard",
    "DocumentFiscalClassification": null,
    "CustomerAcceptance": null,
    "InternalApproval": "REQUIRED",
    "LayoutTemplate": null,
    "CommunicationChannel": null,
    "PrimarySalesPerson": null,
    "NegotiationLanguage": null,
    "QuoteToContactId": null,
    "EnableRenewalRemindersFlag": null,
    "RenewalProcess": null,
    "DaysBeforeExpiry": null,
    "QuoteToCcEmail": null,
    "RenewalPricingMethodUsed": null,
    "RenewalProcessUsed": null,
    "PriceAdjustmentPercentUsed": null,
    "DaysBeforeExpiryUsed": null,
    "AssigneeId": null,
    "AssigneeType": null,
    "TotalContractValue": null,
    "EstimatedTax": null,
    "CreditedAmount": null,
    "ClosedAmount": null,
    "CanceledAmount": null,
    "InvoicedAmount": null,
    "SourceSystem": null,
    "SourceKey": null,
    "SourceNumber": null,
    "RenewalTemplateId": null,
    "NotificationTemplateId": null,
    "RenewalSubscriptionProfileId": null,
    "DefaultLanguage": null,
    "GenerateBillingSchedule": null,
    "TransactionType": "ORA_SUBSCRIPTION",
    "PricingSystem": "ORA_FUSION",
    "PricingError": null,
    "CorpCurrencyCode": "USD",
    "CurcyConvRateType": "Corporate",
    "RenewalCustomerAcceptance": null,
    "RenewalInternalApproval": null,
    "RenewalPriceAdjustmentBasis": null,
    "RenewalPriceAdjustmentPercent": null,
    "RenewalPriceAdjustmentType": null,
    "AttachmentEntityName": "OSS_DOC_SUBSCRIPTION_AGREEMENT",
    "AttachmentEntityName1": "OSS_DOC_SUPPORTING_DOCUMENTS",
    "CreatedBy": "CONMGR",
    "CreationDate": "2019-06-04T04:25:03+00:00",
    "LastUpdatedBy": "CONMGR",
    "LastUpdateDate": "2019-06-04T04:29:14+00:00",
    "LastUpdateLogin": "8A5689BEEA6839CBE05322EAF40A0656",
    ...
}

Back to Top