Jump to

• Request
• Response
• Examples

Create a subscription

post

/crmRestApi/resources/11.13.18.05/subscriptions

Request

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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

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

  The name of the accounting rule.
• ApprovalNote: string
  Title: Approval Note

  Maximum Length: 240

  The approval note.
• ApprovedDate: string (date)
  Title: Approved Date

  The date on which the subscription was approved.
• AssigneeId: integer (int64)
  Title: Assignee ID

  The unique identifier of the assignee.
• AssigneeType: string
  Title: Assignee Type

  Maximum Length: 30

  The assignee type.
• AttachmentEntityName: string
  Maximum Length: 255

  Default Value: OSS_DOC_SUBSCRIPTION_AGREEMENT

  The name of the attachment entity.
• AttachmentEntityName1: string
  Default Value: OSS_DOC_SUPPORTING_DOCUMENTS

  The name of the attachment entity.
• BatchTag: string
  Title: Batch Tag

  Maximum Length: 30

  Batch Tag
• BillingDateCode: string
  Title: Billing Date

  Maximum Length: 30

  The code of the billing date.
• BillingDateName: string
  Title: Billing Date Name

  The name of the billing date.
• BillingFrequency: string
  Title: Billing Frequency

  Maximum Length: 30

  The billing frequency code.
• BillingFrequencyName: string
  Title: Billing Frequency

  The billing frequency name.
• BillingOffsetDays: integer (int64)
  Title: Offset

  The days of offset billing.
• BillingSystem: string
  Title: Billing System

  Maximum Length: 120

  The billing system.
• BillOnDay: number
  Title: Bill on Day

  The day of the bill.
• BillService: string
  Title: Bill Service

  Maximum Length: 30

  The bill service code. Values could be ORA_DO_NOT_BILL, ORA_BILL or ORA_BILL_ON_RENEWAL.
• BillServiceName: string
  Title: Bill Service Name

  The bill service option. Values could be no bill, bill or bill on renewal.
• BillToAccountDescription: string
  The description of the bill-to account.
• BillToAccountId(required): integer (int64)
  Title: Account Id

  The unique identifier of the bill to account.
• BillToAccountNumber: string
  Title: Billing Account

  Maximum Length: 30

  The alternate identifier of the bill-to account.
• BillToAddress: string
  Title: Bill-to Address

  The address to which the bill is to be sent.
• BillToContactId: integer (int64)
  Title: Bill-to Contact ID

  The bill-to contact of the subscription.
• BillToContactName: string
  Title: Bill-to Contact

  The bill-to contact name of the subscription.
• BillToContactNumber: string
  Title: Bill-to Contact Number

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

  The bill-to customer ID of the subscription.
• BillToPartyName: string
  Title: Bill-to Customer

  Maximum Length: 360

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

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

  Maximum Length: 255

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

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

  The unique identifier of the bill-to site use.
• BusinessUnitId(required): integer (int64)
  Title: BU ID

  The unique identifier of the business unit.
• BusinessUnitName: string
  Title: BU Name

  The name of the business unit.
• CalculatedCreditAmount: number
  Title: Calculated Credit Amount

  The calculated credit amount of the subscription.
• CalculateEstimatedTaxFlag: boolean
  Indicates whether estimated tax will be calculated for the subscription.
• CancelDescription: string
  Title: Cancellation Description

  Maximum Length: 2000

  The cancel reason description of the subscription.
• CanceledAmount: number
  Title: Canceled Amount

  The canceled amount.
• CanceledDate: string (date)
  Title: Canceled Date

  The date on which the subscription was canceled.
• CancelReason: string
  Title: Cancellation Reason

  Maximum Length: 30

  The reason of cancelling the subscription.
• CloseCreditMethod: string
  Title: Close Credit Method

  Maximum Length: 30

  The close credit method.
• ClosedAmount: number
  Title: Closed Amount

  The closed amount.
• ClosedDate: string (date)
  Title: Closed Date

  The date on which the subscription was closed.
• CloseDescription: string
  Title: Close Description

  Maximum Length: 2000

  The close reason description of the subscription.
• CloseReason: string
  Title: Close Reason

  Maximum Length: 30

  The reason to close the subscription.
• CommunicationChannel: string
  Title: Communication Channel

  Maximum Length: 30

  The communication channel.
• ContactRelationshipId: integer
  Contact Relationship Id
• contractAttachment: array Contract Attachments
  Title: Contract Attachments

  The contract attachments resource is used to view, create, and update attachments.
• CorpCurrencyCode: string
  Title: Currency Code

  Maximum Length: 15

  The corporate currency code.
• CoverageInvoiceText: string
  Title: Coverage Invoice Text

  Maximum Length: 4000

  The charge invoice text.
• creditCards: array Credit Cards
  Title: Credit Cards

  The credit cards resource is used to view, create, and update the credit card information associated with a subscription.
• CreditedAmount: number
  Title: Credited Amount

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

  Maximum Length: 30

  Indicates the type of credit issued to the customer such as negative invoice or credit memo.
• CurcyConvRateType: string
  Title: Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type.
• Currency(required): string
  Title: Currency

  Maximum Length: 15

  The subscription currency.
• CurrencyConversionRate: string
  Title: Conversion Rate

  Maximum Length: 30

  The currency conversion rate.
• CurrencyConversionRateDate: string (date)
  Title: Conversion Rate Date

  The currency conversion rate date.
• CurrencyConversionRateType: string
  Title: Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type.
• CurrencyName: string
  Title: Currency

  The name of subscription currency.
• CustomerAcceptance: string
  Title: Customer Acceptance

  Maximum Length: 30

  The customer acceptance.
• CustomerContactName: string
  Title: Contact Name

  Customer Contact Name
• CustomerTrxTypeSequenceId: integer (int64)
  Title: Sequence

  The unique identifier of the customer transaction type sequence.
• DaysBeforeExpiry: integer (int64)
  Title: Days Before Expiration

  The number of days before expiry.
• DaysBeforeExpiryUsed: string
  Title: Used Days Before Expiry

  Maximum Length: 18

  The days before expiry used.
• DefaultLanguage: string
  The default language.
• DefaultRevenueAction: string
  Maximum Length: 255

  The default revenue action to be taken for the subscription.
• DefinitionOrganizationCode: string
  Title: Item Master Organization Code

  The inventory organization code of the subscription.
• DefinitionOrganizationId(required): integer (int64)
  Title: Subscription Inventory Organization

  The unique identifier of the master organization.
• DefinitionOrganizationName: string
  Title: Item Master Organization

  The master organization name.
• DeleteFlag: boolean
  Indicates whether the subscription is marked for deletion.
• Description: string
  Title: Description

  Maximum Length: 1995

  The description of the subscription.
• DocumentFiscalClassification: string
  Title: Document Fiscal Classification

  Maximum Length: 30

  The document fiscal classification.
• Duration: integer
  Title: Duration

  The duration of the subscription.
• EnableAdvBipTemplateFlag: boolean
  Title: Enable advanced configuration

  Maximum Length: 1

  Default Value: false

  Indicates whether advanced BIP configuration for usage invoice templates is enabled or not.
• EnableRenewalRemindersFlag: boolean
  Title: Enable renewal reminders

  Maximum Length: 1

  Indicates whether the renewal reminders is enabled.
• EndDate: string (date)
  Title: End Date

  The date when the subscription ends.
• EstimatedTax: number
  Title: Estimated Tax

  The estimated tax.
• ExemptCertificateNumber: string
  Title: Tax Exemption Certificate Number

  Maximum Length: 80

  The tax exempt certificate number.
• ExemptReason: string
  Title: Exemption Reason Code

  Maximum Length: 30

  The tax exempt reason code.
• ExemptReasonMeaning: string
  Title: Exemption Reason

  The tax exempt reason meaning.
• flexFields: array Descriptive Flexfields
  Title: Descriptive Flexfields

  The descriptive flexfields resource is used to view, create, update, and delete a descriptive flexfield.
• FreezePriceFlag: boolean
  Title: Freeze Price

  Maximum Length: 1

  Default Value: false

  Indicates whether the price is being frozen.
• GenerateBillingSchedule: string
  The generate billing schedule.
• InternalApproval: string
  Title: Internal Approval

  Maximum Length: 30

  The internal approval.
• InvoiceBipReportCode: string
  Title: BIP Data Source

  Maximum Length: 30

  The code of the BIP report template used for the invoice attachments.
• InvoicedAmount: number
  Title: Invoiced Amount

  The invoiced amount.
• InvoicingRuleId: integer (int64)
  Title: Invoicing Rule Id

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

  The name of the invoice rule.
• LayoutTemplate: string
  Title: Contract Layout Template

  Maximum Length: 200

  The layout template.
• LegalEntityId(required): integer (int64)
  Title: Legal Entity ID

  Th unique identifier of the legal entity.
• LegalEntityName: string
  Title: Subscription Legal Entity

  The name of the legal entity.
• LineAutonumberEnabledYn: boolean
  Title: Automate subscription line numbering

  Maximum Length: 1

  Indicates if the line auto number is enabled.
• NegotiationLanguage: string
  Title: Language

  Maximum Length: 4

  The negotiation language.
• NotificationTemplateId: integer
  The unique identifier of the notification template.
• OrderLineOperationCode: string
  Title: Action Code

  Maximum Length: 80

  Order Line Operation Code
• OverrideCreditAmount: number
  Title: Override Credit Amount

  The override credit amount of the subscription.
• PartialPeriodStart(required): string
  Title: Period Start

  Maximum Length: 30

  The partial period start. Values could be calendar or service.
• PartialPeriodType(required): string
  Title: Period Type

  Maximum Length: 30

  The partial period type. Values could be actual or fixed.
• parties: array Parties
  Title: Parties

  The parties resource to view, create, update, and delete the subscription parties.
• PaymentMethod: string
  Title: Payment Method

  Maximum Length: 30

  The method of payment.
• 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.
• Period: string
  Title: Period

  The period of the subscription.
• PONumber: string
  Title: PO Number

  Maximum Length: 50

  The PO number.
• PreviewBipReportCode: string
  Title: BIP Data Source

  Maximum Length: 20

  The code of the BIP report template used for the subscription preview.
• PriceAdjustmentPercentUsed: number
  Title: Used Price Adjustment Percentage

  The price adjustment percent used.
• PricedOnDate: string (date-time)
  Title: Priced on Date

  The date on which the subscription was priced.
• PricingError: string
  Maximum Length: 2000

  The error related to pricing.
• PricingSegment: string
  Title: Pricing Segment

  Maximum Length: 30

  The pricing segment.
• PricingSegmentExplanation: string
  Title: Pricing Segment Explanation

  Maximum Length: 1000

  The pricing segment explanation.
• PricingStrategyExplanation: string
  Title: Pricing Strategy

  Maximum Length: 1000

  The pricing strategy explanation.
• PricingStrategyId: integer (int64)
  Title: Pricing Strategy ID

  The unique identifier of the pricing strategy.
• PricingSystem: string
  Title: Pricing system

  Maximum Length: 30

  The pricing system.
• PrimaryPartyId(required): integer (int64)
  Title: Party ID

  The unique identifier of the primary party.
• PrimaryPartyName: string
  Title: Customer

  The name of the primary party.
• PrimarySalesPerson: integer (int64)
  Title: Primary Salesperson ID

  The primary sales person.
• PrimarySalesPersonNumber: string
  Title: Primary Salesperson Number

  The primary sales person number of the subscription.
• products: array Products
  Title: Products

  The products resource is used to view, create, update, and delete the product details for a subscription, such as start and end dates, item, unit price, amount, bill-to details, ship-to details, billing frequency, invoice rule, and payment method.
• QuoteId: integer (int64)
  Title: Quote Id

  Quote Id
• QuoteToCcEmail: string
  Title: Copy To

  Maximum Length: 2000

  The quote to cc email.
• QuoteToContactId: integer (int64)
  Title: Quote-To Contact ID

  The unique identifier of the quote to contact.
• RenewalCustomerAcceptance: string
  Title: Renewal Customer Acceptance

  Maximum Length: 30

  The renewal customer acceptance.
• RenewalDuration: integer (int64)
  Title: Renewal Duration

  The subscription 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 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 level renewal duration period override that will be used while renewing through automatic or manual renewal.
• RenewalInternalApproval: string
  Title: Renewal Internal Approval

  Maximum Length: 30

  The renewal internal approval.
• RenewalPaymentMethod: string
  Title: Renewal Payment Method

  Maximum Length: 30

  The internal code for the renewal payment method used in the subscription.
• RenewalPaymentMethodName: string
  Title: Renewal Payment Method Name

  The method of payment for renewed subscription. The payment method could be a purchase order, wire, or credit card.
• RenewalPoNumber: string
  Title: Renewal PO Number

  Maximum Length: 50

  The purchase order number of the renewed subscription.
• RenewalPriceAdjustmentBasis: string
  Title: Price Adjustment Basis

  Maximum Length: 30

  The renewal price adjustment basis.
• RenewalPriceAdjustmentPercent: number
  Title: Price Adjustment Value

  The renewal price adjustment percent.
• RenewalPriceAdjustmentType: string
  Title: Price Adjustment Type

  Maximum Length: 30

  The renewal price adjustment type.
• 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.
• RenewalPricingMethodUsed: string
  Title: Renewal Pricing Method Used

  Maximum Length: 30

  The renewal pricing method used.
• RenewalProcess: string
  Title: Renewal Process

  Maximum Length: 30

  The process of renewal.
• RenewalProcessUsed: string
  Title: Renewal Process Used

  Maximum Length: 30

  The renewal process used.
• RenewalSubscriptionProfileId: integer
  The unique identifier of the renewal subscription profile.
• RenewalTemplateId: integer
  The unique identifier of the renewal template.
• RenewalType: string
  Title: Renewal Type

  The type of renewal.
• RenewalWireNumber: string
  Title: Renewal Wire Number

  Maximum Length: 30

  The wire number that identifies the electronic funds transfer used to pay for a renewed subscription.
• RenewedDate: string (date)
  The date on which the subscription was renewed.
• RenewPerpetuallyFlag: boolean
  Title: Renew forever

  Maximum Length: 1

  Indicates whether the subscription should be renewed forever.
• RepriceFlag: boolean
  Indicates whether the subscription should be repriced or not. If passed as 'true', the entire subscription will be repriced.
• 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: 255

  The revenue option for the subscription.
• salesCredits: array Sales Credits
  Title: Sales Credits

  The sales credits resource is used to view, create, update, and delete the sales credits defined for subscription or subscription products.
• SalesOrderId: integer (int64)
  Title: Sales Order ID

  The ID of the sales order associated with the subscription.
• SalesOrderNumber: string
  Title: Sales Order Number

  Maximum Length: 200

  The number of the sales order associated with the subscription.
• SegmentExplanationMessage: string
  Title: Segment

  Maximum Length: 30

  The pricing segment explanation message.
• ShipToAccountDescription: string
  The ship-to account description of the subscription.
• ShipToAccountId: integer (int64)
  Title: Ship-to Account ID

  The ship-to account ID of the subscription.
• ShipToAccountNumber: string
  Title: Ship-to Account

  The ship-to account number of the subscription.
• ShipToContactId: integer (int64)
  Title: Ship-to Contact ID

  The ship-to contract ID of the subscription.
• ShipToContactName: string
  Title: Ship-to Contact

  The ship-to contact name of the subscription.
• ShipToContactNumber: string
  Title: Ship-to Contact Number

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

  The party to which shipping is to be done.
• ShipToPartyName: string
  Title: Ship-to Party

  The party name to which the shipping is to be done.
• ShipToPartySiteId: integer (int64)
  Title: Ship-to Party Site ID

  The unique identifier of the ship to party.
• ShipToSite: string
  Title: Ship-to Site

  The site to which the shipping is to be done.
• ShipToSiteName: string
  Title: Ship-to Site

  Maximum Length: 255

  The name of the subscription ship-to site.
• ShipToSiteNumber: string
  Title: Ship-to Site Number

  The ship-to site number of the subscription.
• ShortDescription: string
  Title: Short Description

  Maximum Length: 600

  The short description of the subscription.
• SkipConsolidationFlag: boolean
  Title: Skip renewal consolidation

  Maximum Length: 1

  Skip Consolidation Flag
• smartActions: array Subscription User Actions
  Title: Subscription 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 source key.
• SourceNumber: string
  Title: External Source Number

  Maximum Length: 120

  The source system.
• SourceSystem: string
  Title: Source System

  Maximum Length: 30

  The source system.
• StartDate: string (date)
  Title: Start Date

  The date when the subscription starts.
• Status: string
  Title: Status

  Maximum Length: 30

  Default Value: DRAFT

  The status of the subscription.
• subscriptionContact: array Subscription Contacts
  Title: Subscription Contacts

  The subscription contacts resource is used to view, create, delete and, update the external party contacts.
• SubscriptionId: integer (int64)
  The unique identifier of the subscription.
• SubscriptionInvoiceText: string
  Title: Subscription Invoice Text

  Maximum Length: 4000

  The subscription invoice text.
• SubscriptionNumber(required): string
  Title: Subscription Number

  Maximum Length: 120

  The alternate identifier of the subscription.
• SubscriptionProfileId(required): integer (int64)
  Title: Subscription Profile ID

  The unique identifier of the subscription profile.
• SubscriptionProfileName: string
  Title: Subscription Profile

  Maximum Length: 300

  The name of the subscription profile name.
• subscriptionTeam: array Subscription Teams
  Title: Subscription Teams

  The subscription team is used to view the internal and external contacts of the subscription.
• supportingDocumentAttachments: array Supporting Document Attachments
  Title: Supporting Document Attachments

  The supporting document attachments resource is used to view, create, and update supporting document attachments.
• SystemAction: string
  Title: Action

  Maximum Length: 30

  The subscription action that is performed by the user.
• SystemActionDate: string (date-time)
  Title: Process Submitted

  The date and time at which the subscription process is submitted.
• SystemActionObject: string
  Title: Object

  Maximum Length: 30

  The subscription object on which the action is performed.
• SystemActionObjectKey: string
  Title: Object ID

  Maximum Length: 300

  The identifier of the subscription object on which the action is performed.
• SystemActionRequestId: integer (int64)
  Title: Process ID

  The identifier of the subscription process that is being executed.
• SystemActionStatus: string
  Title: Process Status

  Maximum Length: 30

  The status of the subscription process that is submitted.
• TaxClassificationCode: string
  Title: Classification Code

  Maximum Length: 50

  The tax classification code.
• TaxClassificationMeaning: string
  Title: Classification Code

  The tax classification meaning.
• TaxExemptionHandling: string
  Title: Exemption Control

  Maximum Length: 30

  The tax exemption handling code.
• TaxExemptionHandlingName: string
  Title: Exemption Control Name

  The tax exemption handling name.
• TotalContractValue: number
  Title: Total Contract Value

  The total contract value.
• TransactionType: string
  The transaction type.
• TransactionTypeName(required): string
  Title: Transaction Type

  Maximum Length: 80

  The accounts receivables transaction type name.
• UpdateFlag: boolean
  Indicates whether the subscription is updated.
• UsageCapture: string
  Title: Usage Capture Mode

  Maximum Length: 30

  The usage capture mode.
• UsageEventAllowanceInvTemplate: string
  Title: Allowance

  Maximum Length: 200

  The template used for the usage events allowance rating model.
• UsageEventCommitmentInvTemplate: string
  Title: Commitment

  Maximum Length: 200

  The template used for the regular usage events commitment rating model.
• UsageEventEstimateInvTemplate: string
  Title: Estimate

  Maximum Length: 200

  The template used for the usage events estimate rating model.
• UsageEventRegularInvTemplate: string
  Title: Basic

  Maximum Length: 200

  The template used for the regular usage events rating model.
• UsageInvoiceLayoutTemplate: string
  Title: BIP Template

  Maximum Length: 200

  The layout template of the usage invoice.
• UserStatus: string
  Title: User Status

  Maximum Length: 30

  The user status of the subscription.
• UserStatusName: string
  The translated user status of the subscription.
• ValidateFlag: boolean
  Title: Validate subscription during import

  Validate Flag
• validateSubscription: array Validate Subscriptions
  Title: Validate Subscriptions

  The validate subscriptions resource to view, create, update, and delete the validation errors for a subscription.
• ValidationStatus: string
  Title: Validation Status

  Maximum Length: 1

  The validation status of the subscription.
• WarehouseId: integer (int64)
  Title: Warehouse

  The warehouse ID associated with the subscription.
• WareHouseName: string
  Title: Warehouse

  The name of the warehouse associated with the subscription.
• WarrantyYN: string
  Title: Warranty Subscription

  Maximum Length: 1

  Indicates whether this subscription is a warranty or not.
• WireNumber: string
  Title: Wire Number

  Maximum Length: 30

  The wire number.

{
    "required":[
        "AccountingRuleId",
        "BillToAccountId",
        "BillToSiteUseId",
        "BusinessUnitId",
        "Currency",
        "DefinitionOrganizationId",
        "LegalEntityId",
        "PartialPeriodStart",
        "PartialPeriodType",
        "PrimaryPartyId",
        "SubscriptionNumber",
        "SubscriptionProfileId",
        "TransactionTypeName"
    ],
    "type":"object",
    "properties":{
        "CalculatedCreditAmount":{
            "title":"Calculated Credit Amount",
            "type":"number",
            "description":"The calculated credit amount of the subscription.",
            "nullable":true
        },
        "PreviewBipReportCode":{
            "title":"BIP Data Source",
            "maxLength":20,
            "type":"string",
            "description":"The code of the BIP report template used for the subscription preview.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CancelDescription":{
            "title":"Cancellation Description",
            "maxLength":2000,
            "type":"string",
            "description":"The cancel reason description of the subscription.",
            "nullable":true
        },
        "CurcyConvRateType":{
            "title":"Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type.",
            "nullable":true,
            "x-queryable":false
        },
        "UserStatus":{
            "title":"User Status",
            "maxLength":30,
            "type":"string",
            "description":"The user status of the subscription.",
            "nullable":true,
            "x-queryable":false
        },
        "ShortDescription":{
            "title":"Short Description",
            "maxLength":600,
            "type":"string",
            "description":"The short description of the subscription.",
            "nullable":true,
            "x-queryable":false
        },
        "SystemActionDate":{
            "title":"Process Submitted",
            "type":"string",
            "description":"The date and time at which the subscription process is submitted.",
            "format":"date-time",
            "nullable":true
        },
        "SourceKey":{
            "title":"Source Key",
            "maxLength":120,
            "type":"string",
            "description":"The source key.",
            "nullable":true,
            "x-queryable":false
        },
        "Currency":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The subscription currency.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the subscription.",
            "nullable":false,
            "default":"DRAFT",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CreditedAmount":{
            "title":"Credited Amount",
            "type":"number",
            "description":"The credited amount.",
            "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,
                "dependencies":[
                    "SubscriptionProfileId"
                ]
            }
        },
        "PaymentTermsName":{
            "title":"Payment Terms",
            "type":"string",
            "description":"The name of the payment terms.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "SubscriptionProfileId"
                ]
            }
        },
        "PrimaryPartyName":{
            "title":"Customer",
            "type":"string",
            "description":"The name of the primary party.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "PrimaryPartyName1"
                ]
            }
        },
        "RenewalPaymentMethod":{
            "title":"Renewal Payment Method",
            "maxLength":30,
            "type":"string",
            "description":"The internal code for the renewal payment method used in the subscription.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the subscription is marked for deletion.",
            "nullable":true,
            "x-queryable":false
        },
        "RenewPerpetuallyFlag":{
            "title":"Renew forever",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the subscription should be renewed forever.",
            "nullable":true
        },
        "CurrencyConversionRateType":{
            "title":"Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OrderLineOperationCode":{
            "title":"Action Code",
            "maxLength":80,
            "type":"string",
            "description":"Order Line Operation Code",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CanceledAmount":{
            "title":"Canceled Amount",
            "type":"number",
            "description":"The canceled amount.",
            "nullable":true,
            "x-queryable":false
        },
        "QuoteId":{
            "title":"Quote Id",
            "type":"integer",
            "description":"Quote Id",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SystemAction":{
            "title":"Action",
            "maxLength":30,
            "type":"string",
            "description":"The subscription action that is performed by the user.",
            "nullable":true
        },
        "EnableRenewalRemindersFlag":{
            "title":"Enable renewal reminders",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the renewal reminders is enabled.",
            "nullable":true,
            "x-queryable":false
        },
        "RenewalSubscriptionProfileId":{
            "type":"integer",
            "description":"The unique identifier of the renewal subscription profile.",
            "nullable":true,
            "x-queryable":false
        },
        "SystemActionObjectKey":{
            "title":"Object ID",
            "maxLength":300,
            "type":"string",
            "description":"The identifier of the subscription object on which the action is performed.",
            "nullable":true
        },
        "WarrantyYN":{
            "title":"Warranty Subscription",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether this subscription is a warranty or not.",
            "nullable":true
        },
        "DefaultRevenueAction":{
            "maxLength":255,
            "type":"string",
            "description":"The default revenue action to be taken for the subscription.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UsageEventCommitmentInvTemplate":{
            "title":"Commitment",
            "maxLength":200,
            "type":"string",
            "description":"The template used for the regular usage events commitment rating model.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "InvoiceBipReportCode"
                ]
            }
        },
        "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"
            }
        },
        "subscriptionTeam":{
            "title":"Subscription Teams",
            "type":"array",
            "description":"The subscription team is used to view the internal and external contacts of the subscription.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-subscriptionTeam-item-post-request"
            }
        },
        "supportingDocumentAttachments":{
            "title":"Supporting Document Attachments",
            "type":"array",
            "description":"The supporting document attachments resource is used to view, create, and update supporting document attachments.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-supportingDocumentAttachments-item-post-request"
            }
        },
        "CurrencyConversionRateDate":{
            "title":"Conversion Rate Date",
            "type":"string",
            "description":"The currency conversion rate date.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "TaxClassificationMeaning":{
            "title":"Classification Code",
            "type":"string",
            "description":"The tax classification meaning.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ShipToSiteName":{
            "title":"Ship-to Site",
            "maxLength":255,
            "type":"string",
            "description":"The name of the subscription ship-to site.",
            "nullable":true
        },
        "BillingDateCode":{
            "title":"Billing Date",
            "maxLength":30,
            "type":"string",
            "description":"The code of the billing date.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SubscriptionProfileId"
                ]
            }
        },
        "contractAttachment":{
            "title":"Contract Attachments",
            "type":"array",
            "description":"The contract attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-contractAttachment-item-post-request"
            }
        },
        "NegotiationLanguage":{
            "title":"Language",
            "maxLength":4,
            "type":"string",
            "description":"The negotiation language.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PricingStrategyExplanation":{
            "title":"Pricing Strategy",
            "maxLength":1000,
            "type":"string",
            "description":"The pricing strategy explanation.",
            "nullable":true,
            "x-queryable":false
        },
        "WarehouseId":{
            "title":"Warehouse",
            "type":"integer",
            "description":"The warehouse ID associated with the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the subscription ends.",
            "format":"date",
            "nullable":true
        },
        "ShipToSiteNumber":{
            "title":"Ship-to Site Number",
            "type":"string",
            "description":"The ship-to site number of the subscription.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ClosedAmount":{
            "title":"Closed Amount",
            "type":"number",
            "description":"The closed amount.",
            "nullable":true,
            "x-queryable":false
        },
        "OverrideCreditAmount":{
            "title":"Override Credit Amount",
            "type":"number",
            "description":"The override credit amount of the subscription.",
            "nullable":true
        },
        "ValidationStatus":{
            "title":"Validation Status",
            "maxLength":1,
            "type":"string",
            "description":"The validation status of the subscription.",
            "nullable":true
        },
        "DefinitionOrganizationCode":{
            "title":"Item Master Organization Code",
            "type":"string",
            "description":"The inventory organization code of the subscription.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "GenerateBillingSchedule":{
            "type":"string",
            "description":"The generate billing schedule.",
            "nullable":true,
            "x-queryable":false
        },
        "CloseDescription":{
            "title":"Close Description",
            "maxLength":2000,
            "type":"string",
            "description":"The close reason description of the subscription.",
            "nullable":true
        },
        "RenewalProcessUsed":{
            "title":"Renewal Process Used",
            "maxLength":30,
            "type":"string",
            "description":"The renewal process used.",
            "nullable":true,
            "x-queryable":false
        },
        "BillingOffsetDays":{
            "title":"Offset",
            "type":"integer",
            "description":"The days of offset billing.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "SubscriptionProfileId"
                ]
            }
        },
        "TaxExemptionHandlingName":{
            "title":"Exemption Control Name",
            "type":"string",
            "description":"The tax exemption handling name.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BillingDateName":{
            "title":"Billing Date Name",
            "type":"string",
            "description":"The name of the billing date.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BillToAccountNumber":{
            "title":"Billing Account",
            "maxLength":30,
            "type":"string",
            "description":"The alternate identifier of the bill-to account.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ContactRelationshipId":{
            "type":"integer",
            "description":"Contact Relationship Id",
            "nullable":true,
            "x-queryable":false
        },
        "TaxExemptionHandling":{
            "title":"Exemption Control",
            "maxLength":30,
            "type":"string",
            "description":"The tax exemption handling code.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "smartActions":{
            "title":"Subscription User Actions",
            "type":"array",
            "description":"The smart actions resource stores the endpoint and security details for every user action.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-smartActions-item-post-request"
            }
        },
        "SubscriptionProfileId":{
            "title":"Subscription Profile ID",
            "type":"integer",
            "description":"The unique identifier of the subscription profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ShipToSite":{
            "title":"Ship-to Site",
            "type":"string",
            "description":"The site to which the shipping is to be done.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "AssigneeId":{
            "title":"Assignee ID",
            "type":"integer",
            "description":"The unique identifier of the assignee.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CoverageInvoiceText":{
            "title":"Coverage Invoice Text",
            "maxLength":4000,
            "type":"string",
            "description":"The charge invoice text.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "SubscriptionProfileId"
                ]
            }
        },
        "UsageCapture":{
            "title":"Usage Capture Mode",
            "maxLength":30,
            "type":"string",
            "description":"The usage capture mode.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "SubscriptionProfileId"
                ]
            }
        },
        "RenewalCustomerAcceptance":{
            "title":"Renewal Customer Acceptance",
            "maxLength":30,
            "type":"string",
            "description":"The renewal customer acceptance.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ShipToAccountNumber":{
            "title":"Ship-to Account",
            "type":"string",
            "description":"The ship-to account number of the subscription.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "sortable":false,
                "dependencies":[
                    "ShipToAccountNumber1"
                ]
            }
        },
        "LayoutTemplate":{
            "title":"Contract Layout Template",
            "maxLength":200,
            "type":"string",
            "description":"The layout template.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "PreviewBipReportCode"
                ]
            }
        },
        "ShipToContactId":{
            "title":"Ship-to Contact ID",
            "type":"integer",
            "description":"The ship-to contract ID of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ApprovedDate":{
            "title":"Approved Date",
            "type":"string",
            "description":"The date on which the subscription was approved.",
            "format":"date",
            "nullable":true
        },
        "BusinessUnitId":{
            "title":"BU ID",
            "type":"integer",
            "description":"The unique identifier of the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SystemActionObject":{
            "title":"Object",
            "maxLength":30,
            "type":"string",
            "description":"The subscription object on which the action is performed.",
            "nullable":true
        },
        "Duration":{
            "title":"Duration",
            "type":"integer",
            "description":"The duration of the subscription.",
            "nullable":true,
            "x-queryable":false
        },
        "DaysBeforeExpiryUsed":{
            "title":"Used Days Before Expiry",
            "maxLength":18,
            "type":"string",
            "description":"The days before expiry used.",
            "nullable":true,
            "x-queryable":false
        },
        "RenewalType":{
            "title":"Renewal Type",
            "type":"string",
            "description":"The type of renewal.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TaxClassificationCode":{
            "title":"Classification Code",
            "maxLength":50,
            "type":"string",
            "description":"The tax classification code.",
            "nullable":true,
            "x-queryable":false
        },
        "parties":{
            "title":"Parties",
            "type":"array",
            "description":"The parties resource to view, create, update, and delete the subscription parties.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-parties-item-post-request"
            }
        },
        "RenewalPoNumber":{
            "title":"Renewal PO Number",
            "maxLength":50,
            "type":"string",
            "description":"The purchase order number of the renewed subscription.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "RenewalPaymentMethod"
                ]
            }
        },
        "TransactionType":{
            "type":"string",
            "description":"The transaction type.",
            "nullable":true,
            "x-queryable":false
        },
        "QuoteToContactId":{
            "title":"Quote-To Contact ID",
            "type":"integer",
            "description":"The unique identifier of the quote to contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ShipToContactPartyId":{
            "type":"integer",
            "description":"The ship-to contact party ID of the subscription.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "ShipToContactPartyId1"
                ]
            }
        },
        "PrimaryPartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the primary party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ShipToContactNumber":{
            "title":"Ship-to Contact Number",
            "type":"string",
            "description":"The ship-to contact number of the subscription.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "ShipToContactNumber1"
                ]
            }
        },
        "SystemActionStatus":{
            "title":"Process Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the subscription process that is submitted.",
            "nullable":true
        },
        "ShipToAccountId":{
            "title":"Ship-to Account ID",
            "type":"integer",
            "description":"The ship-to account ID of the subscription.",
            "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",
                "dependencies":[
                    "SubscriptionProfileId"
                ]
            }
        },
        "QuoteToCcEmail":{
            "title":"Copy To",
            "maxLength":2000,
            "type":"string",
            "description":"The quote to cc email.",
            "nullable":true,
            "x-queryable":false
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the subscription is updated.",
            "nullable":true,
            "x-queryable":false
        },
        "RenewalProcess":{
            "title":"Renewal Process",
            "maxLength":30,
            "type":"string",
            "description":"The process of renewal.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SalesOrderId":{
            "title":"Sales Order ID",
            "type":"integer",
            "description":"The ID of the sales order associated with the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "DefinitionOrganizationName":{
            "title":"Item Master Organization",
            "type":"string",
            "description":"The master organization name.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "PricedOnDate":{
            "title":"Priced on Date",
            "type":"string",
            "description":"The date on which the subscription was priced.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "CreditType":{
            "title":"Credit Type",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of credit issued to the customer such as negative invoice or credit memo.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BillService":{
            "title":"Bill Service",
            "maxLength":30,
            "type":"string",
            "description":"The bill service code. Values could be ORA_DO_NOT_BILL, ORA_BILL or ORA_BILL_ON_RENEWAL.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SubscriptionProfileId"
                ]
            }
        },
        "RepriceFlag":{
            "type":"boolean",
            "description":"Indicates whether the subscription should be repriced or not. If passed as 'true', the entire subscription will be repriced.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionNumber":{
            "title":"Subscription Number",
            "maxLength":120,
            "type":"string",
            "description":"The alternate identifier of the subscription.",
            "nullable":false
        },
        "ExemptCertificateNumber":{
            "title":"Tax Exemption Certificate Number",
            "maxLength":80,
            "type":"string",
            "description":"The tax exempt certificate number.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "BillToContactId":{
            "title":"Bill-to Contact ID",
            "type":"integer",
            "description":"The bill-to contact of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RenewalWireNumber":{
            "title":"Renewal Wire Number",
            "maxLength":30,
            "type":"string",
            "description":"The wire number that identifies the electronic funds transfer used to pay for a renewed subscription.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "RenewalPaymentMethod"
                ]
            }
        },
        "RenewalPricingMethodUsed":{
            "title":"Renewal Pricing Method Used",
            "maxLength":30,
            "type":"string",
            "description":"The renewal pricing method used.",
            "nullable":true,
            "x-queryable":false
        },
        "BatchTag":{
            "title":"Batch Tag",
            "maxLength":30,
            "type":"string",
            "description":"Batch Tag",
            "nullable":true
        },
        "PONumber":{
            "title":"PO Number",
            "maxLength":50,
            "type":"string",
            "description":"The PO number.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PaymentMethod"
                ]
            }
        },
        "SubscriptionProfileName":{
            "title":"Subscription Profile",
            "maxLength":300,
            "type":"string",
            "description":"The name of the subscription profile name.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PrimarySalesPerson":{
            "title":"Primary Salesperson ID",
            "type":"integer",
            "description":"The primary sales person.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RenewalPriceListId":{
            "type":"integer",
            "description":"The identifier of the renewal price list.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CustomerContactName":{
            "title":"Contact Name",
            "type":"string",
            "description":"Customer Contact Name",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "PartialPeriodType":{
            "title":"Period Type",
            "maxLength":30,
            "type":"string",
            "description":"The partial period type. Values could be actual or fixed.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SubscriptionProfileId"
                ]
            }
        },
        "BillServiceName":{
            "title":"Bill Service Name",
            "type":"string",
            "description":"The bill service option. Values could be no bill, bill or bill on renewal.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SubscriptionProfileId"
                ]
            }
        },
        "DocumentFiscalClassification":{
            "title":"Document Fiscal Classification",
            "maxLength":30,
            "type":"string",
            "description":"The document fiscal classification.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "NotificationTemplateId":{
            "type":"integer",
            "description":"The unique identifier of the notification template.",
            "nullable":true,
            "x-queryable":false
        },
        "CloseReason":{
            "title":"Close Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason to close the subscription.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SkipConsolidationFlag":{
            "title":"Skip renewal consolidation",
            "maxLength":1,
            "type":"boolean",
            "description":"Skip Consolidation Flag",
            "nullable":true
        },
        "InvoiceBipReportCode":{
            "title":"BIP Data Source",
            "maxLength":30,
            "type":"string",
            "description":"The code of the BIP report template used for the invoice attachments.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LegalEntityName":{
            "title":"Subscription Legal Entity",
            "type":"string",
            "description":"The name of the legal entity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "BillToPartyId":{
            "title":"Bill-to Party ID",
            "type":"integer",
            "description":"The bill-to customer ID of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SourceNumber":{
            "title":"External Source Number",
            "maxLength":120,
            "type":"string",
            "description":"The source system.",
            "nullable":true,
            "x-queryable":false
        },
        "CanceledDate":{
            "title":"Canceled Date",
            "type":"string",
            "description":"The date on which the subscription was canceled.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "WareHouseName":{
            "title":"Warehouse",
            "type":"string",
            "description":"The name of the warehouse associated with the subscription.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "sortable":false
            }
        },
        "PrimarySalesPersonNumber":{
            "title":"Primary Salesperson Number",
            "type":"string",
            "description":"The primary sales person number of the subscription.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SubscriptionInvoiceText":{
            "title":"Subscription Invoice Text",
            "maxLength":4000,
            "type":"string",
            "description":"The subscription invoice text.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "SubscriptionProfileId"
                ]
            }
        },
        "BillingFrequency":{
            "title":"Billing Frequency",
            "maxLength":30,
            "type":"string",
            "description":"The billing frequency code.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "SubscriptionProfileId"
                ]
            }
        },
        "RenewalPaymentMethodName":{
            "title":"Renewal Payment Method Name",
            "type":"string",
            "description":"The method of payment for renewed subscription. 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 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"
            }
        },
        "EstimatedTax":{
            "title":"Estimated Tax",
            "type":"number",
            "description":"The estimated tax.",
            "nullable":true,
            "x-queryable":false
        },
        "PriceAdjustmentPercentUsed":{
            "title":"Used Price Adjustment Percentage",
            "type":"number",
            "description":"The price adjustment percent used.",
            "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.",
            "nullable":true
        },
        "BillToPartyName":{
            "title":"Bill-to Customer",
            "maxLength":360,
            "type":"string",
            "description":"The bill-to customer name of the subscription.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "sortable":false
            }
        },
        "SystemActionRequestId":{
            "title":"Process ID",
            "type":"integer",
            "description":"The identifier of the subscription process that is being executed.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ShipToParty":{
            "title":"Ship-to Party ID",
            "type":"integer",
            "description":"The party to which shipping is to be done.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "InvoicedAmount":{
            "title":"Invoiced Amount",
            "type":"number",
            "description":"The invoiced amount.",
            "nullable":true,
            "x-queryable":false
        },
        "RenewalDuration":{
            "title":"Renewal Duration",
            "type":"integer",
            "description":"The subscription 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":{
            "title":"Pricing system",
            "maxLength":30,
            "type":"string",
            "description":"The pricing system.",
            "nullable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":1995,
            "type":"string",
            "description":"The description of the subscription.",
            "nullable":true,
            "x-queryable":false
        },
        "InvoicingRuleName":{
            "title":"Invoicing Rule",
            "type":"string",
            "description":"The name of the invoice rule.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "SubscriptionProfileId"
                ]
            }
        },
        "CustomerTrxTypeSequenceId":{
            "title":"Sequence",
            "type":"integer",
            "description":"The unique identifier of the customer transaction type sequence.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "SubscriptionProfileId"
                ]
            }
        },
        "PaymentMethodName":{
            "title":"Payment Method Name",
            "type":"string",
            "description":"The name of the payment method.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "products":{
            "title":"Products",
            "type":"array",
            "description":"The products resource is used to view, create, update, and delete the product details for a subscription, such as start and end dates, item, unit price, amount, bill-to details, ship-to details, billing frequency, invoice rule, and payment method.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-item-post-request"
            }
        },
        "RenewalTemplateId":{
            "type":"integer",
            "description":"The unique identifier of the renewal template.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "LegalEntityId":{
            "title":"Legal Entity ID",
            "type":"integer",
            "description":"Th unique identifier of the legal entity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RevenueOption":{
            "title":"Revenue Accounting Option",
            "maxLength":255,
            "type":"string",
            "description":"The revenue option for the subscription.",
            "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/subscriptions-flexFields-item-post-request"
            },
            "x-cardinality":"1"
        },
        "PricingSegment":{
            "title":"Pricing Segment",
            "maxLength":30,
            "type":"string",
            "description":"The pricing segment.",
            "nullable":true,
            "x-queryable":false
        },
        "CurrencyConversionRate":{
            "title":"Conversion Rate",
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipToContactName":{
            "title":"Ship-to Contact",
            "type":"string",
            "description":"The ship-to contact name of the subscription.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "sortable":false,
                "dependencies":[
                    "ShipToContactName1"
                ]
            }
        },
        "TotalContractValue":{
            "title":"Total Contract Value",
            "type":"number",
            "description":"The total contract value.",
            "nullable":true
        },
        "FreezePriceFlag":{
            "title":"Freeze Price",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the price is being frozen.",
            "nullable":true,
            "default":false
        },
        "PartialPeriodStart":{
            "title":"Period Start",
            "maxLength":30,
            "type":"string",
            "description":"The partial period start. Values could be calendar or service.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SubscriptionProfileId"
                ]
            }
        },
        "CloseCreditMethod":{
            "title":"Close Credit Method",
            "maxLength":30,
            "type":"string",
            "description":"The close credit method.",
            "nullable":true,
            "x-queryable":false
        },
        "ExemptReasonMeaning":{
            "title":"Exemption Reason",
            "type":"string",
            "description":"The tax exempt reason meaning.",
            "nullable":true,
            "x-queryable":false
        },
        "CommunicationChannel":{
            "title":"Communication Channel",
            "maxLength":30,
            "type":"string",
            "description":"The communication channel.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BillToSiteNumber":{
            "title":"Bill-to Site Number",
            "type":"string",
            "description":"The bill-to site number of the subscription.",
            "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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CalculateEstimatedTaxFlag":{
            "type":"boolean",
            "description":"Indicates whether estimated tax will be calculated for the subscription.",
            "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,
                "dependencies":[
                    "SubscriptionProfileId"
                ]
            }
        },
        "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 template used for the regular usage events rating model.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "InvoiceBipReportCode"
                ]
            }
        },
        "ClosedDate":{
            "title":"Closed Date",
            "type":"string",
            "description":"The date on which the subscription was closed.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "BillingSystem":{
            "title":"Billing System",
            "maxLength":120,
            "type":"string",
            "description":"The billing system.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "SubscriptionProfileId"
                ]
            }
        },
        "SourceSystem":{
            "title":"Source System",
            "maxLength":30,
            "type":"string",
            "description":"The source system.",
            "nullable":true,
            "x-queryable":false
        },
        "AttachmentEntityName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the attachment entity.",
            "nullable":true,
            "default":"OSS_DOC_SUBSCRIPTION_AGREEMENT",
            "x-queryable":false
        },
        "TransactionTypeName":{
            "title":"Transaction Type",
            "maxLength":80,
            "type":"string",
            "description":"The accounts receivables transaction type name.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "SubscriptionProfileId"
                ]
            }
        },
        "AttachmentEntityName1":{
            "type":"string",
            "description":"The name of the attachment entity.",
            "nullable":true,
            "default":"OSS_DOC_SUPPORTING_DOCUMENTS",
            "x-queryable":false
        },
        "BillToAccountDescription":{
            "type":"string",
            "description":"The description of the bill-to account.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "BillToAccountDescription1"
                ]
            }
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the subscription starts.",
            "format":"date",
            "nullable":false
        },
        "BillToAddress":{
            "title":"Bill-to Address",
            "type":"string",
            "description":"The address to which the bill is to be sent.",
            "nullable":true,
            "x-queryable":false
        },
        "ExemptReason":{
            "title":"Exemption Reason Code",
            "maxLength":30,
            "type":"string",
            "description":"The tax exempt reason code.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipToAccountDescription":{
            "type":"string",
            "description":"The ship-to account description of the subscription.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "ShipToAccountDescription1"
                ]
            }
        },
        "RenewalPriceAdjustmentBasis":{
            "title":"Price Adjustment Basis",
            "maxLength":30,
            "type":"string",
            "description":"The renewal price adjustment basis.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RenewalInternalApproval":{
            "title":"Renewal Internal Approval",
            "maxLength":30,
            "type":"string",
            "description":"The renewal internal approval.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DaysBeforeExpiry":{
            "title":"Days Before Expiration",
            "type":"integer",
            "description":"The number of days before expiry.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "validateSubscription":{
            "title":"Validate Subscriptions",
            "type":"array",
            "description":"The validate subscriptions resource to view, create, update, and delete the validation errors for a subscription.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-validateSubscription-item-post-request"
            }
        },
        "CorpCurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code.",
            "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
        },
        "BillToSiteName":{
            "title":"Bill-to Site",
            "maxLength":255,
            "type":"string",
            "description":"The name of the subscription bill-to site.",
            "nullable":true
        },
        "UsageEventEstimateInvTemplate":{
            "title":"Estimate",
            "maxLength":200,
            "type":"string",
            "description":"The template used for the usage events estimate rating model.",
            "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 of the subscription.",
            "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"
            }
        },
        "SegmentExplanationMessage":{
            "title":"Segment",
            "maxLength":30,
            "type":"string",
            "description":"The pricing segment explanation message.",
            "nullable":true,
            "x-queryable":false
        },
        "BillOnDay":{
            "title":"Bill on Day",
            "type":"number",
            "description":"The day of the bill.",
            "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"
                ]
            }
        },
        "CustomerAcceptance":{
            "title":"Customer Acceptance",
            "maxLength":30,
            "type":"string",
            "description":"The customer acceptance.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CancelReason":{
            "title":"Cancellation Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason of cancelling the subscription.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "creditCards":{
            "title":"Credit Cards",
            "type":"array",
            "description":"The credit cards resource is used to view, create, and update the credit card information associated with a subscription.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-creditCards-item-post-request"
            }
        },
        "AssigneeType":{
            "title":"Assignee Type",
            "maxLength":30,
            "type":"string",
            "description":"The assignee type.",
            "nullable":true,
            "x-queryable":false
        },
        "subscriptionContact":{
            "title":"Subscription Contacts",
            "type":"array",
            "description":"The subscription contacts resource is used to view, create, delete and, update the external party contacts.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-subscriptionContact-item-post-request"
            }
        },
        "BillToContactNumber":{
            "title":"Bill-to Contact Number",
            "type":"string",
            "description":"The bill-to contact number of the subscription.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "BillToContactNumber1"
                ]
            }
        },
        "PaymentMethod":{
            "title":"Payment Method",
            "maxLength":30,
            "type":"string",
            "description":"The method of payment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DefinitionOrganizationId":{
            "title":"Subscription Inventory Organization",
            "type":"integer",
            "description":"The unique identifier of the master organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RenewalDurationPeriod":{
            "title":"Renewal Period",
            "maxLength":30,
            "type":"string",
            "description":"The code of the subscription level renewal duration period override that will be used while renewing through automatic or manual renewal.",
            "nullable":true
        },
        "RenewalPriceAdjustmentType":{
            "title":"Price Adjustment Type",
            "maxLength":30,
            "type":"string",
            "description":"The renewal price adjustment type.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PricingSegmentExplanation":{
            "title":"Pricing Segment Explanation",
            "maxLength":1000,
            "type":"string",
            "description":"The pricing segment explanation.",
            "nullable":true,
            "x-queryable":false
        },
        "RenewalPriceAdjustmentPercent":{
            "title":"Price Adjustment Value",
            "type":"number",
            "description":"The renewal price adjustment percent.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipToPartyName":{
            "title":"Ship-to Party",
            "type":"string",
            "description":"The party name to which the shipping is to be done.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "ShipToPartyName1"
                ]
            }
        },
        "BillToSite":{
            "title":"Bill-to Site",
            "type":"string",
            "description":"Bill To Site",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ApprovalNote":{
            "title":"Approval Note",
            "maxLength":240,
            "type":"string",
            "description":"The approval note.",
            "nullable":true,
            "x-queryable":false
        },
        "BusinessUnitName":{
            "title":"BU Name",
            "type":"string",
            "description":"The name of the business unit.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "LineAutonumberEnabledYn":{
            "title":"Automate subscription line numbering",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the line auto number is enabled.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "SubscriptionProfileId"
                ]
            }
        },
        "PricingStrategyId":{
            "title":"Pricing Strategy ID",
            "type":"integer",
            "description":"The unique identifier of the pricing strategy.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "UsageEventAllowanceInvTemplate":{
            "title":"Allowance",
            "maxLength":200,
            "type":"string",
            "description":"The template used for the usage events allowance rating model.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "InvoiceBipReportCode"
                ]
            }
        },
        "InvoicingRuleId":{
            "title":"Invoicing Rule Id",
            "type":"integer",
            "description":"The unique identifier of the invoice rule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "SubscriptionProfileId"
                ]
            }
        },
        "RenewedDate":{
            "type":"string",
            "description":"The date on which the subscription was renewed.",
            "format":"date",
            "nullable":true
        },
        "InternalApproval":{
            "title":"Internal Approval",
            "maxLength":30,
            "type":"string",
            "description":"The internal approval.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DefaultLanguage":{
            "type":"string",
            "description":"The default language.",
            "nullable":true,
            "x-queryable":false
        },
        "BillingFrequencyName":{
            "title":"Billing Frequency",
            "type":"string",
            "description":"The billing frequency name.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UserStatusName":{
            "type":"string",
            "description":"The translated user status of the subscription.",
            "nullable":true,
            "x-queryable":false
        },
        "CurrencyName":{
            "title":"Currency",
            "type":"string",
            "description":"The name of subscription currency.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "salesCredits":{
            "title":"Sales Credits",
            "type":"array",
            "description":"The sales credits resource is used to view, create, update, and delete the sales credits defined for subscription or subscription products.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-salesCredits-item-post-request"
            }
        },
        "BillToContactName":{
            "title":"Bill-to Contact",
            "type":"string",
            "description":"The bill-to contact name of the subscription.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "sortable":false,
                "dependencies":[
                    "BillToContactName1"
                ]
            }
        },
        "ValidateFlag":{
            "title":"Validate subscription during import",
            "type":"boolean",
            "description":"Validate Flag",
            "nullable":true,
            "x-queryable":false
        },
        "EnableAdvBipTemplateFlag":{
            "title":"Enable advanced configuration",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether advanced BIP configuration for usage invoice templates is enabled or not.",
            "nullable":true,
            "default":false
        },
        "PricingError":{
            "maxLength":2000,
            "type":"string",
            "description":"The error related to pricing.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Contract Attachments

Type: array

Title: Contract Attachments

The contract attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object schema

{
    "title":"Contract Attachments",
    "type":"array",
    "description":"The contract attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-contractAttachment-item-post-request"
    }
}

Nested Schema : Credit Cards

Type: array

Title: Credit Cards

The credit cards resource is used to view, create, and update the credit card information associated with a subscription.

Show Source

• Array of: object subscriptions-creditCards-item-post-request

{
    "title":"Credit Cards",
    "type":"array",
    "description":"The credit cards resource is used to view, create, and update the credit card information associated with a subscription.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-creditCards-item-post-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 schema

{
    "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/subscriptions-flexFields-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : Parties

Type: array

Title: Parties

The parties resource to view, create, update, and delete the subscription parties.

Show Source

• Array of: object subscriptions-parties-item-post-request

{
    "title":"Parties",
    "type":"array",
    "description":"The parties resource to view, create, update, and delete the subscription parties.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-parties-item-post-request"
    }
}

Nested Schema : Products

Type: array

Title: Products

The products resource is used to view, create, update, and delete the product details for a subscription, such as start and end dates, item, unit price, amount, bill-to details, ship-to details, billing frequency, invoice rule, and payment method.

Show Source

• Array of: object schema

{
    "title":"Products",
    "type":"array",
    "description":"The products resource is used to view, create, update, and delete the product details for a subscription, such as start and end dates, item, unit price, amount, bill-to details, ship-to details, billing frequency, invoice rule, and payment method.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-item-post-request"
    }
}

Nested Schema : Sales Credits

Type: array

Title: Sales Credits

The sales credits resource is used to view, create, update, and delete the sales credits defined for subscription or subscription products.

Show Source

• Array of: object subscriptions-salesCredits-item-post-request

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

Nested Schema : Subscription User Actions

Type: array

Title: Subscription User Actions

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

Show Source

• Array of: object subscriptions-smartActions-item-post-request

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

Nested Schema : Subscription Contacts

Type: array

Title: Subscription Contacts

The subscription contacts resource is used to view, create, delete and, update the external party contacts.

Show Source

• Array of: object subscriptions-subscriptionContact-item-post-request

{
    "title":"Subscription Contacts",
    "type":"array",
    "description":"The subscription contacts resource is used to view, create, delete and, update the external party contacts.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-subscriptionContact-item-post-request"
    }
}

Nested Schema : Subscription Teams

Type: array

Title: Subscription Teams

The subscription team is used to view the internal and external contacts of the subscription.

Show Source

• Array of: object subscriptions-subscriptionTeam-item-post-request

{
    "title":"Subscription Teams",
    "type":"array",
    "description":"The subscription team is used to view the internal and external contacts of the subscription.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-subscriptionTeam-item-post-request"
    }
}

Nested Schema : Supporting Document Attachments

Type: array

Title: Supporting Document Attachments

The supporting document attachments resource is used to view, create, and update supporting document attachments.

Show Source

• Array of: object schema

{
    "title":"Supporting Document Attachments",
    "type":"array",
    "description":"The supporting document attachments resource is used to view, create, and update supporting document attachments.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-supportingDocumentAttachments-item-post-request"
    }
}

Nested Schema : Validate Subscriptions

Type: array

Title: Validate Subscriptions

The validate subscriptions resource to view, create, update, and delete the validation errors for a subscription.

Show Source

• Array of: object schema

{
    "title":"Validate Subscriptions",
    "type":"array",
    "description":"The validate subscriptions resource to view, create, update, and delete the validation errors for a subscription.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-validateSubscription-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : subscriptions-creditCards-item-post-request

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.
• CreditCardId: integer (int64)
  The unique identifier of the credit card.
• CreditCardPuid: string
  Maximum Length: 120

  The credit card PUID.
• 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 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 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 credit card PUID.",
            "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 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
        },
        "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"
            }
        },
        "Notes":{
            "title":"Notes",
            "maxLength":300,
            "type":"string",
            "description":"The notes associated with the credit card.",
            "nullable":true
        }
    }
}

Nested Schema : schema

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.
• SubscriptionId: integer (int64)
  The subscription header flexfield ID.

{
    "type":"object",
    "properties":{
        "SubscriptionId":{
            "type":"integer",
            "description":"The subscription header flexfield ID.",
            "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 : subscriptions-parties-item-post-request

Type: object

Show Source

• contacts: array Contacts
  Title: Contacts

  The contacts resource to view, create, update, and delete the contacts in a subscription party.
• ContactsPresent: string
  Indicates if the subscription has at least one party contact.
• EnablePrimary: boolean
  Title: Enable Primary

  Indicates whether party can be enabled as primary or not.
• InternalFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the party is internal or not.
• PartyId(required): integer (int64)
  Title: Party ID

  The unique identifier of the party.
• PartyName: string
  Title: Name

  The name of the party.
• PartyNumber: string
  Title: Party Number

  The alternate identifier of the party.
• PartyPuid(required): string
  Title: Party Number

  Maximum Length: 120

  The alternate identifier of the party.
• PartyRole(required): string
  Title: Role

  Maximum Length: 20

  The role of the party.
• PrimaryFlag: boolean
  Title: Primary

  Maximum Length: 1

  Default Value: false

  Indicates whether the party is primary or not.
• smartActions: array Subscription User Actions
  Title: Subscription User Actions

  The smart actions resource stores the endpoint and security details for every user action.
• SubscriptionId(required): integer (int64)
  The unique identifier of the subscription.
• SubscriptionPartyId: integer (int64)
  Title: Party ID

  The unique identifier of the subscription party.
• UpdateFlag: boolean
  Title: Update Flag

  Indicates whether update is allowed on party or not.

{
    "required":[
        "PartyId",
        "PartyPuid",
        "PartyRole",
        "SubscriptionId"
    ],
    "type":"object",
    "properties":{
        "PartyRole":{
            "title":"Role",
            "maxLength":20,
            "type":"string",
            "description":"The role of the party.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the party is primary or not.",
            "nullable":true,
            "default":false
        },
        "InternalFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the party is internal or not.",
            "nullable":true,
            "default":false
        },
        "EnablePrimary":{
            "title":"Enable Primary",
            "type":"boolean",
            "description":"Indicates whether party can be enabled as primary or not.",
            "nullable":true
        },
        "SubscriptionPartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the subscription party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PartyName":{
            "title":"Name",
            "type":"string",
            "description":"The name of the party.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "smartActions":{
            "title":"Subscription User Actions",
            "type":"array",
            "description":"The smart actions resource stores the endpoint and security details for every user action.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-parties-smartActions-item-post-request"
            }
        },
        "PartyNumber":{
            "title":"Party Number",
            "type":"string",
            "description":"The alternate identifier of the party.",
            "nullable":true
        },
        "ContactsPresent":{
            "type":"string",
            "description":"Indicates if the subscription has at least one party contact.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "UpdateFlag":{
            "title":"Update Flag",
            "type":"boolean",
            "description":"Indicates whether update is allowed on party or not.",
            "nullable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PartyPuid":{
            "title":"Party Number",
            "maxLength":120,
            "type":"string",
            "description":"The alternate identifier of the party.",
            "nullable":false
        },
        "contacts":{
            "title":"Contacts",
            "type":"array",
            "description":"The contacts resource to view, create, update, and delete the contacts in a subscription party.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-parties-contacts-item-post-request"
            }
        }
    }
}

Nested Schema : Contacts

Type: array

Title: Contacts

The contacts resource to view, create, update, and delete the contacts in a subscription party.

Show Source

• Array of: object subscriptions-parties-contacts-item-post-request

{
    "title":"Contacts",
    "type":"array",
    "description":"The contacts resource to view, create, update, and delete the contacts in a subscription party.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-parties-contacts-item-post-request"
    }
}

Nested Schema : Subscription User Actions

Type: array

Title: Subscription User Actions

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

Show Source

• Array of: object subscriptions-parties-smartActions-item-post-request

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

Nested Schema : subscriptions-parties-contacts-item-post-request

Type: object

Show Source

• AccessLevel: string
  Maximum Length: 302

  The access level of the contact.
• BillingOwnerFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether this contact is a billing owner or not.
• ContactEmail: string
  Title: Email

  The contact's email address.
• ContactId: integer (int64)
  The unique identifier of the contact.
• ContactName: string
  Title: Name

  The contact name.
• ContactNumber: string
  Title: Party Contact Number

  The contact number.
• ContactPuid: string
  Maximum Length: 120

  The alternate subscription contact.
• ContactRole: string
  Title: Role

  Maximum Length: 30

  The contact role.
• EndDate: string (date)
  The end date of the contact.
• InternalFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether this contact is internal or not.
• OwnerFlag: boolean
  Title: Owner

  Maximum Length: 1

  Default Value: false

  Indicates whether the contact is the owner.
• PartyId: integer
  The unique identifier of the party.
• PartyNumber: string
  Title: Party Number

  Maximum Length: 120

  Party Number
• PartyPuid: string
  Title: Party Number

  Maximum Length: 120

  Party PUID
• PartyRole: string
  Title: Role

  Maximum Length: 20

  Party Role
• StartDate: string (date)
  The start date of the contact.
• SubscriptionContactId: integer (int64)
  The unique identifier of the subscription contact.
• SubscriptionId: integer (int64)
  The unique identifier of the subscription.
• SubscriptionNumber: string
  Title: Subscription Number

  Maximum Length: 120

  Subscription Number
• SubscriptionPartyId: integer (int64)
  The unique identifier of the subscription party.

{
    "type":"object",
    "properties":{
        "PartyRole":{
            "title":"Role",
            "maxLength":20,
            "type":"string",
            "description":"Party Role",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionNumber":{
            "title":"Subscription Number",
            "maxLength":120,
            "type":"string",
            "description":"Subscription Number",
            "nullable":true,
            "x-queryable":false
        },
        "OwnerFlag":{
            "title":"Owner",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the contact is the owner.",
            "nullable":true,
            "default":false
        },
        "InternalFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this contact is internal or not.",
            "nullable":true,
            "default":false
        },
        "SubscriptionPartyId":{
            "type":"integer",
            "description":"The unique identifier of the subscription party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ContactId":{
            "type":"integer",
            "description":"The unique identifier of the contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EndDate":{
            "type":"string",
            "description":"The end date of the contact.",
            "format":"date",
            "nullable":true
        },
        "ContactRole":{
            "title":"Role",
            "maxLength":30,
            "type":"string",
            "description":"The contact role.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AccessLevel":{
            "maxLength":302,
            "type":"string",
            "description":"The access level of the contact.",
            "nullable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The start date of the contact.",
            "format":"date",
            "nullable":true
        },
        "PartyNumber":{
            "title":"Party Number",
            "maxLength":120,
            "type":"string",
            "description":"Party Number",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party.",
            "nullable":true,
            "x-queryable":false
        },
        "ContactPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The alternate subscription contact.",
            "nullable":false
        },
        "ContactEmail":{
            "title":"Email",
            "type":"string",
            "description":"The contact's email address.",
            "nullable":true
        },
        "ContactNumber":{
            "title":"Party Contact Number",
            "type":"string",
            "description":"The contact number.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "sortable":false
            }
        },
        "PartyPuid":{
            "title":"Party Number",
            "maxLength":120,
            "type":"string",
            "description":"Party PUID",
            "nullable":true
        },
        "BillingOwnerFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this contact is a billing owner or not.",
            "nullable":true,
            "default":false
        },
        "ContactName":{
            "title":"Name",
            "type":"string",
            "description":"The contact name.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "SubscriptionContactId":{
            "type":"integer",
            "description":"The unique identifier of the subscription contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : subscriptions-parties-smartActions-item-post-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(required): 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.
• UserActionId: integer (int64)
  Title: User Action ID

  The unique identifier of the subscription user actions.
• UserActionName(required): string
  Title: Action Name

  Maximum Length: 256

  The name of the subscription user 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.

{
    "required":[
        "DisplayLabel",
        "UserActionName"
    ],
    "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/subscriptions-parties-smartActions-UserActionURLBinding-item-post-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/subscriptions-parties-smartActions-UserActionNavigation-item-post-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
        },
        "UserActionName":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"The name of the subscription user actions.",
            "nullable":false
        },
        "UserActionId":{
            "title":"User Action ID",
            "type":"integer",
            "description":"The unique identifier of the subscription user actions.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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/subscriptions-parties-smartActions-UserActionRequestPayload-item-post-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 schema

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"UI navigation metadata striped by app usage.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-parties-smartActions-UserActionNavigation-item-post-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 schema

{
    "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/subscriptions-parties-smartActions-UserActionRequestPayload-item-post-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 schema

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

Nested Schema : schema

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.
• 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":{
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The system action flag of the user action navigation.",
            "nullable":true,
            "default":false
        },
        "UserActionNavId":{
            "title":"Primary Key",
            "type":"integer",
            "description":"The unique identifier of the subscription user action navigation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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 : schema

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.
• 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
        },
        "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
        },
        "RequestPayloadId":{
            "type":"integer",
            "description":"The request payload ID of the user action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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 : schema

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.
• 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
        },
        "Value":{
            "title":"URL Binding Parameter Value",
            "maxLength":1000,
            "type":"string",
            "description":"The value of URL binding of user action.",
            "nullable":true
        },
        "URLBindingId":{
            "type":"integer",
            "description":"The identifier of URL binding of user action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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
        }
    }
}

Nested Schema : schema

Type: object

Show Source

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

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

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

  The day part of the aling billing from 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 amend credit method of the product.
• AmendCreditMethodName: string
  The amend credit method name of the product.
• AmendDescription: string
  Title: Amendment Description

  Maximum Length: 2000

  The amend description of the product.
• AmendEffectiveDate: string (date)
  Title: Amendment Effective Date

  The amend effective date of the product.
• AmendReason: string
  Title: Amendment Reason

  Maximum Length: 30

  The amend reason of the product.
• AmendReasonName: string
  The amend reason name of the product.
• 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 suspension period 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 billing date code.
• BillingDateName: string
  The billing date name.
• BillingFrequency(required): string
  Title: Billing Frequency

  Maximum Length: 30

  The billing frequency.
• BillingFrequencyName: string
  Title: Billing Frequency

  The billing frequency name.
• 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.
• BillOnDay: number
  Title: Bill on Day

  The bill on day.
• BillToAccountDescription: string
  The bill-to account description.
• BillToAccountId(required): integer (int64)
  Title: Account Id

  The unique identifier of the bill-to account.
• BillToAccountNumber: string
  Title: Billing Account

  Maximum Length: 30

  The bill-to account number.
• 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 name of the subscription product bill-to site.
• BillToSiteNumber: string
  Title: Bill-to Site Number

  The bill-to site number of the subscription product.
• BillToSiteUseId(required): 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 canceled amount of the product.
• CanceledDate: string (date)
  Title: Product Canceled Date

  The date on which 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 charges for a subscription.
• CheckActiveExpiredAssetsExists: string
  Indicates whether any underlying assets of the subscription productare active or expired.
• 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 churn probability for the product.
• CloseCreditMethod: string
  Title: Close Credit Method

  Maximum Length: 30

  The close credit method.
• ClosedAmount: number
  Title: Closed Amount

  The closed amount of the product.
• ClosedDate: string (date)
  Title: Product Close Date

  The date on which 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.
• CoverageName: string
  Title: Template Name

  The name of the coverage.
• CoverageScheduleId: integer (int64)
  Title: Coverage Schedule ID

  The coverage schedule.
• coveredLevels: array Covered Levels
  Title: Covered Levels

  The covered levels resource is used to view, create, update, and delete the subscription covered levels.
• creditCards: array Credit Cards
  Title: Credit Cards

  The credit cards resource is used to view, create, and update the credit card information associated with a subscription.
• CreditedAmount: number
  Title: Credited Amount

  The credited amount of the product.
• CreditType: string
  Title: Credit Type

  Maximum Length: 30

  Indicates the type of credit issued to the customer such as negative invoice or credit memo.
• CurcyConvRateType: string
  Title: Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type.
• Currency(required): string
  Maximum Length: 15

  The subscription product currency.
• 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(required): integer (int64)
  Title: Inventory Organization

  The item master organization.
• Description: string
  Title: Product Description

  The subscription product description.
• DisplaySequence: number
  Title: Display Sequence

  The display sequence of the subscription product.
• DocumentTypeId: integer (int64)
  Title: Document Type

  Default Value: 10

  The unique 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 should be dropped while making the product change.
• Duration: integer
  Title: Duration

  The duration of the product.
• 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 early termination penalty name.
• EnableAdvBipTemplateFlag: boolean
  Title: Enable Advanced Configuration

  Maximum Length: 1

  Default Value: false

  Indicates whether advanced BIP configuration for usage invoice templates is enabled or not.
• 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 the billing is done upfront or not.
• EndDate: string (date)
  Title: Product End Date

  The end date of the product.
• 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 of 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 exempt certificate number.
• ExemptReason: string
  Title: Exemption Reason

  Maximum Length: 30

  The exempt reason.
• 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 of the product.
• ExternalRootAssetKey: string
  Title: External Root Asset Key

  Maximum Length: 120

  The external root asset key of the product.
• 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

  Indicates whether the billing schedule must be generated for the full period or not.
• GenerateBillingSchedule: string
  Title: Generate billing schedule for full period

  Maximum Length: 80

  Indicates whether billing schedule is to be generated or not.
• GracePeriod: integer (int64)
  Title: Grace Period in Days

  The grace period associated with the product.
• GroupingRuleNumberUsed: string
  Title: Grouping Rule Number

  Maximum Length: 120

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

  Maximum Length: 1

  Inflight Flag
• InterfaceOffsetDays: integer (int32)
  Title: Billing Interface Offset Days

  The number of offset days set by the interface.
• InventoryItemId(required): 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 BIP report template used for the invoice attachments.
• InvoicedAmount: number
  Title: Invoiced Amount

  The invoiced amount of the product.
• InvoiceText: string
  Title: Invoice Text

  Maximum Length: 4000

  The invoice text.
• InvoicingRuleId(required): integer (int64)
  Title: Invoicing Rule Id

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

  The invoice rule name.
• IsProductCreatedFromAmendFlag: boolean
  Is Product Created From Amend Flag
• ItemUnitOfMeasure: string
  Title: Pricing UOM Code

  Maximum Length: 15

  The item unit of measure.
• 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.
• LineNumber(required): string
  Title: Product Line Number

  Maximum Length: 300

  The line number.
• MilestoneBasedChargeFlag: boolean
  Milestone Based Charge Flag
• MonthlyRecurringRevenue: number
  Title: MRR

  The monthly recurring revenue of 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 Negotiated Volume Pricing Rules
  Title: Negotiated Volume Pricing Rules

  The negotiated volume pricing rules 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

  The next bill start date of the product.
• NextPricingDate: string (date)
  Title: Next Pricing Date

  The next pricing date of the product.
• 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 output tax classification.
• 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 payment method name.
• PaymentTermsId: integer (int64)
  Title: Payment Terms ID

  The unique identifier of the payment terms.
• PaymentTermsName: string
  Title: Payment Terms

  The payment terms name.
• PenaltyChargeName: string
  The penalty charge name.
• PenaltyValue: number
  Title: Penalty Value

  The penalty value associated with the product.
• 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 subscription product period.
• PONumber: string
  Title: PO Number

  Maximum Length: 50

  The PO number.
• PrePaymentNumber: integer (int64)
  Title: Prepayment Number

  The prepayment number.
• PriceAdjustmentBasis: string
  Title: Price Adjustment Basis

  Maximum Length: 30

  The basis on which the price is adjusted.
• PriceAdjustmentPercent: number
  Title: Price Adjustment Value

  The percentage of price adjustment.
• PriceAdjustmentType: string
  Title: Price Adjustment Type

  Maximum Length: 30

  The price adjustment type.
• PriceAsOf: string (date)
  Title: Price as of Date

  The price of the product.
• PriceListId: integer (int64)
  Title: Price List

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

  Maximum Length: 120

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

  The price transaction.
• PricingError: string
  Maximum Length: 2000

  The pricing error related to the product.
• PricingSystem: string
  The pricing system of the product.
• PricingTermsAdjustmentPCT: number
  Title: Pricing Term Adjustment Percentage

  The pricing terms adjustment of the product.
• PricingTermsDuration: number
  Title: Pricing Term Duration

  The pricing terms duration of the product.
• PricingTermsPeriod: string
  Title: Pricing Term

  Maximum Length: 15

  The pricing terms period of the product.
• PricingTermsPricingMethod: string
  Title: Pricing Method

  Maximum Length: 30

  The pricing terms pricing method of the product.
• PricingTermsStartDate: string (date)
  Title: Starting On

  The pricing terms start date of the product.
• ProductChangeReason: string
  Title: Change Reason

  Maximum Length: 300

  The reason for the subscription product change.
• ProductChangeSchedule: string
  Title: Apply Change

  Maximum Length: 30

  The schedule for the subscription product change.
• ProductChangeScheduleFrom: string (date)
  Title: Product Change Schedule Effective Date

  The from 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.
• Quantity: number
  Title: Quantity

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

  Quote Id
• QuoteLineId: integer (int64)
  Title: Quote Line ID

  Quote Line Id
• 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 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 ID of the related inventory item of the subscription product.
• RelatedProductDescription: string
  Title: Description

  The related product description.
• RelatedProductName: string
  Title: Product Name

  Maximum Length: 300

  The name of the related inventory item of the 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.
• 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 renewal type.
• 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 on which 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 will be resumed.
• ResumeDuration: integer
  The time duration for which the product will be suspended.
• ResumePeriod: string
  The time period after which the product will be resumed.
• 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 is used to view, create, update, and delete the sales credits defined for subscription or subscription products.
• 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

  Sales Order Line Id
• 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 sales product type.
• serviceResources: array Service Resources
  Title: Service Resources

  The service resources resource 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 ship-to party name.
• 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 ship-to party site name.
• ShipToPartySiteNumber: string
  Title: Ship-to Site Number

  The ship-to party site number of the subscription product.
• smartActions: array Subscription User Actions
  Title: Subscription 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 source key.
• 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 source number.
• SourceSystem: string
  Title: Source System

  Maximum Length: 30

  The source system.
• StartDate(required): string (date)
  Title: Product Start Date

  The start date of the product.
• Status: string
  Title: Status

  Maximum Length: 30

  Default Value: DRAFT

  The subscription product status.
• SubscriptionId(required): integer (int64)
  The unique identifier of the subscription.
• SubscriptionNumber: string
  Title: Subscription Number

  Maximum Length: 120

  Default Value: Subscriptions.SubscriptionNumber

  The subscription number.
• SubscriptionProductId: integer (int64)
  The unique identifier of the subscription product.
• SubscriptionProductPuid(required): string
  Title: Subscription Product Number

  Maximum Length: 120

  The subscription product PUID.
• SummarizedBillingFlag: boolean
  Title: Summarized billing

  Maximum Length: 1

  Indicates if the product uses summarized billing.
• 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

  The credit method used after suspension.
• 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 taxation error for the product, if any.
• 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 total contract value.
• TransactionTypeName(required): string
  Title: Transaction Type

  Maximum Length: 30

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

  Maximum Length: 200

  The template used for the regular usage events rating model.
• UsageEventCommitmentInvTemplate: string
  Title: Commitment

  Maximum Length: 200

  The template used for the usage events allowance rating model.
• UsageEventEstimateInvTemplate: string
  Title: Estimate

  Maximum Length: 200

  The template used for the usage events estimate rating model.
• UsageEventRegularInvTemplate: string
  Title: Basic

  Maximum Length: 200

  The template used for the regular usage events commitment rating model.
• 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.

{
    "required":[
        "AccountingRuleId",
        "BillToAccountId",
        "BillToSiteUseId",
        "BillingFrequency",
        "Currency",
        "DefinitionOrganizationId",
        "InventoryItemId",
        "InvoicingRuleId",
        "LineNumber",
        "StartDate",
        "SubscriptionId",
        "SubscriptionProductPuid",
        "TransactionTypeName"
    ],
    "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 next pricing date of the product.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "CurcyConvRateType":{
            "title":"Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion 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 will be resumed.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ChurnProbability":{
            "title":"Churn Probability",
            "type":"number",
            "description":"The churn probability for the product.",
            "nullable":true
        },
        "SourceKey":{
            "title":"Source Key",
            "maxLength":120,
            "type":"string",
            "description":"The source key.",
            "nullable":true,
            "x-queryable":false
        },
        "CheckActiveExpiredAssetsExists":{
            "type":"string",
            "description":"Indicates whether any underlying assets of the subscription productare active or expired.",
            "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
        },
        "Currency":{
            "maxLength":15,
            "type":"string",
            "description":"The subscription product currency.",
            "nullable":false,
            "x-queryable":false
        },
        "SalesOrderLineId":{
            "title":"Sales Order Line ID",
            "type":"integer",
            "description":"Sales Order Line Id",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The subscription product status.",
            "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
        },
        "SubscriptionProductPuid":{
            "title":"Subscription Product Number",
            "maxLength":120,
            "type":"string",
            "description":"The subscription product PUID.",
            "nullable":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 credited amount of the product.",
            "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 payment terms name.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AmendDescription":{
            "title":"Amendment Description",
            "maxLength":2000,
            "type":"string",
            "description":"The amend description of the product.",
            "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 charges for a subscription.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-charges-item-post-request"
            }
        },
        "ShipToPartySiteName":{
            "title":"Ship-to Site",
            "type":"string",
            "description":"The ship-to party site name.",
            "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 suspension period should be auto extended.",
            "nullable":true,
            "x-queryable":false
        },
        "GracePeriod":{
            "title":"Grace Period in Days",
            "type":"integer",
            "description":"The grace period associated with the product.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AmendReasonName":{
            "type":"string",
            "description":"The amend reason name of the product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OutputTaxClassification":{
            "title":"Output Tax Class",
            "maxLength":50,
            "type":"string",
            "description":"The output tax classification.",
            "nullable":true,
            "x-queryable":false
        },
        "MonthlyRecurringRevenue":{
            "title":"MRR",
            "type":"number",
            "description":"The monthly recurring revenue of the product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "enableInGenAI":"true"
            }
        },
        "CanceledAmount":{
            "title":"Canceled Amount",
            "type":"number",
            "description":"The canceled amount of the product.",
            "nullable":true,
            "x-queryable":false
        },
        "QuoteId":{
            "title":"Quote Id",
            "type":"integer",
            "description":"Quote Id",
            "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 used for the usage events allowance rating model.",
            "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 billing date code.",
            "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.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-billLines-item-post-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/subscriptions-products-negotiatedEntitlementPlanCommitments-item-post-request"
            }
        },
        "PricingTermsDuration":{
            "title":"Pricing Term Duration",
            "type":"number",
            "description":"The pricing terms duration of the product.",
            "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 end date of the product.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "enableInGenAI":"true"
            }
        },
        "DocumentTypeId":{
            "title":"Document Type",
            "type":"integer",
            "description":"The unique identifier of a source document type in Oracle Revenue Management Cloud.",
            "format":"int64",
            "nullable":true,
            "default":10,
            "x-hints":{
                "precision":18
            }
        },
        "ClosedAmount":{
            "title":"Closed Amount",
            "type":"number",
            "description":"The closed amount of the product.",
            "nullable":true,
            "x-queryable":false
        },
        "RelatedProductName":{
            "title":"Product Name",
            "maxLength":300,
            "type":"string",
            "description":"The name of the related inventory item of the 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 unit price of the product.",
            "nullable":true,
            "x-queryable":false
        },
        "ExternalRootAssetKey":{
            "title":"External Root Asset Key",
            "maxLength":120,
            "type":"string",
            "description":"The external root asset key of the product.",
            "nullable":true
        },
        "ResumeDuration":{
            "type":"integer",
            "description":"The time duration for which the product will be suspended.",
            "nullable":true,
            "x-queryable":false
        },
        "PriceTransactionOn":{
            "title":"Price Transaction on Date",
            "type":"string",
            "description":"The price transaction.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "GenerateBillingSchedule":{
            "title":"Generate billing schedule for full period",
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether 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 amend reason of the product.",
            "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 bill-to account number.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "BillingDateName":{
            "type":"string",
            "description":"The billing date name.",
            "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 User Actions",
            "type":"array",
            "description":"The smart actions resource stores the endpoint and security details for every user action.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-smartActions-item-post-request"
            }
        },
        "RelatedInventoryItemId":{
            "title":"Related Inventory Item ID",
            "type":"integer",
            "description":"The ID of the related inventory item of the 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/subscriptions-products-productRelationships-item-post-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":"Negotiated Volume Pricing Rules",
            "type":"array",
            "description":"The negotiated volume pricing rules 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/subscriptions-products-negotiatedVolumePricingRules-item-post-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 aling billing from date of a subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Duration":{
            "title":"Duration",
            "type":"integer",
            "description":"The duration of the product.",
            "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 renewal type.",
            "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 price adjustment type.",
            "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 sales product type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PriceAsOf":{
            "title":"Price as of Date",
            "type":"string",
            "description":"The price of the product.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "CoverageName":{
            "title":"Template Name",
            "type":"string",
            "description":"The name of the coverage.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "CoverageName1"
                ]
            }
        },
        "IsProductCreatedFromAmendFlag":{
            "type":"boolean",
            "description":"Is Product Created From Amend Flag",
            "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 schedule for the subscription product change.",
            "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 accounting rule name.",
            "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 pricing terms adjustment of the product.",
            "nullable":true,
            "x-queryable":false
        },
        "TaxError":{
            "title":"Tax Error",
            "maxLength":2000,
            "type":"string",
            "description":"The taxation error for the product, if any.",
            "nullable":true,
            "x-queryable":false
        },
        "InterfaceOffsetDays":{
            "title":"Billing Interface Offset Days",
            "type":"integer",
            "description":"The number of offset days set by the interface.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":5
            }
        },
        "CreditType":{
            "title":"Credit Type",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of credit issued to the customer such as negative invoice or credit memo.",
            "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 the 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.",
            "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 exempt certificate number.",
            "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"
                ]
            }
        },
        "GroupingRuleNumberUsed":{
            "title":"Grouping Rule Number",
            "maxLength":120,
            "type":"string",
            "description":"Grouping Rule Number Used",
            "nullable":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/subscriptions-products-associatedAsset-item-post-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 PO number.",
            "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":"Inflight Flag",
            "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 time period after which the product will be resumed.",
            "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 from of the subscription product change.",
            "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.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-relationships-item-post-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 BIP report template used for the invoice attachments.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SummarizedBillingFlag":{
            "title":"Summarized billing",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the product uses summarized billing.",
            "nullable":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
            }
        },
        "SourceNumber":{
            "title":"External Source Number",
            "maxLength":120,
            "type":"string",
            "description":"The source number.",
            "nullable":true,
            "x-queryable":false
        },
        "PricingTermsPeriod":{
            "title":"Pricing Term",
            "maxLength":15,
            "type":"string",
            "description":"The pricing terms period of the product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CanceledDate":{
            "title":"Product Canceled Date",
            "type":"string",
            "description":"The date on which 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 percentage of price adjustment.",
            "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 of 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 pricing terms pricing method of the product.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "serviceResources":{
            "title":"Service Resources",
            "type":"array",
            "description":"The service resources resource is used to view, create, update, and delete the service identifier for a subscription product.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-serviceResources-item-post-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 invoiced amount of the product.",
            "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/subscriptions-products-negotiatedEntitlementPlanEstimates-item-post-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":"The subscription product description.",
            "nullable":true,
            "x-queryable":false
        },
        "RelatedProductDescription":{
            "title":"Description",
            "type":"string",
            "description":"The related product description.",
            "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 invoice rule name.",
            "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
            }
        },
        "LineNumber":{
            "title":"Product Line Number",
            "maxLength":300,
            "type":"string",
            "description":"The line number.",
            "nullable":false
        },
        "PaymentMethodName":{
            "title":"Payment Method Name",
            "type":"string",
            "description":"The payment method name.",
            "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 of the product.",
            "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/subscriptions-products-flexFields-item-post-request"
            },
            "x-cardinality":"1"
        },
        "EarlyTerminationPenaltyName":{
            "type":"string",
            "description":"The early termination penalty name.",
            "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 total contract value.",
            "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 should be dropped while making the product change.",
            "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 view, create, update, and delete the subscription covered levels.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-coveredLevels-item-post-request"
            }
        },
        "CloseCreditMethod":{
            "title":"Close Credit Method",
            "maxLength":30,
            "type":"string",
            "description":"The close credit method.",
            "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 template used for the regular usage events commitment rating model.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "InvoiceBipReportCode"
                ]
            }
        },
        "PenaltyValue":{
            "title":"Penalty Value",
            "type":"number",
            "description":"The penalty value associated with the product.",
            "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 on which the product was closed.",
            "format":"date",
            "nullable":true
        },
        "SourceSystem":{
            "title":"Source System",
            "maxLength":30,
            "type":"string",
            "description":"The source system.",
            "nullable":true
        },
        "ProductChangeReason":{
            "title":"Change Reason",
            "maxLength":300,
            "type":"string",
            "description":"The reason for the subscription product change.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TransactionTypeName":{
            "title":"Transaction Type",
            "maxLength":30,
            "type":"string",
            "description":"The transaction type name.",
            "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":"Quote Line Id",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "BillToAccountDescription":{
            "type":"string",
            "description":"The bill-to account description.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "BillToAccountDescription1"
                ]
            }
        },
        "SuspendCreditMethod":{
            "title":"Suspend Credit Method",
            "maxLength":30,
            "type":"string",
            "description":"The credit method used after suspension.",
            "nullable":true,
            "x-queryable":false
        },
        "StartDate":{
            "title":"Product Start Date",
            "type":"string",
            "description":"The start date of the product.",
            "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 exempt reason.",
            "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 pricing terms start date of the product.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "PriceAdjustmentBasis":{
            "title":"Price Adjustment Basis",
            "maxLength":30,
            "type":"string",
            "description":"The basis on 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":"Milestone Based Charge Flag",
            "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.",
            "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 item unit of measure.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BillToSiteName":{
            "title":"Bill-to Site",
            "maxLength":255,
            "type":"string",
            "description":"The name of the subscription product bill-to site.",
            "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":"The coverage schedule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "UsageEventEstimateInvTemplate":{
            "title":"Estimate",
            "maxLength":200,
            "type":"string",
            "description":"The template used for the usage events estimate rating model.",
            "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 subscription product period.",
            "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/subscriptions-products-negotiatedEntitlementPlanDetails-item-post-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 bill on day.",
            "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 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 card information associated with a subscription.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-creditCards-item-post-request"
            }
        },
        "GenerateBillFullPeriodFlag":{
            "title":"Generate billing schedule for full period",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the billing schedule must be generated for the full period or not.",
            "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
            }
        },
        "DefinitionOrganizationId":{
            "title":"Inventory Organization",
            "type":"integer",
            "description":"The item master organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AmendCreditMethod":{
            "title":"Amendment Credit Method",
            "maxLength":30,
            "type":"string",
            "description":"The amend credit method of the product.",
            "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 ship-to party name.",
            "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 invoice text.",
            "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 amend credit method name of the product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "NextBillStartDate":{
            "title":"Next Bill Start Date",
            "type":"string",
            "description":"The next bill start date of the product.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "AmendEffectiveDate":{
            "title":"Amendment Effective Date",
            "type":"string",
            "description":"The amend effective date of the product.",
            "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 price list name of the product.",
            "nullable":true,
            "x-queryable":false
        },
        "UsageEventAllowanceInvTemplate":{
            "title":"Allowance",
            "maxLength":200,
            "type":"string",
            "description":"The template used for the regular usage events rating model.",
            "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 on which 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 billing frequency name.",
            "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 is used to view, create, update, and delete the sales credits defined for subscription or subscription products.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-salesCredits-item-post-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 or not.",
            "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 related to 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 schema

{
    "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/subscriptions-products-associatedAsset-item-post-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.

Show Source

• Array of: object schema

{
    "title":"Bill Lines",
    "type":"array",
    "description":"The bill lines resource is used to view, create, update, and delete the subscription bill line details.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-billLines-item-post-request"
    }
}

Nested Schema : Charges

Type: array

Title: Charges

The charges resource is used to view, create, update, and delete the charges for a subscription.

Show Source

• Array of: object schema

{
    "title":"Charges",
    "type":"array",
    "description":"The charges resource is used to view, create, update, and delete the charges for a subscription.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-charges-item-post-request"
    }
}

Nested Schema : Covered Levels

Type: array

Title: Covered Levels

The covered levels resource is used to view, create, update, and delete the subscription covered levels.

Show Source

• Array of: object schema

{
    "title":"Covered Levels",
    "type":"array",
    "description":"The covered levels resource is used to view, create, update, and delete the subscription covered levels.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-coveredLevels-item-post-request"
    }
}

Nested Schema : Credit Cards

Type: array

Title: Credit Cards

The credit cards resource is used to view, create, and update the credit card information 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 card information associated with a subscription.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-creditCards-item-post-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 schema

{
    "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/subscriptions-products-flexFields-item-post-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 schema

{
    "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/subscriptions-products-negotiatedEntitlementPlanCommitments-item-post-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 subscriptions-products-negotiatedEntitlementPlanDetails-item-post-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/subscriptions-products-negotiatedEntitlementPlanDetails-item-post-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 schema

{
    "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/subscriptions-products-negotiatedEntitlementPlanEstimates-item-post-request"
    }
}

Nested Schema : Negotiated Volume Pricing Rules

Type: array

Title: Negotiated Volume Pricing Rules

The negotiated volume pricing rules 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 schema

{
    "title":"Negotiated Volume Pricing Rules",
    "type":"array",
    "description":"The negotiated volume pricing rules 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/subscriptions-products-negotiatedVolumePricingRules-item-post-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 subscriptions-products-productRelationships-item-post-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/subscriptions-products-productRelationships-item-post-request"
    }
}

Nested Schema : Relationships

Type: array

Title: Relationships

The relationships resource is used to view, create, update, and delete the subscription product relationships.

Show Source

• Array of: object subscriptions-products-relationships-item-post-request

{
    "title":"Relationships",
    "type":"array",
    "description":"The relationships resource is used to view, create, update, and delete the subscription product relationships.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-relationships-item-post-request"
    }
}

Nested Schema : Sales Credits

Type: array

Title: Sales Credits

The sales credits resource is used to view, create, update, and delete the sales credits defined for subscription or subscription products.

Show Source

• Array of: object schema

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

Nested Schema : Service Resources

Type: array

Title: Service Resources

The service resources resource is used to view, create, update, and delete the service identifier for a subscription product.

Show Source

• Array of: object subscriptions-products-serviceResources-item-post-request

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

Nested Schema : Subscription User Actions

Type: array

Title: Subscription User Actions

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

Show Source

• Array of: object subscriptions-products-smartActions-item-post-request

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

Nested Schema : schema

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.
• 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.
• LineNumber: integer (int64)
  Title: Number

  The line number of the associated asset.
• 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":{
        "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"
                ]
            }
        },
        "AssociatedAssetId":{
            "type":"integer",
            "description":"The unique identifier of the associated asset.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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
        },
        "LineNumber":{
            "title":"Number",
            "type":"integer",
            "description":"The line number of the associated asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            }
        },
        "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
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "SubscriptionProductId"
                ]
            }
        },
        "SourceNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The source number of the associated asset.",
            "nullable":true
        },
        "AssociatedAssetPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The PUID of the associated asset.",
            "nullable":false
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscurption product.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AssetId":{
            "type":"integer",
            "description":"The unique identifier of the asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "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 : schema

Type: object

Show Source

• AdhocBillLineFlag: boolean
  Default Value: false

  Adhoc BillLine Flag
• Amount: number
  Title: Amount

  The amount of the bill.
• 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.
• BillingPeriod(required): number
  Title: Sequence

  The billing period.
• BillLineId: integer (int64)
  The unique identifier of the bill line.
• BillLinePuid(required): string
  Maximum Length: 120

  The bill line PUID.
• 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.
• ChargePeriod: number
  Title: Period

  The charge period.
• ChargePeriodFactor: number
  The change period factor associated with the bill line.
• ChargePuid: string
  Title: Charge PUID

  The charge PUID.
• CoveredLevelId: integer (int64)
  The unique identifier of the coverage 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)
  The unique identifier of the customer transaction type sequence.
• DateBilledFrom(required): string (date)
  Title: Bill-from Date

  The date from which the billing is done.
• DateBilledTo(required): string (date)
  Title: Bill-to Date

  The date to which the billing is done.
• DateToInterface: string (date)
  Title: Interface Date

  The date to interface.
• InterfacedFlag: boolean
  Title: Interfaced

  Maximum Length: 1

  Default Value: false

  Indicates whether the bill line is interfaced or not.
• InvoiceBillLineId: integer (int64)
  The invoice bill line ID.
• InvoiceDate: string (date)
  The date when the invoice was raised.
• InvoiceText: string
  Title: Invoice Text

  Maximum Length: 240

  The invoice text of the transaction.
• ListPrice: number
  The list price.
• 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 pricing error.
• RecurringFlag(required): boolean
  Maximum Length: 1

  Indicates whether this 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 of the transaction.
• 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 of the transaction.
• TransactionNumber: string
  Title: Invoice Number

  Maximum Length: 30

  The alternate identifier of the transaction.
• TransactionTax: number
  Title: Tax

  The tax related to the transaction.
• TransactionTypeName: string
  The transaction type name of the subscription bill line.
• TruedUpYn: string
  Maximum Length: 3

  Indicates whether the bill line has a true up period.
• TrxId: integer (int64)
  The transaction identifier associated with the billing.
• TrxLineId: integer (int64)
  The unique identifier of the transaction line.
• UsageAcquiredFlag: boolean
  Maximum Length: 1

  Indicates whether the usage has been acquired or not.
• UsageCaptureDate: string (date)
  Title: Usage Capture Date

  The usage capture date.
• 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 usage line has been priced or not.
• UsageQuantity: number
  Title: Usage Quantity

  The usage quantity.
• UsageRatingProcess: string
  Title: Usage Rating Process

  Maximum Length: 30

  The process used for rating usage.

{
    "required":[
        "BillLinePuid",
        "BillingPeriod",
        "DateBilledFrom",
        "DateBilledTo",
        "RecurringFlag"
    ],
    "type":"object",
    "properties":{
        "TrxId":{
            "type":"integer",
            "description":"The transaction identifier associated with the billing.",
            "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
        },
        "ChargePuid":{
            "title":"Charge PUID",
            "type":"string",
            "description":"The charge PUID.",
            "nullable":true
        },
        "ChargeDefinition":{
            "maxLength":30,
            "type":"string",
            "description":"The definition that indicates the purpose of the charge.",
            "nullable":true
        },
        "SentDate":{
            "title":"Sent Date",
            "type":"string",
            "description":"The date invoice information is sent to receivables.",
            "format":"date",
            "nullable":true
        },
        "UsagePricedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether usage line has been priced or not.",
            "nullable":true
        },
        "UsageRatingProcess":{
            "title":"Usage Rating Process",
            "maxLength":30,
            "type":"string",
            "description":"The process used for rating usage.",
            "nullable":true
        },
        "ListPrice":{
            "type":"number",
            "description":"The list price.",
            "nullable":true
        },
        "TransactionTax":{
            "title":"Tax",
            "type":"number",
            "description":"The tax related to 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
        },
        "MilestoneEventPuid":{
            "title":"Milestone Event PUID",
            "type":"string",
            "description":"Milestone Event Puid",
            "nullable":true
        },
        "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 bill line PUID.",
            "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.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-billLines-billAdjustments-item-post-request"
            }
        },
        "BillingPeriod":{
            "title":"Sequence",
            "type":"number",
            "description":"The billing period.",
            "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.",
            "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 unique identifier of the transaction line.",
            "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 usage capture date.",
            "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.",
            "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 alternate identifier 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":"The unique identifier of the customer transaction type sequence.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TruedUpYn":{
            "maxLength":3,
            "type":"string",
            "description":"Indicates whether the bill line has a true up 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 invoice text of the transaction.",
            "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 charge period.",
            "nullable":true
        },
        "TransactionDate":{
            "title":"Invoice Date",
            "type":"string",
            "description":"The date of the transaction.",
            "format":"date",
            "nullable":true
        },
        "InvoiceBillLineId":{
            "type":"integer",
            "description":"The invoice bill line ID.",
            "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 of the bill.",
            "nullable":true
        },
        "DateBilledTo":{
            "title":"Bill-to Date",
            "type":"string",
            "description":"The date to which the billing is done.",
            "format":"date",
            "nullable":false
        },
        "UsageQuantity":{
            "title":"Usage Quantity",
            "type":"number",
            "description":"The usage quantity.",
            "nullable":true
        },
        "CoveredLevelId":{
            "type":"integer",
            "description":"The unique identifier of the coverage 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 of the transaction.",
            "nullable":true
        },
        "RecurringFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this line is recurring or not.",
            "nullable":false
        },
        "BillLineId":{
            "type":"integer",
            "description":"The unique identifier of the bill line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DateBilledFrom":{
            "title":"Bill-from Date",
            "type":"string",
            "description":"The date from which the billing is done.",
            "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 pricing error.",
            "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.

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.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-billLines-billAdjustments-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• AdjustmentBasis: string
  Title: Basis

  Maximum Length: 30

  The adjustment basis
• AdjustmentName: string
  Title: Adjustment

  Maximum Length: 120

  The adjustment name
• AdjustmentReasonCode: string
  Maximum Length: 30

  The code of the adjustment reason.
• AdjustmentType: string
  Title: Type

  Maximum Length: 30

  The adjustment type
• AdjustmentValue: number
  Title: Value

  The adjustment value
• AutoAdjustmentFlag: boolean
  Maximum Length: 3

  Flag indicating whether the adjustment is automatic or not
• BasisEnableFlag: boolean
  Indicates if the basis has been enabled for the bill.
• BillAdjustmentId: integer (int64)
  The bill adjustment ID
• BillAdjustmentPuid: string
  Maximum Length: 120

  The bill adjustment PUID
• BillLineId: integer (int64)
  The bill line ID
• ChargeAdjustmentId: integer (int64)
  The charge adjustment ID
• ChargeAdjustmentPuid: string
  Title: Charge Adjustment PUID

  Maximum Length: 120

  Charge Adjustment Puid
• CurrencyCode: string
  The currency code. 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.
• Effectivity: string
  Maximum Length: 30

  The adjustment effectivity
• NumberOfPeriods: number
  The number of periods
• PeriodFrom: number
  The period from
• PeriodUntil: number
  The period until
• Reason: string
  Title: Reason Details

  Maximum Length: 120

  The adjustment reason
• 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
• SubscriptionId: integer (int64)
  The subscription ID
• SubscriptionProductId: integer (int64)
  The subscription product ID

{
    "type":"object",
    "properties":{
        "AutoAdjustmentFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Flag indicating whether the adjustment is automatic or not",
            "nullable":false
        },
        "AdjustmentBasis":{
            "title":"Basis",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment basis",
            "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 adjustment reason",
            "nullable":true
        },
        "CurrencyCode":{
            "type":"string",
            "description":"The currency code. 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
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The subscription ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"number",
            "description":"The sequence number",
            "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 subscription product ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "BillAdjustmentPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The bill adjustment PUID",
            "nullable":false
        },
        "PeriodUntil":{
            "type":"number",
            "description":"The period until",
            "nullable":true
        },
        "PeriodFrom":{
            "type":"number",
            "description":"The period from",
            "nullable":true
        },
        "BillAdjustmentId":{
            "type":"integer",
            "description":"The bill adjustment ID",
            "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
        },
        "ChargeAdjustmentPuid":{
            "title":"Charge Adjustment PUID",
            "maxLength":120,
            "type":"string",
            "description":"Charge Adjustment Puid",
            "nullable":true,
            "x-queryable":false
        },
        "ChargeAdjustmentId":{
            "type":"integer",
            "description":"The charge adjustment ID",
            "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 adjustment effectivity",
            "nullable":true
        },
        "AdjustmentType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment type",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AdjustmentValue":{
            "title":"Value",
            "type":"number",
            "description":"The adjustment value",
            "nullable":false
        },
        "BillLineId":{
            "type":"integer",
            "description":"The bill line ID",
            "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 adjustment name",
            "nullable":true
        },
        "BasisEnableFlag":{
            "type":"boolean",
            "description":"Indicates if the basis has been enabled for the bill.",
            "nullable":true
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• adjustments: array Adjustments
  Title: Adjustments

  The adjustments resource is used to view, create, update, and delete any adjustments to the subscription charge.
• AggregationMethod: string
  Title: Aggregation Method

  Maximum Length: 30

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

  The allowance
• 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 bill line ID
• BlockSize: number
  Title: Block Size

  The block size
• chargeComponents: array Subscription Charge Component Records
  Title: Subscription Charge Component Records

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

  Maximum Length: 30

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

  The charge definition name
• ChargeId: integer (int64)
  The charge ID
• 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 charge name
• 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 charge PUID
• chargeTiers: array Charge Tiers
  Title: Charge Tiers

  The charge tiers resource is used to view, create, update, and delete the subscription charge tier details for a subscription.
• 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
• 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
• PricePeriodicity: string
  Title: Periodicity

  Maximum Length: 30

  The price periodicity
• PricePeriodicityName: string
  Title: Periodicity

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

  Maximum Length: 30

  The price type
• 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 charges are rolled up.
• SequenceNumber: integer (int32)
  Title: Sequence Number

  The sequence number
• SubscriptionId: integer (int64)
  Title: Subscription ID

  The subscription ID
• SubscriptionProductId: integer (int64)
  Title: Subscription Product ID

  The subscription product ID
• TieredFlag: boolean
  Title: Tiered

  Maximum Length: 3

  The flag indicating 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 tier type
• TrueUpPeriod: string
  Title: True Up Period

  Maximum Length: 30

  Default Value: ORA_OSS_USAGE_BILLING_PERIOD

  The identifier of the true up period.
• TrueUpPeriodName: string
  Title: True Up Period

  The name of the true up period.
• UnitListPrice: number
  Title: List Price

  The unit list price
• UsagePriceLockFlag: boolean
  Title: Usage Price Lock

  Maximum Length: 3

  Flag indicating 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 charge PUID",
            "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/subscriptions-products-charges-chargeMilestoneEvents-item-post-request"
            }
        },
        "adjustments":{
            "title":"Adjustments",
            "type":"array",
            "description":"The adjustments resource is used to view, create, update, and delete any adjustments to the subscription charge.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-charges-adjustments-item-post-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 price periodicity name",
            "nullable":true
        },
        "PrePaymentNumber":{
            "title":"Prepayment Number",
            "type":"integer",
            "description":"The prepayment number",
            "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 unit list price",
            "nullable":true
        },
        "SequenceNumber":{
            "title":"Sequence Number",
            "type":"integer",
            "description":"The sequence number",
            "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 subscription product ID",
            "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":"Subscription Charge Component Records",
            "type":"array",
            "description":"The subscription charge components records resoure is used to view the details of the subscription charge component records.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-charges-chargeComponents-item-post-request"
            }
        },
        "ChargeName":{
            "title":"Charge Name",
            "maxLength":120,
            "type":"string",
            "description":"The charge name",
            "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":"The flag indicating whether the charge has tiers",
            "nullable":true
        },
        "UsagePriceLockFlag":{
            "title":"Usage Price Lock",
            "maxLength":3,
            "type":"boolean",
            "description":"Flag indicating 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 for a subscription.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-charges-chargeTiers-item-post-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",
            "nullable":false
        },
        "RollupFlag":{
            "title":"Rollup Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the charges are rolled up.",
            "nullable":true
        },
        "TierType":{
            "title":"Tier Type",
            "maxLength":30,
            "type":"string",
            "description":"The tier type",
            "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 charge definition name",
            "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 subscription ID",
            "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 true up period.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ExternalKey":{
            "title":"External Key",
            "maxLength":120,
            "type":"string",
            "description":"The external key",
            "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",
            "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",
            "nullable":true
        },
        "TrueUpPeriod":{
            "title":"True Up Period",
            "maxLength":30,
            "type":"string",
            "description":"The identifier of the true up period.",
            "nullable":true,
            "default":"ORA_OSS_USAGE_BILLING_PERIOD"
        },
        "BillLineId":{
            "type":"integer",
            "description":"The bill line ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeId":{
            "type":"integer",
            "description":"The charge ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BlockSize":{
            "title":"Block Size",
            "type":"number",
            "description":"The block size",
            "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 any adjustments to the subscription charge.

Show Source

• Array of: object subscriptions-products-charges-adjustments-item-post-request

{
    "title":"Adjustments",
    "type":"array",
    "description":"The adjustments resource is used to view, create, update, and delete any adjustments to the subscription charge.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-charges-adjustments-item-post-request"
    }
}

Nested Schema : Subscription Charge Component Records

Type: array

Title: Subscription Charge Component Records

The subscription charge components records resoure is used to view the details of the subscription charge component records.

Show Source

• Array of: object subscriptions-products-charges-chargeComponents-item-post-request

{
    "title":"Subscription Charge Component Records",
    "type":"array",
    "description":"The subscription charge components records resoure is used to view the details of the subscription charge component records.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-charges-chargeComponents-item-post-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 schema

{
    "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/subscriptions-products-charges-chargeMilestoneEvents-item-post-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 for a subscription.

Show Source

• Array of: object schema

{
    "title":"Charge Tiers",
    "type":"array",
    "description":"The charge tiers resource is used to view, create, update, and delete the subscription charge tier details for a subscription.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-charges-chargeTiers-item-post-request"
    }
}

Nested Schema : subscriptions-products-charges-adjustments-item-post-request

Type: object

Show Source

• AdjustmentBasis: string
  Title: Basis

  Maximum Length: 30

  The adjustment basis
• AdjustmentName: string
  Title: Adjustment

  Maximum Length: 120

  The adjustment name
• 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 adjustment type
• AdjustmentValue: number
  Title: Value

  The adjustment value
• AutoAdjustmentFlag: boolean
  Maximum Length: 3

  Flag indicating whether the adjustment is automatic or not
• ChargeAdjustmentId: integer (int64)
  The charge adjustment ID
• ChargeAdjustmentPuid: string
  Maximum Length: 120

  The charge adjustment PUID
• ChargeId: integer (int64)
  The charge ID
• Effectivity: string
  Title: Effectivity

  Maximum Length: 30

  The adjustment effectivity
• NumberOfPeriods: number
  The number of periods
• ObjectVersionNumber: integer (int32)
  Object version number
• PeriodFrom: number
  The period from
• PeriodUntil: number
  The period until
• Reason: string
  Title: Reason Description

  Maximum Length: 120

  The adjustment reason
• SequenceNumber: integer (int32)
  Title: Sequence

  The sequence number
• SubscriptionId: integer (int64)
  The subscription ID
• SubscriptionProductId: integer (int64)
  The subscription product ID

{
    "type":"object",
    "properties":{
        "AutoAdjustmentFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Flag indicating whether the adjustment is automatic or not",
            "nullable":true
        },
        "ChargeAdjustmentPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The charge adjustment PUID",
            "nullable":true
        },
        "AdjustmentBasis":{
            "title":"Basis",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment basis",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChargeAdjustmentId":{
            "type":"integer",
            "description":"The charge adjustment ID",
            "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 adjustment reason",
            "nullable":true
        },
        "AdjustmentType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment type",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The subscription ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AdjustmentValue":{
            "title":"Value",
            "type":"number",
            "description":"The adjustment value",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object version number",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"integer",
            "description":"The sequence number",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "NumberOfPeriods":{
            "type":"number",
            "description":"The number of periods",
            "nullable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The charge ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The subscription product ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PeriodUntil":{
            "type":"number",
            "description":"The period until",
            "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 adjustment name",
            "nullable":true
        },
        "PeriodFrom":{
            "type":"number",
            "description":"The period from",
            "nullable":true
        }
    }
}

Nested Schema : subscriptions-products-charges-chargeComponents-item-post-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 : schema

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

  The PUID of the bill line 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.
• 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.
• 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
            }
        },
        "EventId":{
            "type":"integer",
            "description":"The ID of the milestone event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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
            }
        },
        "BillLinePuid":{
            "title":"Bill Line PUID",
            "maxLength":120,
            "type":"string",
            "description":"The PUID of the bill line associated with the milestone event.",
            "nullable":true,
            "x-queryable":false
        },
        "CompletionDate":{
            "type":"string",
            "description":"The completion date of the milestone event.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BillingOffset"
                ]
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• AdditionalNumberFive: number
  Title: Additional Number Five

  The additional number five
• AdditionalNumberFour: number
  Title: Additional Number Four

  The additional number four
• AdditionalNumberOne: number
  Title: Additional Number One

  The additional number one
• AdditionalNumberSix: number
  Title: Additional Number Six

  The additional number six
• AdditionalNumberThree: number
  Title: Additional Number Three

  The additional number three
• AdditionalNumberTwo: number
  Title: Additional Number Two

  The additional number two
• AdditionalTextOne: string
  Title: Additional Text One

  Maximum Length: 4000

  The additional text one
• AdditionalTextTwo: string
  Title: Additional Text Two

  Maximum Length: 4000

  The additional text two
• AdditionalTimestampOne: string (date-time)
  Title: Additional Time-stamp One

  The additional timestamp one
• AdditionalTimestampThree: string (date-time)
  Title: Additional Time-stamp Three

  The additional timestamp three
• AdditionalTimestampTwo: string (date-time)
  Title: Additional Time-stamp Two

  The additional timestamp two
• AddtionalTextThree: string
  Title: Additional Text Three

  Maximum Length: 4000

  The additional text three
• BlockSize: number
  Title: Block Size

  The block size
• ChargeId: integer (int64)
  The charge ID
• ChargeTierId: integer (int64)
  The charge tier ID
• ChargeTierPuid: string
  Maximum Length: 120

  The charge tier PUID
• ListPrice: number
  Title: List Price

  The list price
• PriceFormat: string
  Title: Price Format

  Maximum Length: 30

  The price format
• SequenceNumber: number
  The sequence number
• SubscriptionId: integer (int64)
  The subscription ID
• SubscriptionProductId: integer (int64)
  The subscription product ID
• TierFrom: number
  Title: Tier From

  The tier from
• TierTo: number
  Title: Tier To

  The tier to

{
    "type":"object",
    "properties":{
        "ChargeTierId":{
            "type":"integer",
            "description":"The charge tier ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AdditionalTimestampTwo":{
            "title":"Additional Time-stamp Two",
            "type":"string",
            "description":"The additional timestamp two",
            "format":"date-time",
            "nullable":true
        },
        "AdditionalNumberFour":{
            "title":"Additional Number Four",
            "type":"number",
            "description":"The additional number four",
            "nullable":true
        },
        "ChargeTierPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The charge tier PUID",
            "nullable":false
        },
        "AdditionalNumberThree":{
            "title":"Additional Number Three",
            "type":"number",
            "description":"The additional number three",
            "nullable":true
        },
        "AdditionalTimestampOne":{
            "title":"Additional Time-stamp One",
            "type":"string",
            "description":"The additional timestamp one",
            "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 price format",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AdditionalTextOne":{
            "title":"Additional Text One",
            "maxLength":4000,
            "type":"string",
            "description":"The additional text one",
            "nullable":true
        },
        "AdditionalNumberFive":{
            "title":"Additional Number Five",
            "type":"number",
            "description":"The additional number five",
            "nullable":true
        },
        "AdditionalNumberSix":{
            "title":"Additional Number Six",
            "type":"number",
            "description":"The additional number six",
            "nullable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The subscription ID",
            "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":"The additional text three",
            "nullable":true
        },
        "AdditionalNumberOne":{
            "title":"Additional Number One",
            "type":"number",
            "description":"The additional number one",
            "nullable":true
        },
        "SequenceNumber":{
            "type":"number",
            "description":"The sequence number",
            "nullable":false
        },
        "AdditionalTextTwo":{
            "title":"Additional Text Two",
            "maxLength":4000,
            "type":"string",
            "description":"The additional text two",
            "nullable":true
        },
        "AdditionalTimestampThree":{
            "title":"Additional Time-stamp Three",
            "type":"string",
            "description":"The additional timestamp three",
            "format":"date-time",
            "nullable":true
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The subscription product ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeId":{
            "type":"integer",
            "description":"The charge ID",
            "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":"The additional number two",
            "nullable":true
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• Address: string
  Title: Address

  The address of the party site associated with child covered level.
• 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 universal serial number associated with 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.
• CalculatedCreditAmount: number
  Title: Calculated Credit Amount

  The calculated credit amount of the child covered level.
• CalculateEstimatedTaxFlag: boolean
  Indicates whether estimated tax will be calculated for the subscription child covered level.
• CancelDescription: string
  Title: Cancellation Description

  Maximum Length: 2000

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

  The amount that was cancelled.
• CanceledDate: string (date)
  Title: Canceled Date

  The date of cancellation.
• CancelReason: string
  Title: Cancellation Reason

  Maximum Length: 30

  The reason for cancellation.
• charges: array Charges
  Title: Charges

  The charges resource is used to view, create, update, and delete the charges for a subscription.
• childCoveredLevels: array Child Covered Levels
  Title: Child Covered Levels

  The child covered levels resource is used to view, create, update, and delete the subscription child covered levels.
• ClosedAmount: number
  Title: Closed Amount

  The amount when 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 child covered level.
• CloseReason: string
  Title: Covered Level Close Reason

  Maximum Length: 30

  The reason when the covered level was closed.
• CorpCurrencyCode: string
  Title: Currency Code

  Maximum Length: 15

  The corporate currency code associated with the account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• 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 covered parent for the parent.
• CoveredLevelPuid(required): 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 associated with child covered level.
• CoveredLevlNumber: string
  Title: Covered Level Number

  The alternate identifier of the covered level associated with child covered level.
• CreditedAmount: number
  Title: Credited Amount

  The credited amount for the covered level.
• CreditType: string
  Title: Credit Type

  Maximum Length: 30

  Indicates the type of credit issued to the customer such as negative invoice or credit memo.
• CurcyConvRateType: string
  Title: Conversion Rate Type

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

  Maximum Length: 15

  The currency code. 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 associated with child covered level.
• CustomerName: string
  Title: Customer Account

  The name of the customer associated with child covered level.
• CustomerNumber: string
  Title: Customer Account Number

  The alternate unique identifier of the customer associated with child covered level.
• Description: string
  Title: Covered Level Description

  The description of the covered level.
• Duration: integer
  The duration for which the covered level is active.
• EndDate: string (date)
  Title: Covered Level End Date

  The end date for the covered level.
• ExplodeAssetHierarchy: string
  The explode hierarchy for the asset.
• GenBillSchReqdFlag: boolean
  Title: Billing schedule update required

  Maximum Length: 1

  Generate Bill Schedule Required Flag
• GenerateBillingSchedule: string
  The schedule by the bill is generated.
• HierarchyTotal: number
  The total when the covered level was closed.
• InventoryItemId: integer (int64)
  Title: Item ID

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

  The invoiced amount.
• InvoiceText: string
  Maximum Length: 2000

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

  Maximum Length: 15

  The unit of measure used by the item.
• LineNumber: string
  Title: Number

  Maximum Length: 300

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

  The override credit amount of the child 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 parent level for the level.
• PartyId: integer (int64)
  Title: Party ID

  The unique identifier of the party associated with child covered level.
• PartyName: string
  Title: Party Name

  The name of the party associated with child covered level.
• PartyNumber: string
  Title: Party Number

  The alternate identifier of the party associated with child covered level.
• PartySite: string
  Title: Party Site Number

  The name of the party site associated with child covered level.
• PartySiteId: integer (int64)
  Title: Party Site ID

  The unique identifier of the party site associated with child covered level.
• Period: string
  Maximum Length: 80

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

  The price of the covered level.
• 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 by the item.
• PriceUnitOfMeasureName: string
  Title: Pricing UOM

  The name of the unit of measure.
• PricingError: string
  Title: Pricing Error

  Maximum Length: 1000

  Any errors associated with the pricing.
• 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.
• PutOnHoldFlag: boolean
  Indicates if the covered level has been put on hold.
• Quantity: number
  Title: Quantity

  Default Value: 1

  The quantity for which the bill line was charged.
• relationships: array Relationships
  Title: Relationships

  The relationships resource is used to view, create, update, and delete the subscription product relationships.
• RemoveHoldFlag: boolean
  Indicates if the covered level's hold has to be removed.
• RenewalType: string
  Title: Renewal Type

  Maximum Length: 30

  The type of renewal.
• RenewedDate: string (date)
  Title: Renewed On

  The date when the covered level was renewed.
• RepriceFlag: boolean
  Indicates whether the subscription child covered level should be repriced or not. If passed as 'true', the subscription child covered level 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 return method for the credit after the covered level was closed.
• RevenueOption: string
  Title: Revenue Accounting Option

  Maximum Length: 30

  Revenue Option
• RollupTotal: number
  Title: Configured Asset Amount

  The total when the covered level was closed.
• SourceKey: string
  Title: Source Key

  Maximum Length: 120

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

  Maximum Length: 120

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

  Maximum Length: 120

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

  Maximum Length: 120

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

  Maximum Length: 30

  The source system of the child covered level.
• StartDate(required): string (date)
  Title: Covered Level Start Date

  The start date for the covered level.
• Status: string
  Title: Covered Level Status

  Maximum Length: 30

  The status of the covered level.
• StatusName: string
  Title: Status

  The description of the status.
• SubscriptionId(required): integer (int64)
  Title: Subscription ID

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

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

  The suppressed amount for the credit.
• SuspendCreditMethod: string
  Title: Suspend Credit Method

  Maximum Length: 30

  The suspend method for the credit after the covered level was closed.
• 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 when the covered level was suspended.
• TaxAmount: number
  Title: Tax Amount

  The amount of tax to be deducted.
• TaxError: string
  Maximum Length: 4000

  The tax error for the covered level.
• TotalContractValue: number
  Title: Covered Level Contract Value

  The total contract value
• Type(required): string
  Title: Type

  Maximum Length: 30

  The type of the covered level.
• TypeName: string
  Title: Covered Level Type

  The type name associated with the covered level.
• UnitPrice: number
  Title: Unit Price

  The unit price of the covered level associated with child covered level.

{
    "required":[
        "CoveredLevelPuid",
        "StartDate",
        "SubscriptionId",
        "SubscriptionProductId",
        "Type"
    ],
    "type":"object",
    "properties":{
        "CalculatedCreditAmount":{
            "title":"Calculated Credit Amount",
            "type":"number",
            "description":"The calculated credit amount of the child covered level.",
            "nullable":true
        },
        "Address":{
            "title":"Address",
            "type":"string",
            "description":"The address of the party site associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CancelDescription":{
            "title":"Cancellation Description",
            "maxLength":2000,
            "type":"string",
            "description":"The cancel description associated with a child covered level.",
            "nullable":true
        },
        "CurcyConvRateType":{
            "title":"Conversion Rate Type",
            "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
        },
        "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 total when the covered level was closed.",
            "nullable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The currency code. 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.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-coveredLevels-relationships-item-post-request"
            }
        },
        "TaxAmount":{
            "title":"Tax Amount",
            "type":"number",
            "description":"The amount of tax to be deducted.",
            "nullable":true
        },
        "SourceKey":{
            "title":"Source Key",
            "maxLength":120,
            "type":"string",
            "description":"The source key of the child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CloseReason":{
            "title":"Covered Level Close Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason when the covered level was closed.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CoveredLevelParentPuid":{
            "type":"string",
            "description":"The covered parent for the parent.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceNumber":{
            "title":"External Source Number",
            "maxLength":120,
            "type":"string",
            "description":"The source number of the child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "PartySiteId":{
            "title":"Party Site ID",
            "type":"integer",
            "description":"The unique identifier of the party site associated with child covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CanceledDate":{
            "title":"Canceled Date",
            "type":"string",
            "description":"The date of cancellation.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ExplodeAssetHierarchy":{
            "type":"string",
            "description":"The explode hierarchy for the asset.",
            "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
            }
        },
        "Status":{
            "title":"Covered Level Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the covered level.",
            "nullable":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
            }
        },
        "CreditedAmount":{
            "title":"Credited Amount",
            "type":"number",
            "description":"The credited amount for the covered level.",
            "nullable":true
        },
        "StatusName":{
            "title":"Status",
            "type":"string",
            "description":"The description of the status.",
            "nullable":true
        },
        "charges":{
            "title":"Charges",
            "type":"array",
            "description":"The charges resource is used to view, create, update, and delete the charges for a subscription.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-coveredLevels-charges-item-post-request"
            }
        },
        "SuppressedCreditAmount":{
            "title":"Suppressed Credit Amount",
            "type":"number",
            "description":"The suppressed amount for the credit.",
            "nullable":true
        },
        "childCoveredLevels":{
            "title":"Child Covered Levels",
            "type":"array",
            "description":"The child covered levels resource is used to view, create, update, and delete the subscription child covered levels.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-coveredLevels-childCoveredLevels-item-post-request"
            }
        },
        "PriceListId":{
            "title":"Price List",
            "type":"integer",
            "description":"The unique identifier of the price list.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "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 invoiced amount.",
            "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
        },
        "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":"The description of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CanceledAmount":{
            "title":"Canceled Amount",
            "type":"number",
            "description":"The amount that was cancelled.",
            "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
        },
        "SubscriptionId":{
            "title":"Subscription ID",
            "type":"integer",
            "description":"The unique identifier of the associated subscription.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CoveredLevelPuid":{
            "title":"Covered Level PUID",
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the covered level.",
            "nullable":false
        },
        "RevenueOption":{
            "title":"Revenue Accounting Option",
            "maxLength":30,
            "type":"string",
            "description":"Revenue Option",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "billLines":{
            "title":"Bill Lines",
            "type":"array",
            "description":"The bill lines resource is used to view, create, update, and delete the subscription bill line details.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-coveredLevels-billLines-item-post-request"
            }
        },
        "TotalContractValue":{
            "title":"Covered Level Contract Value",
            "type":"number",
            "description":"The total contract value",
            "nullable":true
        },
        "SuspendReason":{
            "title":"Covered Level Suspend Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason when the covered level was suspended.",
            "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
            }
        },
        "HierarchyTotal":{
            "type":"number",
            "description":"The total when the covered level was closed.",
            "nullable":true
        },
        "EndDate":{
            "title":"Covered Level End Date",
            "type":"string",
            "description":"The end date for the covered level.",
            "format":"date",
            "nullable":true
        },
        "ClosedAmount":{
            "title":"Closed Amount",
            "type":"number",
            "description":"The amount when the covered level was closed.",
            "nullable":true
        },
        "CoveredLevlName":{
            "title":"Covered Level Name",
            "type":"string",
            "description":"The name of the covered level associated with child covered level.",
            "nullable":true
        },
        "OverrideCreditAmount":{
            "title":"Override Credit Amount",
            "type":"number",
            "description":"The override credit amount of the child covered level.",
            "nullable":true
        },
        "CalculateEstimatedTaxFlag":{
            "type":"boolean",
            "description":"Indicates whether estimated tax will be calculated for the subscription child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "Type":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the covered level.",
            "nullable":false
        },
        "UnitPrice":{
            "title":"Unit Price",
            "type":"number",
            "description":"The unit price of the covered level associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "GenerateBillingSchedule":{
            "type":"string",
            "description":"The schedule by the bill is generated.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the party associated with child covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "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 child covered level.",
            "nullable":true
        },
        "SourceSystem":{
            "title":"External Source System",
            "maxLength":30,
            "type":"string",
            "description":"The source system of the child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "TypeName":{
            "title":"Covered Level Type",
            "type":"string",
            "description":"The type name associated with the covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ProductName":{
            "title":"Product Name",
            "type":"string",
            "description":"The name of the product.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "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/subscriptions-products-coveredLevels-productAssetRelationships-item-post-request"
            }
        },
        "ParentCoveredLevelId":{
            "title":"Parent Covered Level ID",
            "type":"integer",
            "description":"The parent level for the level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PartyName":{
            "title":"Party Name",
            "type":"string",
            "description":"The name of the party associated with child covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "SuspendCreditMethod":{
            "title":"Suspend Credit Method",
            "maxLength":30,
            "type":"string",
            "description":"The suspend method for the credit after the covered level was closed.",
            "nullable":true
        },
        "StartDate":{
            "title":"Covered Level Start Date",
            "type":"string",
            "description":"The start date for the covered level.",
            "format":"date",
            "nullable":false
        },
        "CustomerNumber":{
            "title":"Customer Account Number",
            "type":"string",
            "description":"The alternate unique identifier of the customer associated with child covered level.",
            "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
            }
        },
        "CorpCurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code associated with the account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true
        },
        "ItemUnitOfMeasure":{
            "title":"UOM",
            "maxLength":15,
            "type":"string",
            "description":"The unit of measure used by the item.",
            "nullable":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 during which the covered level is used.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Duration":{
            "type":"integer",
            "description":"The duration for which the covered level is active.",
            "nullable":true,
            "x-queryable":false
        },
        "RenewalType":{
            "title":"Renewal Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of 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 universal serial number associated with the asset.",
            "nullable":true
        },
        "CancelReason":{
            "title":"Cancellation Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason for cancellation.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PriceUnitOfMeasureName":{
            "title":"Pricing UOM",
            "type":"string",
            "description":"The name of the unit of measure.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ReturnCreditMethod":{
            "title":"Close Credit Method",
            "maxLength":230,
            "type":"string",
            "description":"The return method for the credit after the covered level was closed.",
            "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 child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CoveredLevlNumber":{
            "title":"Covered Level Number",
            "type":"string",
            "description":"The alternate identifier of the covered level associated with child covered level.",
            "nullable":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 of the covered level.",
            "format":"date",
            "nullable":true
        },
        "PartySite":{
            "title":"Party Site Number",
            "type":"string",
            "description":"The name of the party site associated with child covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "InvoiceText":{
            "maxLength":2000,
            "type":"string",
            "description":"The text to be included in the invoice.",
            "nullable":true
        },
        "CustomerAccountId":{
            "title":"Customer Account ID",
            "type":"integer",
            "description":"The unique identifier of the customer account associated with child covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TaxError":{
            "maxLength":4000,
            "type":"string",
            "description":"The tax error for the covered level.",
            "nullable":true
        },
        "CustomerName":{
            "title":"Customer Account",
            "type":"string",
            "description":"The name of the customer associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CreditType":{
            "title":"Credit Type",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of credit issued to the customer such as negative invoice or credit memo.",
            "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 child 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 child covered level should be repriced or not. If passed as 'true', the subscription child covered level 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
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity for which the bill line was charged.",
            "nullable":false,
            "default":1
        },
        "PriceUnitOfMeasure":{
            "title":"Pricing UOM",
            "maxLength":30,
            "type":"string",
            "description":"The unit of measure used by the item.",
            "nullable":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 associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "RemoveHoldFlag":{
            "type":"boolean",
            "description":"Indicates if the covered level's hold has to be removed.",
            "nullable":true,
            "x-queryable":false
        },
        "PricingError":{
            "title":"Pricing Error",
            "maxLength":1000,
            "type":"string",
            "description":"Any errors associated with the pricing.",
            "nullable":true
        },
        "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.

Show Source

• Array of: object schema

{
    "title":"Bill Lines",
    "type":"array",
    "description":"The bill lines resource is used to view, create, update, and delete the subscription bill line details.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-coveredLevels-billLines-item-post-request"
    }
}

Nested Schema : Charges

Type: array

Title: Charges

The charges resource is used to view, create, update, and delete the charges for a subscription.

Show Source

• Array of: object subscriptions-products-coveredLevels-charges-item-post-request

{
    "title":"Charges",
    "type":"array",
    "description":"The charges resource is used to view, create, update, and delete the charges for a subscription.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-coveredLevels-charges-item-post-request"
    }
}

Nested Schema : Child Covered Levels

Type: array

Title: Child Covered Levels

The child covered levels resource is used to view, create, update, and delete the subscription child covered levels.

Show Source

• Array of: object subscriptions-products-coveredLevels-childCoveredLevels-item-post-request

{
    "title":"Child Covered Levels",
    "type":"array",
    "description":"The child covered levels resource is used to view, create, update, and delete the subscription child covered levels.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-coveredLevels-childCoveredLevels-item-post-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 subscriptions-products-coveredLevels-productAssetRelationships-item-post-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/subscriptions-products-coveredLevels-productAssetRelationships-item-post-request"
    }
}

Nested Schema : Relationships

Type: array

Title: Relationships

The relationships resource is used to view, create, update, and delete the subscription product relationships.

Show Source

• Array of: object schema

{
    "title":"Relationships",
    "type":"array",
    "description":"The relationships resource is used to view, create, update, and delete the subscription product relationships.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-coveredLevels-relationships-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• AdhocBillLineFlag: boolean
  Default Value: false

  Adhoc BillLine Flag
• Amount: number
  Title: Amount

  The amount of the bill.
• 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.
• BillingPeriod(required): number
  Title: Sequence

  The billing period.
• BillLineId: integer (int64)
  The unique identifier of the bill line.
• BillLinePuid(required): string
  Maximum Length: 120

  The bill line PUID.
• 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.
• ChargePeriod: number
  Title: Period

  The charge period.
• ChargePeriodFactor: number
  The change period factor associated with the bill line.
• ChargePuid: string
  Title: Charge PUID

  The charge PUID.
• CoveredLevelId: integer (int64)
  The unique identifier of the coverage 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)
  The unique identifier of the customer transaction type sequence.
• DateBilledFrom(required): string (date)
  Title: Bill-from Date

  The date from which the billing is done.
• DateBilledTo(required): string (date)
  Title: Bill-to Date

  The date to which the billing is done.
• DateToInterface: string (date)
  Title: Interface Date

  The date to interface.
• InterfacedFlag: boolean
  Title: Interfaced

  Maximum Length: 1

  Default Value: false

  Indicates whether the bill line is interfaced or not.
• InvoiceBillLineId: integer (int64)
  The invoice bill line ID.
• InvoiceDate: string (date)
  The date when the invoice was raised.
• InvoiceText: string
  Title: Invoice Text

  Maximum Length: 240

  The invoice text of the transaction.
• ListPrice: number
  The list price.
• 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 pricing error.
• RecurringFlag(required): boolean
  Maximum Length: 1

  Indicates whether this 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 of the transaction.
• 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 of the transaction.
• TransactionNumber: string
  Title: Invoice Number

  Maximum Length: 30

  The alternate identifier of the transaction.
• TransactionTax: number
  Title: Tax

  The tax related to the transaction.
• TransactionTypeName: string
  The transaction type name of the subscription bill line.
• TruedUpYn: string
  Maximum Length: 3

  Indicates whether the bill line has a true up period.
• TrxId: integer (int64)
  The transaction identifier associated with the billing.
• TrxLineId: integer (int64)
  The unique identifier of the transaction line.
• UsageAcquiredFlag: boolean
  Maximum Length: 1

  Indicates whether the usage has been acquired or not.
• UsageCaptureDate: string (date)
  Title: Usage Capture Date

  The usage capture date.
• 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 usage line has been priced or not.
• UsageQuantity: number
  Title: Usage Quantity

  The usage quantity.
• UsageRatingProcess: string
  Title: Usage Rating Process

  Maximum Length: 30

  The process used for rating usage.

{
    "required":[
        "BillLinePuid",
        "BillingPeriod",
        "DateBilledFrom",
        "DateBilledTo",
        "RecurringFlag"
    ],
    "type":"object",
    "properties":{
        "TrxId":{
            "type":"integer",
            "description":"The transaction identifier associated with the billing.",
            "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
        },
        "ChargePuid":{
            "title":"Charge PUID",
            "type":"string",
            "description":"The charge PUID.",
            "nullable":true
        },
        "ChargeDefinition":{
            "maxLength":30,
            "type":"string",
            "description":"The definition that indicates the purpose of the charge.",
            "nullable":true
        },
        "SentDate":{
            "title":"Sent Date",
            "type":"string",
            "description":"The date invoice information is sent to receivables.",
            "format":"date",
            "nullable":true
        },
        "UsagePricedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether usage line has been priced or not.",
            "nullable":true
        },
        "UsageRatingProcess":{
            "title":"Usage Rating Process",
            "maxLength":30,
            "type":"string",
            "description":"The process used for rating usage.",
            "nullable":true
        },
        "ListPrice":{
            "type":"number",
            "description":"The list price.",
            "nullable":true
        },
        "TransactionTax":{
            "title":"Tax",
            "type":"number",
            "description":"The tax related to 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
        },
        "MilestoneEventPuid":{
            "title":"Milestone Event PUID",
            "type":"string",
            "description":"Milestone Event Puid",
            "nullable":true
        },
        "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 bill line PUID.",
            "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.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-coveredLevels-billLines-billAdjustments-item-post-request"
            }
        },
        "BillingPeriod":{
            "title":"Sequence",
            "type":"number",
            "description":"The billing period.",
            "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.",
            "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 unique identifier of the transaction line.",
            "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 usage capture date.",
            "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.",
            "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 alternate identifier 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":"The unique identifier of the customer transaction type sequence.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TruedUpYn":{
            "maxLength":3,
            "type":"string",
            "description":"Indicates whether the bill line has a true up 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 invoice text of the transaction.",
            "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 charge period.",
            "nullable":true
        },
        "TransactionDate":{
            "title":"Invoice Date",
            "type":"string",
            "description":"The date of the transaction.",
            "format":"date",
            "nullable":true
        },
        "InvoiceBillLineId":{
            "type":"integer",
            "description":"The invoice bill line ID.",
            "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 of the bill.",
            "nullable":true
        },
        "DateBilledTo":{
            "title":"Bill-to Date",
            "type":"string",
            "description":"The date to which the billing is done.",
            "format":"date",
            "nullable":false
        },
        "UsageQuantity":{
            "title":"Usage Quantity",
            "type":"number",
            "description":"The usage quantity.",
            "nullable":true
        },
        "CoveredLevelId":{
            "type":"integer",
            "description":"The unique identifier of the coverage 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 of the transaction.",
            "nullable":true
        },
        "RecurringFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this line is recurring or not.",
            "nullable":false
        },
        "BillLineId":{
            "type":"integer",
            "description":"The unique identifier of the bill line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DateBilledFrom":{
            "title":"Bill-from Date",
            "type":"string",
            "description":"The date from which the billing is done.",
            "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 pricing error.",
            "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.

Show Source

• Array of: object subscriptions-products-coveredLevels-billLines-billAdjustments-item-post-request

{
    "title":"Bill Adjustments",
    "type":"array",
    "description":"The bill adjustments resource is used to view, create, update, and delete the subscription bill adjustment details.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-coveredLevels-billLines-billAdjustments-item-post-request"
    }
}

Nested Schema : subscriptions-products-coveredLevels-billLines-billAdjustments-item-post-request

Type: object

Show Source

• AdjustmentBasis: string
  Title: Basis

  Maximum Length: 30

  The adjustment basis
• AdjustmentName: string
  Title: Adjustment

  Maximum Length: 120

  The adjustment name
• AdjustmentReasonCode: string
  Maximum Length: 30

  The code of the adjustment reason.
• AdjustmentType: string
  Title: Type

  Maximum Length: 30

  The adjustment type
• AdjustmentValue: number
  Title: Value

  The adjustment value
• AutoAdjustmentFlag: boolean
  Maximum Length: 3

  Flag indicating whether the adjustment is automatic or not
• BasisEnableFlag: boolean
  Indicates if the basis has been enabled for the bill.
• BillAdjustmentId: integer (int64)
  The bill adjustment ID
• BillAdjustmentPuid: string
  Maximum Length: 120

  The bill adjustment PUID
• BillLineId: integer (int64)
  The bill line ID
• ChargeAdjustmentId: integer (int64)
  The charge adjustment ID
• ChargeAdjustmentPuid: string
  Title: Charge Adjustment PUID

  Maximum Length: 120

  Charge Adjustment Puid
• CurrencyCode: string
  The currency code. 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.
• Effectivity: string
  Maximum Length: 30

  The adjustment effectivity
• NumberOfPeriods: number
  The number of periods
• PeriodFrom: number
  The period from
• PeriodUntil: number
  The period until
• Reason: string
  Title: Reason Details

  Maximum Length: 120

  The adjustment reason
• 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
• SubscriptionId: integer (int64)
  The subscription ID
• SubscriptionProductId: integer (int64)
  The subscription product ID

{
    "type":"object",
    "properties":{
        "AutoAdjustmentFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Flag indicating whether the adjustment is automatic or not",
            "nullable":false
        },
        "AdjustmentBasis":{
            "title":"Basis",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment basis",
            "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 adjustment reason",
            "nullable":true
        },
        "CurrencyCode":{
            "type":"string",
            "description":"The currency code. 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
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The subscription ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"number",
            "description":"The sequence number",
            "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 subscription product ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "BillAdjustmentPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The bill adjustment PUID",
            "nullable":false
        },
        "PeriodUntil":{
            "type":"number",
            "description":"The period until",
            "nullable":true
        },
        "PeriodFrom":{
            "type":"number",
            "description":"The period from",
            "nullable":true
        },
        "BillAdjustmentId":{
            "type":"integer",
            "description":"The bill adjustment ID",
            "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
        },
        "ChargeAdjustmentPuid":{
            "title":"Charge Adjustment PUID",
            "maxLength":120,
            "type":"string",
            "description":"Charge Adjustment Puid",
            "nullable":true,
            "x-queryable":false
        },
        "ChargeAdjustmentId":{
            "type":"integer",
            "description":"The charge adjustment ID",
            "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 adjustment effectivity",
            "nullable":true
        },
        "AdjustmentType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment type",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AdjustmentValue":{
            "title":"Value",
            "type":"number",
            "description":"The adjustment value",
            "nullable":false
        },
        "BillLineId":{
            "type":"integer",
            "description":"The bill line ID",
            "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 adjustment name",
            "nullable":true
        },
        "BasisEnableFlag":{
            "type":"boolean",
            "description":"Indicates if the basis has been enabled for the bill.",
            "nullable":true
        }
    }
}

Nested Schema : subscriptions-products-coveredLevels-charges-item-post-request

Type: object

Show Source

• adjustments: array Adjustments
  Title: Adjustments

  The adjustments resource is used to view, create, update, and delete any adjustments to the subscription charge.
• AggregationMethod: string
  Title: Aggregation Method

  Maximum Length: 30

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

  The allowance
• 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 bill line ID
• BlockSize: number
  Title: Block Size

  The block size
• chargeComponents: array Subscription Charge Component Records
  Title: Subscription Charge Component Records

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

  Maximum Length: 30

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

  The charge definition name
• ChargeId: integer (int64)
  The charge ID
• 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 charge name
• 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 charge PUID
• chargeTiers: array Charge Tiers
  Title: Charge Tiers

  The charge tiers resource is used to view, create, update, and delete the subscription charge tier details for a subscription.
• 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
• 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
• PricePeriodicity: string
  Title: Periodicity

  Maximum Length: 30

  The price periodicity
• PricePeriodicityName: string
  Title: Periodicity

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

  Maximum Length: 30

  The price type
• 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 charges are rolled up.
• SequenceNumber: integer (int32)
  Title: Sequence Number

  The sequence number
• SubscriptionId: integer (int64)
  Title: Subscription ID

  The subscription ID
• SubscriptionProductId: integer (int64)
  Title: Subscription Product ID

  The subscription product ID
• TieredFlag: boolean
  Title: Tiered

  Maximum Length: 3

  The flag indicating 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 tier type
• TrueUpPeriod: string
  Title: True Up Period

  Maximum Length: 30

  Default Value: ORA_OSS_USAGE_BILLING_PERIOD

  The identifier of the true up period.
• TrueUpPeriodName: string
  Title: True Up Period

  The name of the true up period.
• UnitListPrice: number
  Title: List Price

  The unit list price
• UsagePriceLockFlag: boolean
  Title: Usage Price Lock

  Maximum Length: 3

  Flag indicating 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 charge PUID",
            "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/subscriptions-products-coveredLevels-charges-chargeMilestoneEvents-item-post-request"
            }
        },
        "adjustments":{
            "title":"Adjustments",
            "type":"array",
            "description":"The adjustments resource is used to view, create, update, and delete any adjustments to the subscription charge.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-coveredLevels-charges-adjustments-item-post-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 price periodicity name",
            "nullable":true
        },
        "PrePaymentNumber":{
            "title":"Prepayment Number",
            "type":"integer",
            "description":"The prepayment number",
            "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 unit list price",
            "nullable":true
        },
        "SequenceNumber":{
            "title":"Sequence Number",
            "type":"integer",
            "description":"The sequence number",
            "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 subscription product ID",
            "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":"Subscription Charge Component Records",
            "type":"array",
            "description":"The subscription charge components records resoure is used to view the details of the subscription charge component records.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-coveredLevels-charges-chargeComponents-item-post-request"
            }
        },
        "ChargeName":{
            "title":"Charge Name",
            "maxLength":120,
            "type":"string",
            "description":"The charge name",
            "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":"The flag indicating whether the charge has tiers",
            "nullable":true
        },
        "UsagePriceLockFlag":{
            "title":"Usage Price Lock",
            "maxLength":3,
            "type":"boolean",
            "description":"Flag indicating 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 for a subscription.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-coveredLevels-charges-chargeTiers-item-post-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",
            "nullable":false
        },
        "RollupFlag":{
            "title":"Rollup Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the charges are rolled up.",
            "nullable":true
        },
        "TierType":{
            "title":"Tier Type",
            "maxLength":30,
            "type":"string",
            "description":"The tier type",
            "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 charge definition name",
            "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 subscription ID",
            "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 true up period.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ExternalKey":{
            "title":"External Key",
            "maxLength":120,
            "type":"string",
            "description":"The external key",
            "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",
            "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",
            "nullable":true
        },
        "TrueUpPeriod":{
            "title":"True Up Period",
            "maxLength":30,
            "type":"string",
            "description":"The identifier of the true up period.",
            "nullable":true,
            "default":"ORA_OSS_USAGE_BILLING_PERIOD"
        },
        "BillLineId":{
            "type":"integer",
            "description":"The bill line ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeId":{
            "type":"integer",
            "description":"The charge ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BlockSize":{
            "title":"Block Size",
            "type":"number",
            "description":"The block size",
            "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 any adjustments to the subscription charge.

Show Source

• Array of: object subscriptions-products-coveredLevels-charges-adjustments-item-post-request

{
    "title":"Adjustments",
    "type":"array",
    "description":"The adjustments resource is used to view, create, update, and delete any adjustments to the subscription charge.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-coveredLevels-charges-adjustments-item-post-request"
    }
}

Nested Schema : Subscription Charge Component Records

Type: array

Title: Subscription Charge Component Records

The subscription charge components records resoure is used to view the details of the subscription charge component records.

Show Source

• Array of: object subscriptions-products-coveredLevels-charges-chargeComponents-item-post-request

{
    "title":"Subscription Charge Component Records",
    "type":"array",
    "description":"The subscription charge components records resoure is used to view the details of the subscription charge component records.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-coveredLevels-charges-chargeComponents-item-post-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 subscriptions-products-coveredLevels-charges-chargeMilestoneEvents-item-post-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/subscriptions-products-coveredLevels-charges-chargeMilestoneEvents-item-post-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 for a subscription.

Show Source

• Array of: object subscriptions-products-coveredLevels-charges-chargeTiers-item-post-request

{
    "title":"Charge Tiers",
    "type":"array",
    "description":"The charge tiers resource is used to view, create, update, and delete the subscription charge tier details for a subscription.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-coveredLevels-charges-chargeTiers-item-post-request"
    }
}

Nested Schema : subscriptions-products-coveredLevels-charges-adjustments-item-post-request

Type: object

Show Source

• AdjustmentBasis: string
  Title: Basis

  Maximum Length: 30

  The adjustment basis
• AdjustmentName: string
  Title: Adjustment

  Maximum Length: 120

  The adjustment name
• 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 adjustment type
• AdjustmentValue: number
  Title: Value

  The adjustment value
• AutoAdjustmentFlag: boolean
  Maximum Length: 3

  Flag indicating whether the adjustment is automatic or not
• ChargeAdjustmentId: integer (int64)
  The charge adjustment ID
• ChargeAdjustmentPuid: string
  Maximum Length: 120

  The charge adjustment PUID
• ChargeId: integer (int64)
  The charge ID
• Effectivity: string
  Title: Effectivity

  Maximum Length: 30

  The adjustment effectivity
• NumberOfPeriods: number
  The number of periods
• ObjectVersionNumber: integer (int32)
  Object version number
• PeriodFrom: number
  The period from
• PeriodUntil: number
  The period until
• Reason: string
  Title: Reason Description

  Maximum Length: 120

  The adjustment reason
• SequenceNumber: integer (int32)
  Title: Sequence

  The sequence number
• SubscriptionId: integer (int64)
  The subscription ID
• SubscriptionProductId: integer (int64)
  The subscription product ID

{
    "type":"object",
    "properties":{
        "AutoAdjustmentFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Flag indicating whether the adjustment is automatic or not",
            "nullable":true
        },
        "ChargeAdjustmentPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The charge adjustment PUID",
            "nullable":true
        },
        "AdjustmentBasis":{
            "title":"Basis",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment basis",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChargeAdjustmentId":{
            "type":"integer",
            "description":"The charge adjustment ID",
            "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 adjustment reason",
            "nullable":true
        },
        "AdjustmentType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment type",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The subscription ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AdjustmentValue":{
            "title":"Value",
            "type":"number",
            "description":"The adjustment value",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object version number",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"integer",
            "description":"The sequence number",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "NumberOfPeriods":{
            "type":"number",
            "description":"The number of periods",
            "nullable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The charge ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The subscription product ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PeriodUntil":{
            "type":"number",
            "description":"The period until",
            "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 adjustment name",
            "nullable":true
        },
        "PeriodFrom":{
            "type":"number",
            "description":"The period from",
            "nullable":true
        }
    }
}

Nested Schema : subscriptions-products-coveredLevels-charges-chargeComponents-item-post-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 : subscriptions-products-coveredLevels-charges-chargeMilestoneEvents-item-post-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.
• BillLinePuid: string
  Title: Bill Line PUID

  Maximum Length: 120

  The PUID of the bill line 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.
• 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.
• 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
            }
        },
        "EventId":{
            "type":"integer",
            "description":"The ID of the milestone event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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
            }
        },
        "BillLinePuid":{
            "title":"Bill Line PUID",
            "maxLength":120,
            "type":"string",
            "description":"The PUID of the bill line associated with the milestone event.",
            "nullable":true,
            "x-queryable":false
        },
        "CompletionDate":{
            "type":"string",
            "description":"The completion date of the milestone event.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BillingOffset"
                ]
            }
        }
    }
}

Nested Schema : subscriptions-products-coveredLevels-charges-chargeTiers-item-post-request

Type: object

Show Source

• AdditionalNumberFive: number
  Title: Additional Number Five

  The additional number five
• AdditionalNumberFour: number
  Title: Additional Number Four

  The additional number four
• AdditionalNumberOne: number
  Title: Additional Number One

  The additional number one
• AdditionalNumberSix: number
  Title: Additional Number Six

  The additional number six
• AdditionalNumberThree: number
  Title: Additional Number Three

  The additional number three
• AdditionalNumberTwo: number
  Title: Additional Number Two

  The additional number two
• AdditionalTextOne: string
  Title: Additional Text One

  Maximum Length: 4000

  The additional text one
• AdditionalTextTwo: string
  Title: Additional Text Two

  Maximum Length: 4000

  The additional text two
• AdditionalTimestampOne: string (date-time)
  Title: Additional Time-stamp One

  The additional timestamp one
• AdditionalTimestampThree: string (date-time)
  Title: Additional Time-stamp Three

  The additional timestamp three
• AdditionalTimestampTwo: string (date-time)
  Title: Additional Time-stamp Two

  The additional timestamp two
• AddtionalTextThree: string
  Title: Additional Text Three

  Maximum Length: 4000

  The additional text three
• BlockSize: number
  Title: Block Size

  The block size
• ChargeId: integer (int64)
  The charge ID
• ChargeTierId: integer (int64)
  The charge tier ID
• ChargeTierPuid: string
  Maximum Length: 120

  The charge tier PUID
• ListPrice: number
  Title: List Price

  The list price
• PriceFormat: string
  Title: Price Format

  Maximum Length: 30

  The price format
• SequenceNumber: number
  The sequence number
• SubscriptionId: integer (int64)
  The subscription ID
• SubscriptionProductId: integer (int64)
  The subscription product ID
• TierFrom: number
  Title: Tier From

  The tier from
• TierTo: number
  Title: Tier To

  The tier to

{
    "type":"object",
    "properties":{
        "ChargeTierId":{
            "type":"integer",
            "description":"The charge tier ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AdditionalTimestampTwo":{
            "title":"Additional Time-stamp Two",
            "type":"string",
            "description":"The additional timestamp two",
            "format":"date-time",
            "nullable":true
        },
        "AdditionalNumberFour":{
            "title":"Additional Number Four",
            "type":"number",
            "description":"The additional number four",
            "nullable":true
        },
        "ChargeTierPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The charge tier PUID",
            "nullable":false
        },
        "AdditionalNumberThree":{
            "title":"Additional Number Three",
            "type":"number",
            "description":"The additional number three",
            "nullable":true
        },
        "AdditionalTimestampOne":{
            "title":"Additional Time-stamp One",
            "type":"string",
            "description":"The additional timestamp one",
            "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 price format",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AdditionalTextOne":{
            "title":"Additional Text One",
            "maxLength":4000,
            "type":"string",
            "description":"The additional text one",
            "nullable":true
        },
        "AdditionalNumberFive":{
            "title":"Additional Number Five",
            "type":"number",
            "description":"The additional number five",
            "nullable":true
        },
        "AdditionalNumberSix":{
            "title":"Additional Number Six",
            "type":"number",
            "description":"The additional number six",
            "nullable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The subscription ID",
            "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":"The additional text three",
            "nullable":true
        },
        "AdditionalNumberOne":{
            "title":"Additional Number One",
            "type":"number",
            "description":"The additional number one",
            "nullable":true
        },
        "SequenceNumber":{
            "type":"number",
            "description":"The sequence number",
            "nullable":false
        },
        "AdditionalTextTwo":{
            "title":"Additional Text Two",
            "maxLength":4000,
            "type":"string",
            "description":"The additional text two",
            "nullable":true
        },
        "AdditionalTimestampThree":{
            "title":"Additional Time-stamp Three",
            "type":"string",
            "description":"The additional timestamp three",
            "format":"date-time",
            "nullable":true
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The subscription product ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeId":{
            "type":"integer",
            "description":"The charge ID",
            "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":"The additional number two",
            "nullable":true
        }
    }
}

Nested Schema : subscriptions-products-coveredLevels-childCoveredLevels-item-post-request

Type: object

Show Source

• Address: string
  Title: Address

  The address of the party site associated with child covered level.
• 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 universal serial number associated with the asset.
• BatchTag: string
  Title: Batch Tag

  Maximum Length: 30

  Batch Tag
• CalculatedCreditAmount: number
  Title: Calculated Credit Amount

  The calculated credit amount of the child covered level.
• CalculateEstimatedTaxFlag: boolean
  Indicates whether estimated tax will be calculated for the subscription child covered level.
• CancelDescription: string
  Title: Cancellation Description

  Maximum Length: 2000

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

  The amount that was cancelled.
• CanceledDate: string (date)
  Title: Canceled Date

  The date of cancellation.
• CancelReason: string
  Title: Cancellation Reason

  Maximum Length: 30

  The reason for cancellation.
• ClosedAmount: number
  Title: Closed Amount

  The amount when 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 child covered level.
• CloseReason: string
  Title: Covered Level Close Reason

  Maximum Length: 30

  The reason when the covered level was closed.
• CorpCurrencyCode: string
  Title: Currency Code

  Maximum Length: 15

  The corporate currency code associated with the account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• 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 covered parent for the 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 associated with child covered level.
• CoveredLevlNumber: string
  Title: Covered Level Number

  The alternate identifier of the covered level associated with child covered level.
• CreditedAmount: number
  Title: Credited Amount

  The credited amount for the covered level.
• CreditType: string
  Title: Credit Type

  Maximum Length: 30

  Indicates the type of credit issued to the customer such as negative invoice or credit memo.
• CurcyConvRateType: string
  Title: Conversion Rate Type

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

  Maximum Length: 15

  The currency code. 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 associated with child covered level.
• CustomerName: string
  Title: Customer Account

  The name of the customer associated with child covered level.
• CustomerNumber: string
  Title: Customer Account Number

  The alternate unique identifier of the customer associated with child covered level.
• Description: string
  Title: Covered Level Description

  The description of the covered level.
• Duration: integer
  The duration for which the covered level is active.
• EndDate: string (date)
  Title: Covered Level End Date

  The end date for the covered level.
• ExplodeAssetHierarchy: string
  The explode hierarchy for the asset.
• GenBillSchReqdFlag: boolean
  Title: Billing schedule update required

  Maximum Length: 1

  Generate Bill Schedule Required Flag
• GenerateBillingSchedule: string
  The schedule by the bill is generated.
• HierarchyTotal: number
  The total when the covered level was closed.
• InventoryItemId: integer (int64)
  Title: Item ID

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

  The invoiced amount.
• InvoiceText: string
  Maximum Length: 2000

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

  Maximum Length: 15

  The unit of measure used by the item.
• LineNumber: string
  Title: Number

  Maximum Length: 300

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

  The override credit amount of the child 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 parent level for the level.
• PartyId: integer (int64)
  Title: Party ID

  The unique identifier of the party associated with child covered level.
• PartyName: string
  Title: Party Name

  The name of the party associated with child covered level.
• PartyNumber: string
  Title: Party Number

  The alternate identifier of the party associated with child covered level.
• PartySite: string
  Title: Party Site Number

  The name of the party site associated with child covered level.
• PartySiteId: integer (int64)
  Title: Party Site ID

  The unique identifier of the party site associated with child covered level.
• Period: string
  Maximum Length: 80

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

  The price of the covered level.
• 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 by the item.
• PriceUnitOfMeasureName: string
  Title: Pricing UOM

  The name of the unit of measure.
• PricingError: string
  Title: Pricing Error

  Maximum Length: 1000

  Any errors associated with the pricing.
• 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.
• PutOnHoldFlag: boolean
  Indicates if the covered level has been put on hold.
• Quantity: number
  Title: Quantity

  Default Value: 1

  The quantity for which the bill line was charged.
• RemoveHoldFlag: boolean
  Indicates if the covered level's hold has to be removed.
• RenewalType: string
  Title: Renewal Type

  Maximum Length: 30

  The type of renewal.
• RenewedDate: string (date)
  Title: Renewed On

  The date when the covered level was renewed.
• RepriceFlag: boolean
  Indicates whether the subscription child covered level should be repriced or not. If passed as 'true', the subscription child covered level 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 return method for the credit after the covered level was closed.
• RevenueOption: string
  Title: Revenue Accounting Option

  Maximum Length: 30

  Revenue Option
• RollupTotal: number
  Title: Configured Asset Amount

  The total when the covered level was closed.
• SourceKey: string
  Title: Source Key

  Maximum Length: 120

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

  Maximum Length: 120

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

  Maximum Length: 120

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

  Maximum Length: 120

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

  Maximum Length: 30

  The source system of the child covered level.
• StartDate: string (date)
  Title: Covered Level Start Date

  The start date for the covered level.
• Status: string
  Title: Covered Level Status

  Maximum Length: 30

  The status of the covered level.
• StatusName: string
  Title: Status

  The description of the status.
• SubscriptionId: integer (int64)
  Title: Subscription ID

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

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

  The suppressed amount for the credit.
• SuspendCreditMethod: string
  Title: Suspend Credit Method

  Maximum Length: 30

  The suspend method for the credit after the covered level was closed.
• 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 when the covered level was suspended.
• TaxAmount: number
  Title: Tax Amount

  The amount of tax to be deducted.
• TaxError: string
  Maximum Length: 4000

  The tax error for the covered level.
• TotalContractValue: number
  Title: Covered Level Contract Value

  The total contract value
• Type: string
  Title: Type

  Maximum Length: 30

  The type of the covered level.
• TypeName: string
  Title: Covered Level Type

  The type name associated with the covered level.
• UnitPrice: number
  Title: Unit Price

  The unit price of the covered level associated with child covered level.

{
    "type":"object",
    "properties":{
        "TypeName":{
            "title":"Covered Level Type",
            "type":"string",
            "description":"The type name associated with 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 child covered level.",
            "nullable":true
        },
        "ProductName":{
            "title":"Product Name",
            "type":"string",
            "description":"The name of the product.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "Address":{
            "title":"Address",
            "type":"string",
            "description":"The address of the party site associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "ParentCoveredLevelId":{
            "title":"Parent Covered Level ID",
            "type":"integer",
            "description":"The parent level for the level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PartyName":{
            "title":"Party Name",
            "type":"string",
            "description":"The name of the party associated with child covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "CancelDescription":{
            "title":"Cancellation Description",
            "maxLength":2000,
            "type":"string",
            "description":"The cancel description associated with a child covered level.",
            "nullable":true
        },
        "CurcyConvRateType":{
            "title":"Conversion Rate Type",
            "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
        },
        "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 total when the covered level was closed.",
            "nullable":true
        },
        "SuspendCreditMethod":{
            "title":"Suspend Credit Method",
            "maxLength":30,
            "type":"string",
            "description":"The suspend method for the credit after the covered level was closed.",
            "nullable":true
        },
        "StartDate":{
            "title":"Covered Level Start Date",
            "type":"string",
            "description":"The start date for the covered level.",
            "format":"date",
            "nullable":false
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The currency code. 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
            }
        },
        "TaxAmount":{
            "title":"Tax Amount",
            "type":"number",
            "description":"The amount of tax to be deducted.",
            "nullable":true
        },
        "SourceKey":{
            "title":"Source Key",
            "maxLength":120,
            "type":"string",
            "description":"The source key of the child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CloseReason":{
            "title":"Covered Level Close Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason when 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 associated with child covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "CoveredLevelParentPuid":{
            "type":"string",
            "description":"The covered parent for the parent.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceNumber":{
            "title":"External Source Number",
            "maxLength":120,
            "type":"string",
            "description":"The source number of the child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "PartySiteId":{
            "title":"Party Site ID",
            "type":"integer",
            "description":"The unique identifier of the party site associated with child covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CanceledDate":{
            "title":"Canceled Date",
            "type":"string",
            "description":"The date of cancellation.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ExplodeAssetHierarchy":{
            "type":"string",
            "description":"The explode hierarchy for the asset.",
            "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 account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true
        },
        "ItemUnitOfMeasure":{
            "title":"UOM",
            "maxLength":15,
            "type":"string",
            "description":"The unit of measure used by the item.",
            "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 credited amount for the covered level.",
            "nullable":true
        },
        "Period":{
            "maxLength":80,
            "type":"string",
            "description":"The period during which the covered level is used.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Duration":{
            "type":"integer",
            "description":"The duration for which the covered level is active.",
            "nullable":true,
            "x-queryable":false
        },
        "StatusName":{
            "title":"Status",
            "type":"string",
            "description":"The description of the status.",
            "nullable":true
        },
        "RenewalType":{
            "title":"Renewal Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of 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 universal serial number associated with the asset.",
            "nullable":true
        },
        "CancelReason":{
            "title":"Cancellation Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason for cancellation.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SuppressedCreditAmount":{
            "title":"Suppressed Credit Amount",
            "type":"number",
            "description":"The suppressed amount for the credit.",
            "nullable":true
        },
        "PriceUnitOfMeasureName":{
            "title":"Pricing UOM",
            "type":"string",
            "description":"The 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 return method for the credit after the covered level was closed.",
            "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 invoiced amount.",
            "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 child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CoveredLevlNumber":{
            "title":"Covered Level Number",
            "type":"string",
            "description":"The alternate identifier of the covered level associated with child 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":"The description of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CanceledAmount":{
            "title":"Canceled Amount",
            "type":"number",
            "description":"The amount that was cancelled.",
            "nullable":true
        },
        "PriceAsOf":{
            "title":"Price as of Date",
            "type":"string",
            "description":"The price of the covered level.",
            "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 associated with child covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "InvoiceText":{
            "maxLength":2000,
            "type":"string",
            "description":"The text to be included in the invoice.",
            "nullable":true
        },
        "SubscriptionId":{
            "title":"Subscription ID",
            "type":"integer",
            "description":"The unique identifier of the associated subscription.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CoveredLevelPuid":{
            "title":"Covered Level PUID",
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the covered level.",
            "nullable":false
        },
        "CustomerAccountId":{
            "title":"Customer Account ID",
            "type":"integer",
            "description":"The unique identifier of the customer account associated with child covered level.",
            "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 for the covered level.",
            "nullable":true
        },
        "CustomerName":{
            "title":"Customer Account",
            "type":"string",
            "description":"The name of the customer associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CreditType":{
            "title":"Credit Type",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of credit issued to the customer such as negative invoice or credit memo.",
            "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 child 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 child covered level should be repriced or not. If passed as 'true', the subscription child covered level 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
        },
        "TotalContractValue":{
            "title":"Covered Level Contract Value",
            "type":"number",
            "description":"The total contract value",
            "nullable":true
        },
        "SuspendReason":{
            "title":"Covered Level Suspend Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason when the covered level was suspended.",
            "nullable":true,
            "x-queryable":false
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity for which the bill line was charged.",
            "nullable":false,
            "default":1
        },
        "CoveredLevelId":{
            "title":"Covered Level ID",
            "type":"integer",
            "description":"The unique identifier of the covered level.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PriceUnitOfMeasure":{
            "title":"Pricing UOM",
            "maxLength":30,
            "type":"string",
            "description":"The unit of measure used by the item.",
            "nullable":true
        },
        "HierarchyTotal":{
            "type":"number",
            "description":"The total when the covered level was closed.",
            "nullable":true
        },
        "EndDate":{
            "title":"Covered Level End Date",
            "type":"string",
            "description":"The end date for the covered level.",
            "format":"date",
            "nullable":true
        },
        "ClosedAmount":{
            "title":"Closed Amount",
            "type":"number",
            "description":"The amount when the covered level was closed.",
            "nullable":true
        },
        "CoveredLevlName":{
            "title":"Covered Level Name",
            "type":"string",
            "description":"The name of the covered level associated with child covered level.",
            "nullable":true
        },
        "OverrideCreditAmount":{
            "title":"Override Credit Amount",
            "type":"number",
            "description":"The override credit amount of the child covered level.",
            "nullable":true
        },
        "CalculateEstimatedTaxFlag":{
            "type":"boolean",
            "description":"Indicates whether estimated tax will be calculated for the subscription child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "Type":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the covered level.",
            "nullable":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 associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "UnitPrice":{
            "title":"Unit Price",
            "type":"number",
            "description":"The unit price of the covered level associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "GenerateBillingSchedule":{
            "type":"string",
            "description":"The schedule by the bill is generated.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the party associated with child covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RemoveHoldFlag":{
            "type":"boolean",
            "description":"Indicates if the covered level's hold 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":"Any errors associated with the pricing.",
            "nullable":true
        },
        "CloseDescription":{
            "title":"Covered Level Close Description",
            "maxLength":2000,
            "type":"string",
            "description":"The close description associated with a child covered level.",
            "nullable":true
        },
        "SourceSystem":{
            "title":"External Source System",
            "maxLength":30,
            "type":"string",
            "description":"The source system of the child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "BatchTag":{
            "title":"Batch Tag",
            "maxLength":30,
            "type":"string",
            "description":"Batch Tag",
            "nullable":true
        }
    }
}

Nested Schema : subscriptions-products-coveredLevels-productAssetRelationships-item-post-request

Type: object

Show Source

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

Nested Schema : schema

Type: object

Show Source

• OperationLinksPuid: string
  Title: Operation Links PUID

  Maximum Length: 120

  The operation links PUID.
• RelationshipTypeCode: string
  Title: Type

  Maximum Length: 30

  The relationship type code.
• 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 source product association PUID.
• SourceProductPuid: string
  Title: Source Product PUID

  Maximum Length: 120

  The source product PUID.
• 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 target product association PUID.
• TargetProductPuid: string
  Title: Target Product PUID

  Maximum Length: 120

  The target product PUID.

{
    "type":"object",
    "properties":{
        "RelationshipTypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The relationship type code.",
            "nullable":false
        },
        "OperationLinksPuid":{
            "title":"Operation Links PUID",
            "maxLength":120,
            "type":"string",
            "description":"The operation links PUID.",
            "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 source product PUID.",
            "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 source product association PUID.",
            "nullable":true
        },
        "TargetProductPuid":{
            "title":"Target Product PUID",
            "maxLength":120,
            "type":"string",
            "description":"The target product PUID.",
            "nullable":true
        },
        "TargetProdAssociationPuid":{
            "title":"Target Product Association PUID",
            "maxLength":120,
            "type":"string",
            "description":"The target product association PUID.",
            "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.
• CreditCardId: integer (int64)
  The unique identifier of the credit card.
• CreditCardPuid: string
  Maximum Length: 120

  The credit card PUID.
• 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 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 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 credit card PUID.",
            "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 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
        },
        "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"
            }
        },
        "Notes":{
            "title":"Notes",
            "maxLength":300,
            "type":"string",
            "description":"The notes associated with the credit card.",
            "nullable":true
        }
    }
}

Nested Schema : schema

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 : schema

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.
• 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.
• 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
            }
        },
        "EntitlementPlanCommitmentId":{
            "type":"integer",
            "description":"The unique identifier of subscription entitlement plan commitments.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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
        },
        "EntitlementPlanCommitmentNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The unique number of subscription entitlement plan commitments.",
            "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 : subscriptions-products-negotiatedEntitlementPlanDetails-item-post-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 charge definition code under subscription entitlement plan details.
• ChargeDefinitionId: integer (int64)
  The unique identifier for charge definition 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.
• EntitlementPlanDetailId: integer (int64)
  The unique identifier of subscription entitlement plan details.
• EntitlementPlanDetailNumber: string
  Maximum Length: 120

  The unique number of subscription entitlement plan details.
• 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 charge definition code under subscription entitlement plan details.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "EntitlementPlanDetailNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The unique number of subscription entitlement plan details.",
            "nullable":false
        },
        "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 unique identifier for charge definition under subscription entitlement plan details.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EntitlementPlanDetailId":{
            "type":"integer",
            "description":"The unique identifier of subscription entitlement plan details.",
            "format":"int64",
            "nullable":false,
            "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 : schema

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 whether 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.
• 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 of allowance 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
        },
        "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
        },
        "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
            }
        },
        "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
            }
        },
        "EntitlementPlanEstimateId":{
            "type":"integer",
            "description":"The unique identifier of subscription entitlement plan estimates.",
            "format":"int64",
            "nullable":false,
            "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
            }
        },
        "EnableRolloverFlag":{
            "title":"Enable rollover",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether 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 of allowance 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
        },
        "EntitlementPlanEstimateNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The alternate unique number of subscription entitlement plan estimates.",
            "nullable":false
        },
        "EntitlementPlanId":{
            "type":"integer",
            "description":"The unique identifier of subscription entitlement plan.",
            "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
            }
        }
    }
}

Nested Schema : schema

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 : subscriptions-products-productRelationships-item-post-request

Type: object

Show Source

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

Nested Schema : subscriptions-products-relationships-item-post-request

Type: object

Show Source

• OperationLinksPuid: string
  Title: Operation Links PUID

  Maximum Length: 120

  The operation links PUID.
• RelationshipTypeCode: string
  Title: Type

  Maximum Length: 30

  The relationship type code.
• 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 source product association PUID.
• SourceProductPuid: string
  Title: Source Product PUID

  Maximum Length: 120

  The source product PUID.
• 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 target product association PUID.
• TargetProductPuid: string
  Title: Target Product PUID

  Maximum Length: 120

  The target product PUID.

{
    "type":"object",
    "properties":{
        "RelationshipTypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The relationship type code.",
            "nullable":false
        },
        "OperationLinksPuid":{
            "title":"Operation Links PUID",
            "maxLength":120,
            "type":"string",
            "description":"The operation links PUID.",
            "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 source product PUID.",
            "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 source product association PUID.",
            "nullable":true
        },
        "TargetProductPuid":{
            "title":"Target Product PUID",
            "maxLength":120,
            "type":"string",
            "description":"The target product PUID.",
            "nullable":true
        },
        "TargetProdAssociationPuid":{
            "title":"Target Product Association PUID",
            "maxLength":120,
            "type":"string",
            "description":"The target product association PUID.",
            "nullable":true
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• EndDate: string (date)
  Title: End Date

  The date when the credit card becomes invalid.
• Percentage: number
  Title: Percent

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

  Maximum Length: 120

  The sales credit PUID.
• SalesCreditType: string
  The sales credit type.
• SalesCreditTypeId: integer (int64)
  Title: Credit Type

  The unique identifier of the sales credit type.
• SalesPerson: string
  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 starts.
• SubscriptionId: integer (int64)
  The unique identifier of the subscription.
• SubscriptionProductId: integer (int64)
  Title: Subscription Product ID

  The subscription product ID.

{
    "type":"object",
    "properties":{
        "Percentage":{
            "title":"Percent",
            "type":"number",
            "description":"The percentage of sales credit.",
            "nullable":false,
            "x-hints":{
                "precision":5,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "scale":2
            }
        },
        "SalesPerson":{
            "type":"string",
            "description":"The sales person.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "SalesCreditTypeId":{
            "title":"Credit Type",
            "type":"integer",
            "description":"The unique identifier of the sales credit type.",
            "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
            }
        },
        "SalesCreditType":{
            "type":"string",
            "description":"The sales credit type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the credit card becomes invalid.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the sales credit starts.",
            "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"
            }
        },
        "SalesCreditPuid":{
            "title":"Number",
            "maxLength":120,
            "type":"string",
            "description":"The sales credit PUID.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_FORCE_WRITE":"true",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "SubscriptionProductId":{
            "title":"Subscription Product ID",
            "type":"integer",
            "description":"The subscription product ID.",
            "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"
            }
        },
        "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 : subscriptions-products-serviceResources-item-post-request

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 : subscriptions-products-smartActions-item-post-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(required): 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.
• UserActionId: integer (int64)
  Title: User Action ID

  The unique identifier of the subscription user actions.
• UserActionName(required): string
  Title: Action Name

  Maximum Length: 256

  The name of the subscription user 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.

{
    "required":[
        "DisplayLabel",
        "UserActionName"
    ],
    "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/subscriptions-products-smartActions-UserActionURLBinding-item-post-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/subscriptions-products-smartActions-UserActionNavigation-item-post-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
        },
        "UserActionName":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"The name of the subscription user actions.",
            "nullable":false
        },
        "UserActionId":{
            "title":"User Action ID",
            "type":"integer",
            "description":"The unique identifier of the subscription user actions.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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/subscriptions-products-smartActions-UserActionRequestPayload-item-post-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 subscriptions-products-smartActions-UserActionNavigation-item-post-request

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"UI navigation metadata striped by app usage.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-smartActions-UserActionNavigation-item-post-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 subscriptions-products-smartActions-UserActionRequestPayload-item-post-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/subscriptions-products-smartActions-UserActionRequestPayload-item-post-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 subscriptions-products-smartActions-UserActionURLBinding-item-post-request

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

Nested Schema : subscriptions-products-smartActions-UserActionNavigation-item-post-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.
• 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":{
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The system action flag of the user action navigation.",
            "nullable":true,
            "default":false
        },
        "UserActionNavId":{
            "title":"Primary Key",
            "type":"integer",
            "description":"The unique identifier of the subscription user action navigation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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 : subscriptions-products-smartActions-UserActionRequestPayload-item-post-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.
• 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
        },
        "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
        },
        "RequestPayloadId":{
            "type":"integer",
            "description":"The request payload ID of the user action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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 : subscriptions-products-smartActions-UserActionURLBinding-item-post-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.
• 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
        },
        "Value":{
            "title":"URL Binding Parameter Value",
            "maxLength":1000,
            "type":"string",
            "description":"The value of URL binding of user action.",
            "nullable":true
        },
        "URLBindingId":{
            "type":"integer",
            "description":"The identifier of URL binding of user action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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
        }
    }
}

Nested Schema : subscriptions-salesCredits-item-post-request

Type: object

Show Source

• EndDate: string (date)
  Title: End Date

  The date when the credit card becomes invalid.
• Percentage: number
  Title: Percent

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

  Maximum Length: 120

  The sales credit PUID.
• SalesCreditType: string
  The sales credit type.
• SalesCreditTypeId: integer (int64)
  Title: Credit Type

  The unique identifier of the sales credit type.
• SalesPerson: string
  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 starts.
• SubscriptionId: integer (int64)
  The unique identifier of the subscription.
• SubscriptionProductId: integer (int64)
  Title: Subscription Product ID

  The subscription product ID.

{
    "type":"object",
    "properties":{
        "Percentage":{
            "title":"Percent",
            "type":"number",
            "description":"The percentage of sales credit.",
            "nullable":false,
            "x-hints":{
                "precision":5,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "scale":2
            }
        },
        "SalesPerson":{
            "type":"string",
            "description":"The sales person.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "SalesCreditTypeId":{
            "title":"Credit Type",
            "type":"integer",
            "description":"The unique identifier of the sales credit type.",
            "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
            }
        },
        "SalesCreditType":{
            "type":"string",
            "description":"The sales credit type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the credit card becomes invalid.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the sales credit starts.",
            "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"
            }
        },
        "SalesCreditPuid":{
            "title":"Number",
            "maxLength":120,
            "type":"string",
            "description":"The sales credit PUID.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_FORCE_WRITE":"true",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "SubscriptionProductId":{
            "title":"Subscription Product ID",
            "type":"integer",
            "description":"The subscription product ID.",
            "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"
            }
        },
        "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 : subscriptions-smartActions-item-post-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(required): 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.
• UserActionId: integer (int64)
  Title: User Action ID

  The unique identifier of the subscription user actions.
• UserActionName(required): string
  Title: Action Name

  Maximum Length: 256

  The name of the subscription user 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.

{
    "required":[
        "DisplayLabel",
        "UserActionName"
    ],
    "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/subscriptions-smartActions-UserActionURLBinding-item-post-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/subscriptions-smartActions-UserActionNavigation-item-post-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
        },
        "UserActionName":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"The name of the subscription user actions.",
            "nullable":false
        },
        "UserActionId":{
            "title":"User Action ID",
            "type":"integer",
            "description":"The unique identifier of the subscription user actions.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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/subscriptions-smartActions-UserActionRequestPayload-item-post-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 subscriptions-smartActions-UserActionNavigation-item-post-request

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"UI navigation metadata striped by app usage.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-smartActions-UserActionNavigation-item-post-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 subscriptions-smartActions-UserActionRequestPayload-item-post-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/subscriptions-smartActions-UserActionRequestPayload-item-post-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 subscriptions-smartActions-UserActionURLBinding-item-post-request

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

Nested Schema : subscriptions-smartActions-UserActionNavigation-item-post-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.
• 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":{
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The system action flag of the user action navigation.",
            "nullable":true,
            "default":false
        },
        "UserActionNavId":{
            "title":"Primary Key",
            "type":"integer",
            "description":"The unique identifier of the subscription user action navigation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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 : subscriptions-smartActions-UserActionRequestPayload-item-post-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.
• 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
        },
        "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
        },
        "RequestPayloadId":{
            "type":"integer",
            "description":"The request payload ID of the user action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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 : subscriptions-smartActions-UserActionURLBinding-item-post-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.
• 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
        },
        "Value":{
            "title":"URL Binding Parameter Value",
            "maxLength":1000,
            "type":"string",
            "description":"The value of URL binding of user action.",
            "nullable":true
        },
        "URLBindingId":{
            "type":"integer",
            "description":"The identifier of URL binding of user action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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
        }
    }
}

Nested Schema : subscriptions-subscriptionContact-item-post-request

Type: object

Show Source

• AccessLevel: string
  Maximum Length: 302

  The access level of the contact.
• BillingOwnerFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether this contact is a billing owner or not.
• ContactEmail: string
  Title: Email

  The email address of the contact.
• ContactId(required): integer (int64)
  The unique identifier of the contact.
• ContactName: string
  Title: Name

  The contact name.
• ContactNumber: string
  Title: Party Contact Number

  The number of the subscription contact.
• ContactPuid(required): string
  Maximum Length: 120

  The PUID of the subscription contact.
• ContactRole(required): string
  Title: Role

  Maximum Length: 30

  The contact role of the subscription contact.
• EndDate: string (date)
  The end date of the contact.
• InternalFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether this contact is internal or not.
• OwnerFlag: boolean
  Title: Owner

  Maximum Length: 1

  Default Value: false

  Indicates whether the contact is the owner.
• PartyId: integer
  The unique identifier of the party.
• PartyNumber: string
  Title: Party Number

  Maximum Length: 120

  The number of the party to which the contact belongs.
• PartyPuid: string
  Title: Party Number

  Maximum Length: 120

  The party PUID of the contact.
• PartyRole: string
  Title: Role

  Maximum Length: 20

  The party role of the contact.
• smartActions: array Subscription User Actions
  Title: Subscription User Actions

  The smart actions resource stores the endpoint and security details for every user action.
• StartDate: string (date)
  The start date of the contact.
• SubscriptionContactId: integer (int64)
  The unique identifier of the subscription contact.
• SubscriptionId(required): integer (int64)
  The unique identifier of the subscription.
• SubscriptionNumber: string
  Title: Subscription Number

  Maximum Length: 120

  The subscription number to which the contact belongs.
• SubscriptionPartyId(required): integer (int64)
  The unique identifier of the subscription party.

{
    "required":[
        "ContactId",
        "ContactPuid",
        "ContactRole",
        "SubscriptionId",
        "SubscriptionPartyId"
    ],
    "type":"object",
    "properties":{
        "PartyRole":{
            "title":"Role",
            "maxLength":20,
            "type":"string",
            "description":"The party role of the contact.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionNumber":{
            "title":"Subscription Number",
            "maxLength":120,
            "type":"string",
            "description":"The subscription number to which the contact belongs.",
            "nullable":true,
            "x-queryable":false
        },
        "OwnerFlag":{
            "title":"Owner",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the contact is the owner.",
            "nullable":true,
            "default":false
        },
        "InternalFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this contact is internal or not.",
            "nullable":true,
            "default":false
        },
        "SubscriptionPartyId":{
            "type":"integer",
            "description":"The unique identifier of the subscription party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "ContactId":{
            "type":"integer",
            "description":"The unique identifier of the contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EndDate":{
            "type":"string",
            "description":"The end date of the contact.",
            "format":"date",
            "nullable":true
        },
        "ContactRole":{
            "title":"Role",
            "maxLength":30,
            "type":"string",
            "description":"The contact role of the subscription contact.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AccessLevel":{
            "maxLength":302,
            "type":"string",
            "description":"The access level of the contact.",
            "nullable":true
        },
        "smartActions":{
            "title":"Subscription User Actions",
            "type":"array",
            "description":"The smart actions resource stores the endpoint and security details for every user action.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-subscriptionContact-smartActions-item-post-request"
            }
        },
        "StartDate":{
            "type":"string",
            "description":"The start date of the contact.",
            "format":"date",
            "nullable":true
        },
        "PartyNumber":{
            "title":"Party Number",
            "maxLength":120,
            "type":"string",
            "description":"The number of the party to which the contact belongs.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party.",
            "nullable":true,
            "x-queryable":false
        },
        "ContactPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The PUID of the subscription contact.",
            "nullable":false
        },
        "ContactEmail":{
            "title":"Email",
            "type":"string",
            "description":"The email address of the contact.",
            "nullable":true
        },
        "ContactNumber":{
            "title":"Party Contact Number",
            "type":"string",
            "description":"The number of the subscription contact.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "sortable":false
            }
        },
        "PartyPuid":{
            "title":"Party Number",
            "maxLength":120,
            "type":"string",
            "description":"The party PUID of the contact.",
            "nullable":true
        },
        "BillingOwnerFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this contact is a billing owner or not.",
            "nullable":true,
            "default":false
        },
        "ContactName":{
            "title":"Name",
            "type":"string",
            "description":"The contact name.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "SubscriptionContactId":{
            "type":"integer",
            "description":"The unique identifier of the subscription contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : Subscription User Actions

Type: array

Title: Subscription User Actions

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

Show Source

• Array of: object subscriptions-subscriptionContact-smartActions-item-post-request

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

Nested Schema : subscriptions-subscriptionContact-smartActions-item-post-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(required): 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.
• UserActionId: integer (int64)
  Title: User Action ID

  The unique identifier of the subscription user actions.
• UserActionName(required): string
  Title: Action Name

  Maximum Length: 256

  The name of the subscription user 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.

{
    "required":[
        "DisplayLabel",
        "UserActionName"
    ],
    "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/subscriptions-subscriptionContact-smartActions-UserActionURLBinding-item-post-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/subscriptions-subscriptionContact-smartActions-UserActionNavigation-item-post-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
        },
        "UserActionName":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"The name of the subscription user actions.",
            "nullable":false
        },
        "UserActionId":{
            "title":"User Action ID",
            "type":"integer",
            "description":"The unique identifier of the subscription user actions.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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/subscriptions-subscriptionContact-smartActions-UserActionRequestPayload-item-post-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 subscriptions-subscriptionContact-smartActions-UserActionNavigation-item-post-request

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"UI navigation metadata striped by app usage.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-subscriptionContact-smartActions-UserActionNavigation-item-post-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 subscriptions-subscriptionContact-smartActions-UserActionRequestPayload-item-post-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/subscriptions-subscriptionContact-smartActions-UserActionRequestPayload-item-post-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 subscriptions-subscriptionContact-smartActions-UserActionURLBinding-item-post-request

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

Nested Schema : subscriptions-subscriptionContact-smartActions-UserActionNavigation-item-post-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.
• 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":{
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The system action flag of the user action navigation.",
            "nullable":true,
            "default":false
        },
        "UserActionNavId":{
            "title":"Primary Key",
            "type":"integer",
            "description":"The unique identifier of the subscription user action navigation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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 : subscriptions-subscriptionContact-smartActions-UserActionRequestPayload-item-post-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.
• 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
        },
        "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
        },
        "RequestPayloadId":{
            "type":"integer",
            "description":"The request payload ID of the user action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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 : subscriptions-subscriptionContact-smartActions-UserActionURLBinding-item-post-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.
• 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
        },
        "Value":{
            "title":"URL Binding Parameter Value",
            "maxLength":1000,
            "type":"string",
            "description":"The value of URL binding of user action.",
            "nullable":true
        },
        "URLBindingId":{
            "type":"integer",
            "description":"The identifier of URL binding of user action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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
        }
    }
}

Nested Schema : subscriptions-subscriptionTeam-item-post-request

Type: object

Show Source

• AccessLevel: string
  Maximum Length: 302

  The access level of the contact.
• BillingOwnerFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether this contact is a billing owner or not.
• ContactEmail: string
  Title: Email

  The email address of the contact.
• ContactId(required): integer (int64)
  The unique identifier of the contact.
• ContactName: string
  Title: Name

  The contact name.
• ContactNumber: string
  Title: Party Contact Number

  The number of the subscription contact.
• ContactPuid(required): string
  Maximum Length: 120

  The PUID of the subscription contact.
• ContactRole(required): string
  Title: Role

  Maximum Length: 30

  The contact role of the subscription contact.
• EndDate: string (date)
  The end date of the contact.
• InternalFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether this contact is internal or not.
• OwnerFlag: boolean
  Title: Owner

  Maximum Length: 1

  Default Value: false

  Indicates whether the contact is the owner.
• PartyId: integer
  The unique identifier of the party.
• PartyNumber: string
  Title: Party Number

  Maximum Length: 120

  The number of the party to which the contact belongs.
• PartyPuid: string
  Title: Party Number

  Maximum Length: 120

  The party PUID of the contact.
• PartyRole: string
  Title: Role

  Maximum Length: 20

  The party role of the contact.
• smartActions: array Subscription User Actions
  Title: Subscription User Actions

  The smart actions resource stores the endpoint and security details for every user action.
• StartDate: string (date)
  The start date of the contact.
• SubscriptionContactId: integer (int64)
  The unique identifier of the subscription contact.
• SubscriptionId(required): integer (int64)
  The unique identifier of the subscription.
• SubscriptionNumber: string
  Title: Subscription Number

  Maximum Length: 120

  The subscription number to which the contact belongs.
• SubscriptionPartyId(required): integer (int64)
  The unique identifier of the subscription party.

{
    "required":[
        "ContactId",
        "ContactPuid",
        "ContactRole",
        "SubscriptionId",
        "SubscriptionPartyId"
    ],
    "type":"object",
    "properties":{
        "PartyRole":{
            "title":"Role",
            "maxLength":20,
            "type":"string",
            "description":"The party role of the contact.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionNumber":{
            "title":"Subscription Number",
            "maxLength":120,
            "type":"string",
            "description":"The subscription number to which the contact belongs.",
            "nullable":true,
            "x-queryable":false
        },
        "OwnerFlag":{
            "title":"Owner",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the contact is the owner.",
            "nullable":true,
            "default":false
        },
        "InternalFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this contact is internal or not.",
            "nullable":true,
            "default":false
        },
        "SubscriptionPartyId":{
            "type":"integer",
            "description":"The unique identifier of the subscription party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ContactId":{
            "type":"integer",
            "description":"The unique identifier of the contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EndDate":{
            "type":"string",
            "description":"The end date of the contact.",
            "format":"date",
            "nullable":true
        },
        "ContactRole":{
            "title":"Role",
            "maxLength":30,
            "type":"string",
            "description":"The contact role of the subscription contact.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AccessLevel":{
            "maxLength":302,
            "type":"string",
            "description":"The access level of the contact.",
            "nullable":true
        },
        "smartActions":{
            "title":"Subscription User Actions",
            "type":"array",
            "description":"The smart actions resource stores the endpoint and security details for every user action.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-subscriptionTeam-smartActions-item-post-request"
            }
        },
        "StartDate":{
            "type":"string",
            "description":"The start date of the contact.",
            "format":"date",
            "nullable":true
        },
        "PartyNumber":{
            "title":"Party Number",
            "maxLength":120,
            "type":"string",
            "description":"The number of the party to which the contact belongs.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party.",
            "nullable":true,
            "x-queryable":false
        },
        "ContactPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The PUID of the subscription contact.",
            "nullable":false
        },
        "ContactEmail":{
            "title":"Email",
            "type":"string",
            "description":"The email address of the contact.",
            "nullable":true
        },
        "ContactNumber":{
            "title":"Party Contact Number",
            "type":"string",
            "description":"The number of the subscription contact.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "sortable":false
            }
        },
        "PartyPuid":{
            "title":"Party Number",
            "maxLength":120,
            "type":"string",
            "description":"The party PUID of the contact.",
            "nullable":true
        },
        "BillingOwnerFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this contact is a billing owner or not.",
            "nullable":true,
            "default":false
        },
        "ContactName":{
            "title":"Name",
            "type":"string",
            "description":"The contact name.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "SubscriptionContactId":{
            "type":"integer",
            "description":"The unique identifier of the subscription contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : Subscription User Actions

Type: array

Title: Subscription User Actions

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

Show Source

• Array of: object subscriptions-subscriptionTeam-smartActions-item-post-request

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

Nested Schema : subscriptions-subscriptionTeam-smartActions-item-post-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(required): 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.
• UserActionId: integer (int64)
  Title: User Action ID

  The unique identifier of the subscription user actions.
• UserActionName(required): string
  Title: Action Name

  Maximum Length: 256

  The name of the subscription user 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.

{
    "required":[
        "DisplayLabel",
        "UserActionName"
    ],
    "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/subscriptions-subscriptionTeam-smartActions-UserActionURLBinding-item-post-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/subscriptions-subscriptionTeam-smartActions-UserActionNavigation-item-post-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
        },
        "UserActionName":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"The name of the subscription user actions.",
            "nullable":false
        },
        "UserActionId":{
            "title":"User Action ID",
            "type":"integer",
            "description":"The unique identifier of the subscription user actions.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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/subscriptions-subscriptionTeam-smartActions-UserActionRequestPayload-item-post-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 subscriptions-subscriptionTeam-smartActions-UserActionNavigation-item-post-request

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"UI navigation metadata striped by app usage.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-subscriptionTeam-smartActions-UserActionNavigation-item-post-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 subscriptions-subscriptionTeam-smartActions-UserActionRequestPayload-item-post-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/subscriptions-subscriptionTeam-smartActions-UserActionRequestPayload-item-post-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 subscriptions-subscriptionTeam-smartActions-UserActionURLBinding-item-post-request

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

Nested Schema : subscriptions-subscriptionTeam-smartActions-UserActionNavigation-item-post-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.
• 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":{
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The system action flag of the user action navigation.",
            "nullable":true,
            "default":false
        },
        "UserActionNavId":{
            "title":"Primary Key",
            "type":"integer",
            "description":"The unique identifier of the subscription user action navigation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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 : subscriptions-subscriptionTeam-smartActions-UserActionRequestPayload-item-post-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.
• 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
        },
        "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
        },
        "RequestPayloadId":{
            "type":"integer",
            "description":"The request payload ID of the user action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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 : subscriptions-subscriptionTeam-smartActions-UserActionURLBinding-item-post-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.
• 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
        },
        "Value":{
            "title":"URL Binding Parameter Value",
            "maxLength":1000,
            "type":"string",
            "description":"The value of URL binding of user action.",
            "nullable":true
        },
        "URLBindingId":{
            "type":"integer",
            "description":"The identifier of URL binding of user action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• ErrorSeverity: string
  Maximum Length: 30

  The severity of the error.
• MessageText: string
  Maximum Length: 4000

  The error message text.
• ObjectId: integer (int64)
  The unique identifier of the object.
• ObjectName: string
  Maximum Length: 1000

  The name of the object.
• ObjectType: string
  Maximum Length: 30

  The object type.
• ObjectVersionNumber: integer (int32)
  The object version number.
• SubscriptionNumber: string
  Maximum Length: 120

  The subscription number.

{
    "type":"object",
    "properties":{
        "ObjectType":{
            "maxLength":30,
            "type":"string",
            "description":"The object type.",
            "nullable":false
        },
        "SubscriptionNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The subscription number.",
            "nullable":true
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique identifier of the object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "ErrorSeverity":{
            "maxLength":30,
            "type":"string",
            "description":"The severity of the error.",
            "nullable":false
        },
        "MessageText":{
            "maxLength":4000,
            "type":"string",
            "description":"The error message text.",
            "nullable":true
        },
        "ObjectName":{
            "maxLength":1000,
            "type":"string",
            "description":"The name of the object.",
            "nullable":true
        }
    }
}

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 : subscriptions-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.
• ApprovalNote: string
  Title: Approval Note

  Maximum Length: 240

  The approval note.
• ApprovedDate: string (date)
  Title: Approved Date

  The date on which the subscription was approved.
• AssigneeId: integer (int64)
  Title: Assignee ID

  The unique identifier of the assignee.
• AssigneeType: string
  Title: Assignee Type

  Maximum Length: 30

  The assignee type.
• AsyncFlag: boolean
  Read Only: true

  Indicates whether the subscription will undergo asynchronous process for operations such as duplicate, generate billing schedule etc.
• AttachmentEntityName: string
  Maximum Length: 255

  Default Value: OSS_DOC_SUBSCRIPTION_AGREEMENT

  The name of the attachment entity.
• AttachmentEntityName1: string
  Default Value: OSS_DOC_SUPPORTING_DOCUMENTS

  The name of the attachment entity.
• BatchTag: string
  Title: Batch Tag

  Maximum Length: 30

  Batch Tag
• BillingDateCode: string
  Title: Billing Date

  Maximum Length: 30

  The code of the billing date.
• BillingDateName: string
  Title: Billing Date Name

  The name of the billing date.
• BillingFrequency: string
  Title: Billing Frequency

  Maximum Length: 30

  The billing frequency code.
• BillingFrequencyName: string
  Title: Billing Frequency

  The billing frequency name.
• BillingOffsetDays: integer (int64)
  Title: Offset

  The days of offset billing.
• BillingSystem: string
  Title: Billing System

  Maximum Length: 120

  The billing system.
• BillOnDay: number
  Title: Bill on Day

  The day of the bill.
• BillService: string
  Title: Bill Service

  Maximum Length: 30

  The bill service code. Values could be ORA_DO_NOT_BILL, ORA_BILL or ORA_BILL_ON_RENEWAL.
• BillServiceName: string
  Title: Bill Service Name

  The bill service option. Values could be no bill, bill or bill on renewal.
• BillToAccountDescription: string
  The 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 alternate identifier of the bill-to account.
• BillToAddress: string
  Title: Bill-to Address

  The address to which the bill is to be sent.
• BillToContactId: integer (int64)
  Title: Bill-to Contact ID

  The bill-to contact of the subscription.
• BillToContactName: string
  Title: Bill-to Contact

  The bill-to contact name of the subscription.
• BillToContactNumber: string
  Title: Bill-to Contact Number

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

  The bill-to customer ID of the subscription.
• BillToPartyName: string
  Title: Bill-to Customer

  Maximum Length: 360

  The bill-to customer name of the subscription.
• BillToPartyNumber: string
  Title: Bill-to Party Number

  Read Only: true

  Maximum Length: 30

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

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

  Maximum Length: 255

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

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

  The unique identifier of the bill-to site use.
• BusinessUnitId: integer (int64)
  Title: BU ID

  The unique identifier of the business unit.
• BusinessUnitName: string
  Title: BU Name

  The name of the business unit.
• CalculatedCreditAmount: number
  Title: Calculated Credit Amount

  The calculated credit amount of the subscription.
• CalculateEstimatedTaxFlag: boolean
  Indicates whether estimated tax will be calculated for the subscription.
• CancelDescription: string
  Title: Cancellation Description

  Maximum Length: 2000

  The cancel reason description of the subscription.
• CanceledAmount: number
  Title: Canceled Amount

  The canceled amount.
• CanceledDate: string (date)
  Title: Canceled Date

  The date on which the subscription was canceled.
• CancelReason: string
  Title: Cancellation Reason

  Maximum Length: 30

  The reason of cancelling the subscription.
• CheckRenewFlag: string
  Read Only: true

  Maximum Length: 255

  Indicates whether the renewal should be checked for the subscription.
• CloseCreditMethod: string
  Title: Close Credit Method

  Maximum Length: 30

  The close credit method.
• ClosedAmount: number
  Title: Closed Amount

  The closed amount.
• ClosedDate: string (date)
  Title: Closed Date

  The date on which the subscription was closed.
• CloseDescription: string
  Title: Close Description

  Maximum Length: 2000

  The close reason description of the subscription.
• CloseReason: string
  Title: Close Reason

  Maximum Length: 30

  The reason to close the subscription.
• CommunicationChannel: string
  Title: Communication Channel

  Maximum Length: 30

  The communication channel.
• ContactRelationshipId: integer
  Contact Relationship Id
• contractAttachment: array Contract Attachments
  Title: Contract Attachments

  The contract attachments resource is used to view, create, and update attachments.
• CorpCurrencyCode: string
  Title: Currency Code

  Maximum Length: 15

  The corporate currency code.
• CoverageInvoiceText: string
  Title: Coverage Invoice Text

  Maximum Length: 4000

  The charge invoice text.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the subscription.
• 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 card information associated with a subscription.
• CreditedAmount: number
  Title: Credited Amount

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

  Maximum Length: 30

  Indicates the type of credit issued to the customer such as negative invoice or credit memo.
• CurcyConvRateType: string
  Title: Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type.
• Currency: string
  Title: Currency

  Maximum Length: 15

  The subscription currency.
• CurrencyConversionRate: string
  Title: Conversion Rate

  Maximum Length: 30

  The currency conversion rate.
• CurrencyConversionRateDate: string (date)
  Title: Conversion Rate Date

  The currency conversion rate date.
• CurrencyConversionRateType: string
  Title: Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type.
• CurrencyName: string
  Title: Currency

  The name of subscription currency.
• CustomerAcceptance: string
  Title: Customer Acceptance

  Maximum Length: 30

  The customer acceptance.
• CustomerContactName: string
  Title: Contact Name

  Customer Contact Name
• CustomerTrxTypeSequenceId: integer (int64)
  Title: Sequence

  The unique identifier of the customer transaction type sequence.
• DaysBeforeExpiry: integer (int64)
  Title: Days Before Expiration

  The number of days before expiry.
• DaysBeforeExpiryUsed: string
  Title: Used Days Before Expiry

  Maximum Length: 18

  The days before expiry used.
• DefaultLanguage: string
  The default language.
• DefaultRevenueAction: string
  Maximum Length: 255

  The default revenue action to be taken for the subscription.
• DefinitionOrganizationCode: string
  Title: Item Master Organization Code

  The inventory organization code of the subscription.
• DefinitionOrganizationId: integer (int64)
  Title: Subscription Inventory Organization

  The unique identifier of the master organization.
• DefinitionOrganizationName: string
  Title: Item Master Organization

  The master organization name.
• DeleteFlag: boolean
  Indicates whether the subscription is marked for deletion.
• Description: string
  Title: Description

  Maximum Length: 1995

  The description of the subscription.
• DocumentFiscalClassification: string
  Title: Document Fiscal Classification

  Maximum Length: 30

  The document fiscal classification.
• Duration: integer
  Title: Duration

  The duration of the subscription.
• EnableAdvBipTemplateFlag: boolean
  Title: Enable advanced configuration

  Maximum Length: 1

  Default Value: false

  Indicates whether advanced BIP configuration for usage invoice templates is enabled or not.
• EnableRenewalRemindersFlag: boolean
  Title: Enable renewal reminders

  Maximum Length: 1

  Indicates whether the renewal reminders is enabled.
• EndDate: string (date)
  Title: End Date

  The date when the subscription ends.
• EstimatedTax: number
  Title: Estimated Tax

  The estimated tax.
• ExemptCertificateNumber: string
  Title: Tax Exemption Certificate Number

  Maximum Length: 80

  The tax exempt certificate number.
• ExemptReason: string
  Title: Exemption Reason Code

  Maximum Length: 30

  The tax exempt reason code.
• ExemptReasonMeaning: string
  Title: Exemption Reason

  The tax exempt reason meaning.
• flexFields: array Descriptive Flexfields
  Title: Descriptive Flexfields

  The descriptive flexfields resource is used to view, create, update, and delete a descriptive flexfield.
• FreezePriceFlag: boolean
  Title: Freeze Price

  Maximum Length: 1

  Default Value: false

  Indicates whether the price is being frozen.
• GenerateBillingSchedule: string
  The generate billing schedule.
• InternalApproval: string
  Title: Internal Approval

  Maximum Length: 30

  The internal approval.
• InvoiceBipReportCode: string
  Title: BIP Data Source

  Maximum Length: 30

  The code of the BIP report template used for the invoice attachments.
• InvoicedAmount: number
  Title: Invoiced Amount

  The invoiced amount.
• InvoicingRuleId: integer (int64)
  Title: Invoicing Rule Id

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

  The name of the invoice rule.
• LastUpdateDate: string (date-time)
  Title: Last Updated 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.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the subscription.
• LayoutTemplate: string
  Title: Contract Layout Template

  Maximum Length: 200

  The layout template.
• LegalEntityId: integer (int64)
  Title: Legal Entity ID

  Th unique identifier of the legal entity.
• LegalEntityName: string
  Title: Subscription Legal Entity

  The name of the legal entity.
• LineAutonumberEnabledYn: boolean
  Title: Automate subscription line numbering

  Maximum Length: 1

  Indicates if the line auto number is enabled.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LockedFlagReadOnly: string
  Read Only: true

  Indicates whether the subscription is locked because of the process being executed.
• NegotiationLanguage: string
  Title: Language

  Maximum Length: 4

  The negotiation language.
• NotificationTemplateId: integer
  The unique identifier of the notification template.
• OrderLineOperationCode: string
  Title: Action Code

  Maximum Length: 80

  Order Line Operation Code
• OverrideCreditAmount: number
  Title: Override Credit Amount

  The override credit amount of the subscription.
• PartialPeriodStart: string
  Title: Period Start

  Maximum Length: 30

  The partial period start. Values could be calendar or service.
• PartialPeriodType: string
  Title: Period Type

  Maximum Length: 30

  The partial period type. Values could be actual or fixed.
• parties: array Parties
  Title: Parties

  The parties resource to view, create, update, and delete the subscription parties.
• PaymentMethod: string
  Title: Payment Method

  Maximum Length: 30

  The method of payment.
• 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.
• Period: string
  Title: Period

  The period of the subscription.
• PONumber: string
  Title: PO Number

  Maximum Length: 50

  The PO number.
• PreviewBipReportCode: string
  Title: BIP Data Source

  Maximum Length: 20

  The code of the BIP report template used for the subscription preview.
• PriceAdjustmentPercentUsed: number
  Title: Used Price Adjustment Percentage

  The price adjustment percent used.
• PricedOnDate: string (date-time)
  Title: Priced on Date

  The date on which the subscription was priced.
• PricingError: string
  Maximum Length: 2000

  The error related to pricing.
• PricingSegment: string
  Title: Pricing Segment

  Maximum Length: 30

  The pricing segment.
• PricingSegmentExplanation: string
  Title: Pricing Segment Explanation

  Maximum Length: 1000

  The pricing segment explanation.
• PricingStrategyExplanation: string
  Title: Pricing Strategy

  Maximum Length: 1000

  The pricing strategy explanation.
• PricingStrategyId: integer (int64)
  Title: Pricing Strategy ID

  The unique identifier of the pricing strategy.
• PricingSystem: string
  Title: Pricing system

  Maximum Length: 30

  The pricing system.
• PrimaryPartyId: integer (int64)
  Title: Party ID

  The unique identifier of the primary party.
• PrimaryPartyName: string
  Title: Customer

  The name of the primary party.
• PrimaryPartyNumber: string
  Title: Primary Party Number

  Read Only: true

  Maximum Length: 30

  The primary party number of the subscription.
• PrimarySalesPerson: integer (int64)
  Title: Primary Salesperson ID

  The primary sales person.
• PrimarySalesPersonNumber: string
  Title: Primary Salesperson Number

  The primary sales person number of the subscription.
• ProductNotSuspended: string
  Read Only: true

  Maximum Length: 255

  Indicates whether any product in the subscription is suspended or not.
• products: array Products
  Title: Products

  The products resource is used to view, create, update, and delete the product details for a subscription, such as start and end dates, item, unit price, amount, bill-to details, ship-to details, billing frequency, invoice rule, and payment method.
• QuoteId: integer (int64)
  Title: Quote Id

  Quote Id
• QuoteToCcEmail: string
  Title: Copy To

  Maximum Length: 2000

  The quote to cc email.
• QuoteToContactId: integer (int64)
  Title: Quote-To Contact ID

  The unique identifier of the quote to contact.
• RenewalCustomerAcceptance: string
  Title: Renewal Customer Acceptance

  Maximum Length: 30

  The renewal customer acceptance.
• RenewalDuration: integer (int64)
  Title: Renewal Duration

  The subscription 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 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 level renewal duration period override that will be used while renewing through automatic or manual renewal.
• RenewalInternalApproval: string
  Title: Renewal Internal Approval

  Maximum Length: 30

  The renewal internal approval.
• RenewalPaymentMethod: string
  Title: Renewal Payment Method

  Maximum Length: 30

  The internal code for the renewal payment method used in the subscription.
• RenewalPaymentMethodName: string
  Title: Renewal Payment Method Name

  The method of payment for renewed subscription. The payment method could be a purchase order, wire, or credit card.
• RenewalPoNumber: string
  Title: Renewal PO Number

  Maximum Length: 50

  The purchase order number of the renewed subscription.
• RenewalPriceAdjustmentBasis: string
  Title: Price Adjustment Basis

  Maximum Length: 30

  The renewal price adjustment basis.
• RenewalPriceAdjustmentPercent: number
  Title: Price Adjustment Value

  The renewal price adjustment percent.
• RenewalPriceAdjustmentType: string
  Title: Price Adjustment Type

  Maximum Length: 30

  The renewal price adjustment type.
• 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.
• RenewalPricingMethodUsed: string
  Title: Renewal Pricing Method Used

  Maximum Length: 30

  The renewal pricing method used.
• RenewalProcess: string
  Title: Renewal Process

  Maximum Length: 30

  The process of renewal.
• RenewalProcessUsed: string
  Title: Renewal Process Used

  Maximum Length: 30

  The renewal process used.
• RenewalSubscriptionProfileId: integer
  The unique identifier of the renewal subscription profile.
• RenewalTemplateId: integer
  The unique identifier of the renewal template.
• RenewalType: string
  Title: Renewal Type

  The type of renewal.
• RenewalWireNumber: string
  Title: Renewal Wire Number

  Maximum Length: 30

  The wire number that identifies the electronic funds transfer used to pay for a renewed subscription.
• RenewedDate: string (date)
  The date on which the subscription was renewed.
• RenewPerpetuallyFlag: boolean
  Title: Renew forever

  Maximum Length: 1

  Indicates whether the subscription should be renewed forever.
• RepriceFlag: boolean
  Indicates whether the subscription should be repriced or not. If passed as 'true', the entire subscription will be repriced.
• 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: 255

  The revenue option for the subscription.
• salesCredits: array Sales Credits
  Title: Sales Credits

  The sales credits resource is used to view, create, update, and delete the sales credits defined for subscription or subscription products.
• SalesOrderId: integer (int64)
  Title: Sales Order ID

  The ID of the sales order associated with the subscription.
• SalesOrderNumber: string
  Title: Sales Order Number

  Maximum Length: 200

  The number of the sales order associated with the subscription.
• SegmentExplanationMessage: string
  Title: Segment

  Maximum Length: 30

  The pricing segment explanation message.
• ShipToAccountDescription: string
  The ship-to account description of the subscription.
• ShipToAccountId: integer (int64)
  Title: Ship-to Account ID

  The ship-to account ID of the subscription.
• ShipToAccountNumber: string
  Title: Ship-to Account

  The ship-to account number of the subscription.
• ShipToContactId: integer (int64)
  Title: Ship-to Contact ID

  The ship-to contract ID of the subscription.
• ShipToContactName: string
  Title: Ship-to Contact

  The ship-to contact name of the subscription.
• ShipToContactNumber: string
  Title: Ship-to Contact Number

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

  The party to which shipping is to be done.
• ShipToPartyName: string
  Title: Ship-to Party

  The party name to which the shipping is to be done.
• ShipToPartyNumber: string
  Title: Ship-to Party Number

  Read Only: true

  Maximum Length: 30

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

  The unique identifier of the ship to party.
• ShipToSite: string
  Title: Ship-to Site

  The site to which the shipping is to be done.
• ShipToSiteName: string
  Title: Ship-to Site

  Maximum Length: 255

  The name of the subscription ship-to site.
• ShipToSiteNumber: string
  Title: Ship-to Site Number

  The ship-to site number of the subscription.
• ShortDescription: string
  Title: Short Description

  Maximum Length: 600

  The short description of the subscription.
• SkipConsolidationFlag: boolean
  Title: Skip renewal consolidation

  Maximum Length: 1

  Skip Consolidation Flag
• smartActions: array Subscription User Actions
  Title: Subscription 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 source key.
• SourceNumber: string
  Title: External Source Number

  Maximum Length: 120

  The source system.
• SourceSystem: string
  Title: Source System

  Maximum Length: 30

  The source system.
• StartDate: string (date)
  Title: Start Date

  The date when the subscription starts.
• Status: string
  Title: Status

  Maximum Length: 30

  Default Value: DRAFT

  The status of the subscription.
• StatusName: string
  Title: Status

  Read Only: true

  Maximum Length: 80

  The display name of the subscription status.
• subscriptionContact: array Subscription Contacts
  Title: Subscription Contacts

  The subscription contacts resource is used to view, create, delete and, update the external party contacts.
• SubscriptionId: integer (int64)
  The unique identifier of the subscription.
• SubscriptionInvoiceText: string
  Title: Subscription Invoice Text

  Maximum Length: 4000

  The subscription invoice text.
• SubscriptionNumber: string
  Title: Subscription Number

  Maximum Length: 120

  The alternate identifier of the subscription.
• SubscriptionProfileId: integer (int64)
  Title: Subscription Profile ID

  The unique identifier of the subscription profile.
• SubscriptionProfileName: string
  Title: Subscription Profile

  Maximum Length: 300

  The name of the subscription profile name.
• subscriptionTeam: array Subscription Teams
  Title: Subscription Teams

  The subscription team is used to view the internal and external contacts of the subscription.
• supportingDocumentAttachments: array Supporting Document Attachments
  Title: Supporting Document Attachments

  The supporting document attachments resource is used to view, create, and update supporting document attachments.
• SystemAction: string
  Title: Action

  Maximum Length: 30

  The subscription action that is performed by the user.
• SystemActionDate: string (date-time)
  Title: Process Submitted

  The date and time at which the subscription process is submitted.
• SystemActionName: string
  Title: Action

  Read Only: true

  Maximum Length: 80

  System Action Name
• SystemActionObject: string
  Title: Object

  Maximum Length: 30

  The subscription object on which the action is performed.
• SystemActionObjectKey: string
  Title: Object ID

  Maximum Length: 300

  The identifier of the subscription object on which the action is performed.
• SystemActionRequestId: integer (int64)
  Title: Process ID

  The identifier of the subscription process that is being executed.
• SystemActionStatus: string
  Title: Process Status

  Maximum Length: 30

  The status of the subscription process that is submitted.
• TaxClassificationCode: string
  Title: Classification Code

  Maximum Length: 50

  The tax classification code.
• TaxClassificationMeaning: string
  Title: Classification Code

  The tax classification meaning.
• TaxExemptionHandling: string
  Title: Exemption Control

  Maximum Length: 30

  The tax exemption handling code.
• TaxExemptionHandlingName: string
  Title: Exemption Control Name

  The tax exemption handling name.
• TcvWithTotalUsageCharge: number
  Title: TCV with Total Usage Charge

  Read Only: true

  Tcv With Total Usage Charge
• TotalContractValue: number
  Title: Total Contract Value

  The total contract value.
• TotalUsageCharge: number
  Title: Total Usage Charges

  Read Only: true

  Total Usage Charge
• TransactionType: string
  The transaction type.
• TransactionTypeName: string
  Title: Transaction Type

  Maximum Length: 80

  The accounts receivables transaction type name.
• UpdateFlag: boolean
  Indicates whether the subscription is updated.
• UsageCapture: string
  Title: Usage Capture Mode

  Maximum Length: 30

  The usage capture mode.
• UsageEventAllowanceInvTemplate: string
  Title: Allowance

  Maximum Length: 200

  The template used for the usage events allowance rating model.
• UsageEventCommitmentInvTemplate: string
  Title: Commitment

  Maximum Length: 200

  The template used for the regular usage events commitment rating model.
• UsageEventEstimateInvTemplate: string
  Title: Estimate

  Maximum Length: 200

  The template used for the usage events estimate rating model.
• UsageEventRegularInvTemplate: string
  Title: Basic

  Maximum Length: 200

  The template used for the regular usage events rating model.
• UsageInvoiceLayoutTemplate: string
  Title: BIP Template

  Maximum Length: 200

  The layout template of the usage invoice.
• UserStatus: string
  Title: User Status

  Maximum Length: 30

  The user status of the subscription.
• UserStatusName: string
  The translated user status of the subscription.
• ValidateFlag: boolean
  Title: Validate subscription during import

  Validate Flag
• validateSubscription: array Validate Subscriptions
  Title: Validate Subscriptions

  The validate subscriptions resource to view, create, update, and delete the validation errors for a subscription.
• ValidationStatus: string
  Title: Validation Status

  Maximum Length: 1

  The validation status of the subscription.
• WarehouseId: integer (int64)
  Title: Warehouse

  The warehouse ID associated with the subscription.
• WareHouseName: string
  Title: Warehouse

  The name of the warehouse associated with the subscription.
• WarrantyYN: string
  Title: Warranty Subscription

  Maximum Length: 1

  Indicates whether this subscription is a warranty or not.
• WireNumber: string
  Title: Wire Number

  Maximum Length: 30

  The wire number.

{
    "type":"object",
    "properties":{
        "CalculatedCreditAmount":{
            "title":"Calculated Credit Amount",
            "type":"number",
            "description":"The calculated credit amount of the subscription.",
            "nullable":true,
            "x-queryable":true
        },
        "PreviewBipReportCode":{
            "title":"BIP Data Source",
            "maxLength":20,
            "type":"string",
            "description":"The code of the BIP report template used for the subscription preview.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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
        },
        "CancelDescription":{
            "title":"Cancellation Description",
            "maxLength":2000,
            "type":"string",
            "description":"The cancel reason description of the subscription.",
            "nullable":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type.",
            "nullable":true,
            "x-queryable":false
        },
        "UserStatus":{
            "title":"User Status",
            "maxLength":30,
            "type":"string",
            "description":"The user status of the subscription.",
            "nullable":true,
            "x-queryable":false
        },
        "ShortDescription":{
            "title":"Short Description",
            "maxLength":600,
            "type":"string",
            "description":"The short description of the subscription.",
            "nullable":true,
            "x-queryable":false
        },
        "SystemActionDate":{
            "title":"Process Submitted",
            "type":"string",
            "description":"The date and time at which the subscription process is submitted.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SourceKey":{
            "title":"Source Key",
            "maxLength":120,
            "type":"string",
            "description":"The source key.",
            "nullable":true,
            "x-queryable":false
        },
        "Currency":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The subscription currency.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the subscription.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the subscription.",
            "nullable":false,
            "default":"DRAFT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "CreditedAmount":{
            "title":"Credited Amount",
            "type":"number",
            "description":"The credited amount.",
            "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,
                "dependencies":[
                    "SubscriptionProfileId"
                ]
            },
            "x-queryable":true
        },
        "PaymentTermsName":{
            "title":"Payment Terms",
            "type":"string",
            "description":"The name of the payment terms.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "SubscriptionProfileId"
                ]
            }
        },
        "StatusName":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"The display name of the subscription status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PrimaryPartyName":{
            "title":"Customer",
            "type":"string",
            "description":"The name of the primary party.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "PrimaryPartyName1"
                ]
            }
        },
        "RenewalPaymentMethod":{
            "title":"Renewal Payment Method",
            "maxLength":30,
            "type":"string",
            "description":"The internal code for the renewal payment method used in the subscription.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the subscription is marked for deletion.",
            "nullable":true,
            "x-queryable":false
        },
        "RenewPerpetuallyFlag":{
            "title":"Renew forever",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the subscription should be renewed forever.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyConversionRateType":{
            "title":"Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OrderLineOperationCode":{
            "title":"Action Code",
            "maxLength":80,
            "type":"string",
            "description":"Order Line Operation Code",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the subscription.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CanceledAmount":{
            "title":"Canceled Amount",
            "type":"number",
            "description":"The canceled amount.",
            "nullable":true,
            "x-queryable":false
        },
        "QuoteId":{
            "title":"Quote Id",
            "type":"integer",
            "description":"Quote Id",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SystemAction":{
            "title":"Action",
            "maxLength":30,
            "type":"string",
            "description":"The subscription action that is performed by the user.",
            "nullable":true,
            "x-queryable":true
        },
        "EnableRenewalRemindersFlag":{
            "title":"Enable renewal reminders",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the renewal reminders is enabled.",
            "nullable":true,
            "x-queryable":false
        },
        "AsyncFlag":{
            "type":"boolean",
            "description":"Indicates whether the subscription will undergo asynchronous process for operations such as duplicate, generate billing schedule etc.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RenewalSubscriptionProfileId":{
            "type":"integer",
            "description":"The unique identifier of the renewal subscription profile.",
            "nullable":true,
            "x-queryable":false
        },
        "SystemActionObjectKey":{
            "title":"Object ID",
            "maxLength":300,
            "type":"string",
            "description":"The identifier of the subscription object on which the action is performed.",
            "nullable":true,
            "x-queryable":true
        },
        "WarrantyYN":{
            "title":"Warranty Subscription",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether this subscription is a warranty or not.",
            "nullable":true,
            "x-queryable":true
        },
        "DefaultRevenueAction":{
            "maxLength":255,
            "type":"string",
            "description":"The default revenue action to be taken for the subscription.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UsageEventCommitmentInvTemplate":{
            "title":"Commitment",
            "maxLength":200,
            "type":"string",
            "description":"The template used for the regular usage events commitment rating model.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "InvoiceBipReportCode"
                ]
            },
            "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"
            }
        },
        "subscriptionTeam":{
            "title":"Subscription Teams",
            "type":"array",
            "description":"The subscription team is used to view the internal and external contacts of the subscription.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-subscriptionTeam-item-response"
            }
        },
        "supportingDocumentAttachments":{
            "title":"Supporting Document Attachments",
            "type":"array",
            "description":"The supporting document attachments resource is used to view, create, and update supporting document attachments.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-supportingDocumentAttachments-item-response"
            }
        },
        "CurrencyConversionRateDate":{
            "title":"Conversion Rate Date",
            "type":"string",
            "description":"The currency conversion rate date.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "TaxClassificationMeaning":{
            "title":"Classification Code",
            "type":"string",
            "description":"The tax classification meaning.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ShipToSiteName":{
            "title":"Ship-to Site",
            "maxLength":255,
            "type":"string",
            "description":"The name of the subscription ship-to site.",
            "nullable":true,
            "x-queryable":true
        },
        "BillingDateCode":{
            "title":"Billing Date",
            "maxLength":30,
            "type":"string",
            "description":"The code of the billing date.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SubscriptionProfileId"
                ]
            }
        },
        "contractAttachment":{
            "title":"Contract Attachments",
            "type":"array",
            "description":"The contract attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-contractAttachment-item-response"
            }
        },
        "NegotiationLanguage":{
            "title":"Language",
            "maxLength":4,
            "type":"string",
            "description":"The negotiation language.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PricingStrategyExplanation":{
            "title":"Pricing Strategy",
            "maxLength":1000,
            "type":"string",
            "description":"The pricing strategy explanation.",
            "nullable":true,
            "x-queryable":false
        },
        "WarehouseId":{
            "title":"Warehouse",
            "type":"integer",
            "description":"The warehouse ID associated with the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the subscription ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ShipToSiteNumber":{
            "title":"Ship-to Site Number",
            "type":"string",
            "description":"The ship-to site number of the subscription.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ClosedAmount":{
            "title":"Closed Amount",
            "type":"number",
            "description":"The closed amount.",
            "nullable":true,
            "x-queryable":false
        },
        "OverrideCreditAmount":{
            "title":"Override Credit Amount",
            "type":"number",
            "description":"The override credit amount of the subscription.",
            "nullable":true,
            "x-queryable":true
        },
        "ValidationStatus":{
            "title":"Validation Status",
            "maxLength":1,
            "type":"string",
            "description":"The validation status of the subscription.",
            "nullable":true,
            "x-queryable":true
        },
        "DefinitionOrganizationCode":{
            "title":"Item Master Organization Code",
            "type":"string",
            "description":"The inventory organization code of the subscription.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "GenerateBillingSchedule":{
            "type":"string",
            "description":"The generate billing schedule.",
            "nullable":true,
            "x-queryable":false
        },
        "CloseDescription":{
            "title":"Close Description",
            "maxLength":2000,
            "type":"string",
            "description":"The close reason description of the subscription.",
            "nullable":true,
            "x-queryable":true
        },
        "RenewalProcessUsed":{
            "title":"Renewal Process Used",
            "maxLength":30,
            "type":"string",
            "description":"The renewal process used.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the subscription was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BillingOffsetDays":{
            "title":"Offset",
            "type":"integer",
            "description":"The days of offset billing.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "SubscriptionProfileId"
                ]
            }
        },
        "TaxExemptionHandlingName":{
            "title":"Exemption Control Name",
            "type":"string",
            "description":"The tax exemption handling name.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BillingDateName":{
            "title":"Billing Date Name",
            "type":"string",
            "description":"The name of the billing date.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BillToAccountNumber":{
            "title":"Billing Account",
            "maxLength":30,
            "type":"string",
            "description":"The alternate identifier of the bill-to account.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ContactRelationshipId":{
            "type":"integer",
            "description":"Contact Relationship Id",
            "nullable":true,
            "x-queryable":false
        },
        "TaxExemptionHandling":{
            "title":"Exemption Control",
            "maxLength":30,
            "type":"string",
            "description":"The tax exemption handling code.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "smartActions":{
            "title":"Subscription User Actions",
            "type":"array",
            "description":"The smart actions resource stores the endpoint and security details for every user action.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-smartActions-item-response"
            }
        },
        "SubscriptionProfileId":{
            "title":"Subscription Profile ID",
            "type":"integer",
            "description":"The unique identifier of the subscription profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ShipToSite":{
            "title":"Ship-to Site",
            "type":"string",
            "description":"The site to which the shipping is to be done.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "AssigneeId":{
            "title":"Assignee ID",
            "type":"integer",
            "description":"The unique identifier of the assignee.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CoverageInvoiceText":{
            "title":"Coverage Invoice Text",
            "maxLength":4000,
            "type":"string",
            "description":"The charge invoice text.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "SubscriptionProfileId"
                ]
            }
        },
        "UsageCapture":{
            "title":"Usage Capture Mode",
            "maxLength":30,
            "type":"string",
            "description":"The usage capture mode.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "SubscriptionProfileId"
                ]
            }
        },
        "RenewalCustomerAcceptance":{
            "title":"Renewal Customer Acceptance",
            "maxLength":30,
            "type":"string",
            "description":"The renewal customer acceptance.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ShipToAccountNumber":{
            "title":"Ship-to Account",
            "type":"string",
            "description":"The ship-to account number of the subscription.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "sortable":false,
                "dependencies":[
                    "ShipToAccountNumber1"
                ]
            }
        },
        "LayoutTemplate":{
            "title":"Contract Layout Template",
            "maxLength":200,
            "type":"string",
            "description":"The layout template.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "PreviewBipReportCode"
                ]
            }
        },
        "ShipToContactId":{
            "title":"Ship-to Contact ID",
            "type":"integer",
            "description":"The ship-to contract ID of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ApprovedDate":{
            "title":"Approved Date",
            "type":"string",
            "description":"The date on which the subscription was approved.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessUnitId":{
            "title":"BU ID",
            "type":"integer",
            "description":"The unique identifier of the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SystemActionObject":{
            "title":"Object",
            "maxLength":30,
            "type":"string",
            "description":"The subscription object on which the action is performed.",
            "nullable":true,
            "x-queryable":true
        },
        "Duration":{
            "title":"Duration",
            "type":"integer",
            "description":"The duration of the subscription.",
            "nullable":true,
            "x-queryable":false
        },
        "DaysBeforeExpiryUsed":{
            "title":"Used Days Before Expiry",
            "maxLength":18,
            "type":"string",
            "description":"The days before expiry used.",
            "nullable":true,
            "x-queryable":false
        },
        "RenewalType":{
            "title":"Renewal Type",
            "type":"string",
            "description":"The type of renewal.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TaxClassificationCode":{
            "title":"Classification Code",
            "maxLength":50,
            "type":"string",
            "description":"The tax classification code.",
            "nullable":true,
            "x-queryable":false
        },
        "parties":{
            "title":"Parties",
            "type":"array",
            "description":"The parties resource to view, create, update, and delete the subscription parties.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-parties-item-response"
            }
        },
        "RenewalPoNumber":{
            "title":"Renewal PO Number",
            "maxLength":50,
            "type":"string",
            "description":"The purchase order number of the renewed subscription.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "RenewalPaymentMethod"
                ]
            }
        },
        "TransactionType":{
            "type":"string",
            "description":"The transaction type.",
            "nullable":true,
            "x-queryable":false
        },
        "QuoteToContactId":{
            "title":"Quote-To Contact ID",
            "type":"integer",
            "description":"The unique identifier of the quote to contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ShipToContactPartyId":{
            "type":"integer",
            "description":"The ship-to contact party ID of the subscription.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "ShipToContactPartyId1"
                ]
            }
        },
        "PrimaryPartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the primary party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ShipToContactNumber":{
            "title":"Ship-to Contact Number",
            "type":"string",
            "description":"The ship-to contact number of the subscription.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "ShipToContactNumber1"
                ]
            }
        },
        "SystemActionStatus":{
            "title":"Process Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the subscription process that is submitted.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipToAccountId":{
            "title":"Ship-to Account ID",
            "type":"integer",
            "description":"The ship-to account ID of the subscription.",
            "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",
                "dependencies":[
                    "SubscriptionProfileId"
                ]
            }
        },
        "QuoteToCcEmail":{
            "title":"Copy To",
            "maxLength":2000,
            "type":"string",
            "description":"The quote to cc email.",
            "nullable":true,
            "x-queryable":false
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the subscription is updated.",
            "nullable":true,
            "x-queryable":false
        },
        "RenewalProcess":{
            "title":"Renewal Process",
            "maxLength":30,
            "type":"string",
            "description":"The process of renewal.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SalesOrderId":{
            "title":"Sales Order ID",
            "type":"integer",
            "description":"The ID of the sales order associated with the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DefinitionOrganizationName":{
            "title":"Item Master Organization",
            "type":"string",
            "description":"The master organization name.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PricedOnDate":{
            "title":"Priced on Date",
            "type":"string",
            "description":"The date on which the subscription was priced.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "CreditType":{
            "title":"Credit Type",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of credit issued to the customer such as negative invoice or credit memo.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BillService":{
            "title":"Bill Service",
            "maxLength":30,
            "type":"string",
            "description":"The bill service code. Values could be ORA_DO_NOT_BILL, ORA_BILL or ORA_BILL_ON_RENEWAL.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SubscriptionProfileId"
                ]
            }
        },
        "RepriceFlag":{
            "type":"boolean",
            "description":"Indicates whether the subscription should be repriced or not. If passed as 'true', the entire subscription will be repriced.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionNumber":{
            "title":"Subscription Number",
            "maxLength":120,
            "type":"string",
            "description":"The alternate identifier of the subscription.",
            "nullable":false,
            "x-queryable":true
        },
        "ShipToPartyNumber":{
            "title":"Ship-to Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The ship-to party number of the subscription.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "ExemptCertificateNumber":{
            "title":"Tax Exemption Certificate Number",
            "maxLength":80,
            "type":"string",
            "description":"The tax exempt certificate number.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "BillToContactId":{
            "title":"Bill-to Contact ID",
            "type":"integer",
            "description":"The bill-to contact of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RenewalWireNumber":{
            "title":"Renewal Wire Number",
            "maxLength":30,
            "type":"string",
            "description":"The wire number that identifies the electronic funds transfer used to pay for a renewed subscription.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "RenewalPaymentMethod"
                ]
            }
        },
        "RenewalPricingMethodUsed":{
            "title":"Renewal Pricing Method Used",
            "maxLength":30,
            "type":"string",
            "description":"The renewal pricing method used.",
            "nullable":true,
            "x-queryable":false
        },
        "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 PO number.",
            "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":true
        },
        "SubscriptionProfileName":{
            "title":"Subscription Profile",
            "maxLength":300,
            "type":"string",
            "description":"The name of the subscription profile name.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PrimarySalesPerson":{
            "title":"Primary Salesperson ID",
            "type":"integer",
            "description":"The primary sales person.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RenewalPriceListId":{
            "type":"integer",
            "description":"The identifier of the renewal price list.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustomerContactName":{
            "title":"Contact Name",
            "type":"string",
            "description":"Customer Contact Name",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PartialPeriodType":{
            "title":"Period Type",
            "maxLength":30,
            "type":"string",
            "description":"The partial period type. Values could be actual or fixed.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SubscriptionProfileId"
                ]
            }
        },
        "BillServiceName":{
            "title":"Bill Service Name",
            "type":"string",
            "description":"The bill service option. Values could be no bill, bill or bill on renewal.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SubscriptionProfileId"
                ]
            }
        },
        "DocumentFiscalClassification":{
            "title":"Document Fiscal Classification",
            "maxLength":30,
            "type":"string",
            "description":"The document fiscal classification.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "NotificationTemplateId":{
            "type":"integer",
            "description":"The unique identifier of the notification template.",
            "nullable":true,
            "x-queryable":false
        },
        "CloseReason":{
            "title":"Close Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason to close the subscription.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SkipConsolidationFlag":{
            "title":"Skip renewal consolidation",
            "maxLength":1,
            "type":"boolean",
            "description":"Skip Consolidation Flag",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceBipReportCode":{
            "title":"BIP Data Source",
            "maxLength":30,
            "type":"string",
            "description":"The code of the BIP report template used for the invoice attachments.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LegalEntityName":{
            "title":"Subscription Legal Entity",
            "type":"string",
            "description":"The name of the legal entity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "BillToPartyId":{
            "title":"Bill-to Party ID",
            "type":"integer",
            "description":"The bill-to customer ID of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceNumber":{
            "title":"External Source Number",
            "maxLength":120,
            "type":"string",
            "description":"The source system.",
            "nullable":true,
            "x-queryable":false
        },
        "CanceledDate":{
            "title":"Canceled Date",
            "type":"string",
            "description":"The date on which the subscription was canceled.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "WareHouseName":{
            "title":"Warehouse",
            "type":"string",
            "description":"The name of the warehouse associated with the subscription.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "sortable":false
            }
        },
        "PrimarySalesPersonNumber":{
            "title":"Primary Salesperson Number",
            "type":"string",
            "description":"The primary sales person number of the subscription.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SubscriptionInvoiceText":{
            "title":"Subscription Invoice Text",
            "maxLength":4000,
            "type":"string",
            "description":"The subscription invoice text.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "SubscriptionProfileId"
                ]
            }
        },
        "BillingFrequency":{
            "title":"Billing Frequency",
            "maxLength":30,
            "type":"string",
            "description":"The billing frequency code.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "SubscriptionProfileId"
                ]
            }
        },
        "RenewalPaymentMethodName":{
            "title":"Renewal Payment Method Name",
            "type":"string",
            "description":"The method of payment for renewed subscription. 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 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"
            }
        },
        "EstimatedTax":{
            "title":"Estimated Tax",
            "type":"number",
            "description":"The estimated tax.",
            "nullable":true,
            "x-queryable":false
        },
        "PriceAdjustmentPercentUsed":{
            "title":"Used Price Adjustment Percentage",
            "type":"number",
            "description":"The price adjustment percent used.",
            "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.",
            "nullable":true,
            "x-queryable":true
        },
        "BillToPartyName":{
            "title":"Bill-to Customer",
            "maxLength":360,
            "type":"string",
            "description":"The bill-to customer name of the subscription.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "sortable":false
            }
        },
        "SystemActionRequestId":{
            "title":"Process ID",
            "type":"integer",
            "description":"The identifier of the subscription process that is being executed.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ShipToParty":{
            "title":"Ship-to Party ID",
            "type":"integer",
            "description":"The party to which shipping is to be done.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SystemActionName":{
            "title":"Action",
            "maxLength":80,
            "type":"string",
            "description":"System Action Name",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "InvoicedAmount":{
            "title":"Invoiced Amount",
            "type":"number",
            "description":"The invoiced amount.",
            "nullable":true,
            "x-queryable":false
        },
        "RenewalDuration":{
            "title":"Renewal Duration",
            "type":"integer",
            "description":"The subscription 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":{
            "title":"Pricing system",
            "maxLength":30,
            "type":"string",
            "description":"The pricing system.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":1995,
            "type":"string",
            "description":"The description of the subscription.",
            "nullable":true,
            "x-queryable":false
        },
        "InvoicingRuleName":{
            "title":"Invoicing Rule",
            "type":"string",
            "description":"The name of the invoice rule.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "SubscriptionProfileId"
                ]
            }
        },
        "CustomerTrxTypeSequenceId":{
            "title":"Sequence",
            "type":"integer",
            "description":"The unique identifier of the customer transaction type sequence.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "SubscriptionProfileId"
                ]
            },
            "x-queryable":true
        },
        "BillToPartyNumber":{
            "title":"Bill-to Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The bill-to customer number of the subscription.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "sortable":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"
            }
        },
        "products":{
            "title":"Products",
            "type":"array",
            "description":"The products resource is used to view, create, update, and delete the product details for a subscription, such as start and end dates, item, unit price, amount, bill-to details, ship-to details, billing frequency, invoice rule, and payment method.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-item-response"
            }
        },
        "RenewalTemplateId":{
            "type":"integer",
            "description":"The unique identifier of the renewal template.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LegalEntityId":{
            "title":"Legal Entity ID",
            "type":"integer",
            "description":"Th unique identifier of the legal entity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RevenueOption":{
            "title":"Revenue Accounting Option",
            "maxLength":255,
            "type":"string",
            "description":"The revenue option for the subscription.",
            "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/subscriptions-flexFields-item-response"
            },
            "x-cardinality":"1"
        },
        "PricingSegment":{
            "title":"Pricing Segment",
            "maxLength":30,
            "type":"string",
            "description":"The pricing segment.",
            "nullable":true,
            "x-queryable":false
        },
        "CurrencyConversionRate":{
            "title":"Conversion Rate",
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipToContactName":{
            "title":"Ship-to Contact",
            "type":"string",
            "description":"The ship-to contact name of the subscription.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "sortable":false,
                "dependencies":[
                    "ShipToContactName1"
                ]
            }
        },
        "TotalContractValue":{
            "title":"Total Contract Value",
            "type":"number",
            "description":"The total contract value.",
            "nullable":true,
            "x-queryable":true
        },
        "FreezePriceFlag":{
            "title":"Freeze Price",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the price is being frozen.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "LockedFlagReadOnly":{
            "type":"string",
            "description":"Indicates whether the subscription is locked because of the process being executed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartialPeriodStart":{
            "title":"Period Start",
            "maxLength":30,
            "type":"string",
            "description":"The partial period start. Values could be calendar or service.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SubscriptionProfileId"
                ]
            }
        },
        "CloseCreditMethod":{
            "title":"Close Credit Method",
            "maxLength":30,
            "type":"string",
            "description":"The close credit method.",
            "nullable":true,
            "x-queryable":false
        },
        "ExemptReasonMeaning":{
            "title":"Exemption Reason",
            "type":"string",
            "description":"The tax exempt reason meaning.",
            "nullable":true,
            "x-queryable":false
        },
        "TotalUsageCharge":{
            "title":"Total Usage Charges",
            "type":"number",
            "description":"Total Usage Charge",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CommunicationChannel":{
            "title":"Communication Channel",
            "maxLength":30,
            "type":"string",
            "description":"The communication channel.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BillToSiteNumber":{
            "title":"Bill-to Site Number",
            "type":"string",
            "description":"The bill-to site number of the subscription.",
            "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.",
            "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.",
            "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,
                "dependencies":[
                    "SubscriptionProfileId"
                ]
            },
            "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 template used for the regular usage events rating model.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "InvoiceBipReportCode"
                ]
            },
            "x-queryable":true
        },
        "ClosedDate":{
            "title":"Closed Date",
            "type":"string",
            "description":"The date on which the subscription was closed.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "BillingSystem":{
            "title":"Billing System",
            "maxLength":120,
            "type":"string",
            "description":"The billing system.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "SubscriptionProfileId"
                ]
            }
        },
        "SourceSystem":{
            "title":"Source System",
            "maxLength":30,
            "type":"string",
            "description":"The source system.",
            "nullable":true,
            "x-queryable":false
        },
        "AttachmentEntityName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the attachment entity.",
            "nullable":true,
            "default":"OSS_DOC_SUBSCRIPTION_AGREEMENT",
            "x-queryable":false
        },
        "TransactionTypeName":{
            "title":"Transaction Type",
            "maxLength":80,
            "type":"string",
            "description":"The accounts receivables transaction type name.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "SubscriptionProfileId"
                ]
            }
        },
        "AttachmentEntityName1":{
            "type":"string",
            "description":"The name of the attachment entity.",
            "nullable":true,
            "default":"OSS_DOC_SUPPORTING_DOCUMENTS",
            "x-queryable":false
        },
        "BillToAccountDescription":{
            "type":"string",
            "description":"The description of the bill-to account.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "BillToAccountDescription1"
                ]
            }
        },
        "ProductNotSuspended":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates whether any product in the subscription is suspended or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the subscription starts.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "BillToAddress":{
            "title":"Bill-to Address",
            "type":"string",
            "description":"The address to which the bill is to be sent.",
            "nullable":true,
            "x-queryable":false
        },
        "ExemptReason":{
            "title":"Exemption Reason Code",
            "maxLength":30,
            "type":"string",
            "description":"The tax exempt reason code.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipToAccountDescription":{
            "type":"string",
            "description":"The ship-to account description of the subscription.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "ShipToAccountDescription1"
                ]
            }
        },
        "RenewalPriceAdjustmentBasis":{
            "title":"Price Adjustment Basis",
            "maxLength":30,
            "type":"string",
            "description":"The renewal price adjustment basis.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RenewalInternalApproval":{
            "title":"Renewal Internal Approval",
            "maxLength":30,
            "type":"string",
            "description":"The renewal internal approval.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DaysBeforeExpiry":{
            "title":"Days Before Expiration",
            "type":"integer",
            "description":"The number of days before expiry.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "validateSubscription":{
            "title":"Validate Subscriptions",
            "type":"array",
            "description":"The validate subscriptions resource to view, create, update, and delete the validation errors for a subscription.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-validateSubscription-item-response"
            }
        },
        "CorpCurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code.",
            "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
        },
        "BillToSiteName":{
            "title":"Bill-to Site",
            "maxLength":255,
            "type":"string",
            "description":"The name of the subscription bill-to site.",
            "nullable":true,
            "x-queryable":true
        },
        "UsageEventEstimateInvTemplate":{
            "title":"Estimate",
            "maxLength":200,
            "type":"string",
            "description":"The template used for the usage events estimate rating model.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "InvoiceBipReportCode"
                ]
            },
            "x-queryable":true
        },
        "CheckRenewFlag":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates whether the renewal should be checked for the subscription.",
            "nullable":true,
            "readOnly":true,
            "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 of the subscription.",
            "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
        },
        "SegmentExplanationMessage":{
            "title":"Segment",
            "maxLength":30,
            "type":"string",
            "description":"The pricing segment explanation message.",
            "nullable":true,
            "x-queryable":false
        },
        "BillOnDay":{
            "title":"Bill on Day",
            "type":"number",
            "description":"The day of the bill.",
            "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"
                ]
            }
        },
        "CustomerAcceptance":{
            "title":"Customer Acceptance",
            "maxLength":30,
            "type":"string",
            "description":"The customer acceptance.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CancelReason":{
            "title":"Cancellation Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason of cancelling the subscription.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "creditCards":{
            "title":"Credit Cards",
            "type":"array",
            "description":"The credit cards resource is used to view, create, and update the credit card information associated with a subscription.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-creditCards-item-response"
            }
        },
        "AssigneeType":{
            "title":"Assignee Type",
            "maxLength":30,
            "type":"string",
            "description":"The assignee type.",
            "nullable":true,
            "x-queryable":false
        },
        "subscriptionContact":{
            "title":"Subscription Contacts",
            "type":"array",
            "description":"The subscription contacts resource is used to view, create, delete and, update the external party contacts.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-subscriptionContact-item-response"
            }
        },
        "BillToContactNumber":{
            "title":"Bill-to Contact Number",
            "type":"string",
            "description":"The bill-to contact number of the subscription.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "BillToContactNumber1"
                ]
            }
        },
        "PaymentMethod":{
            "title":"Payment Method",
            "maxLength":30,
            "type":"string",
            "description":"The method of payment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DefinitionOrganizationId":{
            "title":"Subscription Inventory Organization",
            "type":"integer",
            "description":"The unique identifier of the master organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PrimaryPartyNumber":{
            "title":"Primary Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The primary party number of the subscription.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "RenewalDurationPeriod":{
            "title":"Renewal Period",
            "maxLength":30,
            "type":"string",
            "description":"The code of the subscription level renewal duration period override that will be used while renewing through automatic or manual renewal.",
            "nullable":true,
            "x-queryable":true
        },
        "RenewalPriceAdjustmentType":{
            "title":"Price Adjustment Type",
            "maxLength":30,
            "type":"string",
            "description":"The renewal price adjustment type.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PricingSegmentExplanation":{
            "title":"Pricing Segment Explanation",
            "maxLength":1000,
            "type":"string",
            "description":"The pricing segment explanation.",
            "nullable":true,
            "x-queryable":false
        },
        "RenewalPriceAdjustmentPercent":{
            "title":"Price Adjustment Value",
            "type":"number",
            "description":"The renewal price adjustment percent.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipToPartyName":{
            "title":"Ship-to Party",
            "type":"string",
            "description":"The party name to which the shipping is to be done.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "ShipToPartyName1"
                ]
            }
        },
        "BillToSite":{
            "title":"Bill-to Site",
            "type":"string",
            "description":"Bill To Site",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ApprovalNote":{
            "title":"Approval Note",
            "maxLength":240,
            "type":"string",
            "description":"The approval note.",
            "nullable":true,
            "x-queryable":false
        },
        "BusinessUnitName":{
            "title":"BU Name",
            "type":"string",
            "description":"The name of the business unit.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "LineAutonumberEnabledYn":{
            "title":"Automate subscription line numbering",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the line auto number is enabled.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "SubscriptionProfileId"
                ]
            }
        },
        "PricingStrategyId":{
            "title":"Pricing Strategy ID",
            "type":"integer",
            "description":"The unique identifier of the pricing strategy.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UsageEventAllowanceInvTemplate":{
            "title":"Allowance",
            "maxLength":200,
            "type":"string",
            "description":"The template used for the usage events allowance rating model.",
            "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 invoice rule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "SubscriptionProfileId"
                ]
            },
            "x-queryable":true
        },
        "RenewedDate":{
            "type":"string",
            "description":"The date on which the subscription was renewed.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "InternalApproval":{
            "title":"Internal Approval",
            "maxLength":30,
            "type":"string",
            "description":"The internal approval.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DefaultLanguage":{
            "type":"string",
            "description":"The default language.",
            "nullable":true,
            "x-queryable":false
        },
        "BillingFrequencyName":{
            "title":"Billing Frequency",
            "type":"string",
            "description":"The billing frequency name.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UserStatusName":{
            "type":"string",
            "description":"The translated user status of the subscription.",
            "nullable":true,
            "x-queryable":false
        },
        "CurrencyName":{
            "title":"Currency",
            "type":"string",
            "description":"The name of subscription currency.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "salesCredits":{
            "title":"Sales Credits",
            "type":"array",
            "description":"The sales credits resource is used to view, create, update, and delete the sales credits defined for subscription or subscription products.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-salesCredits-item-response"
            }
        },
        "BillToContactName":{
            "title":"Bill-to Contact",
            "type":"string",
            "description":"The bill-to contact name of the subscription.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "sortable":false,
                "dependencies":[
                    "BillToContactName1"
                ]
            }
        },
        "ValidateFlag":{
            "title":"Validate subscription during import",
            "type":"boolean",
            "description":"Validate Flag",
            "nullable":true,
            "x-queryable":false
        },
        "EnableAdvBipTemplateFlag":{
            "title":"Enable advanced configuration",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether advanced BIP configuration for usage invoice templates is enabled or not.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "PricingError":{
            "maxLength":2000,
            "type":"string",
            "description":"The error related to pricing.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Contract Attachments

Type: array

Title: Contract Attachments

The contract attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object subscriptions-contractAttachment-item-response

{
    "title":"Contract Attachments",
    "type":"array",
    "description":"The contract attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-contractAttachment-item-response"
    }
}

Nested Schema : Credit Cards

Type: array

Title: Credit Cards

The credit cards resource is used to view, create, and update the credit card information associated with a subscription.

Show Source

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

{
    "title":"Credit Cards",
    "type":"array",
    "description":"The credit cards resource is used to view, create, and update the credit card information associated with a subscription.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-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 subscriptions-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/subscriptions-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 : Parties

Type: array

Title: Parties

The parties resource to view, create, update, and delete the subscription parties.

Show Source

• Array of: object subscriptions-parties-item-response

{
    "title":"Parties",
    "type":"array",
    "description":"The parties resource to view, create, update, and delete the subscription parties.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-parties-item-response"
    }
}

Nested Schema : Products

Type: array

Title: Products

The products resource is used to view, create, update, and delete the product details for a subscription, such as start and end dates, item, unit price, amount, bill-to details, ship-to details, billing frequency, invoice rule, and payment method.

Show Source

• Array of: object subscriptions-products-item-response

{
    "title":"Products",
    "type":"array",
    "description":"The products resource is used to view, create, update, and delete the product details for a subscription, such as start and end dates, item, unit price, amount, bill-to details, ship-to details, billing frequency, invoice rule, and payment method.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-item-response"
    }
}

Nested Schema : Sales Credits

Type: array

Title: Sales Credits

The sales credits resource is used to view, create, update, and delete the sales credits defined for subscription or subscription products.

Show Source

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

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

Nested Schema : Subscription User Actions

Type: array

Title: Subscription User Actions

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

Show Source

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

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

Nested Schema : Subscription Contacts

Type: array

Title: Subscription Contacts

The subscription contacts resource is used to view, create, delete and, update the external party contacts.

Show Source

• Array of: object subscriptions-subscriptionContact-item-response

{
    "title":"Subscription Contacts",
    "type":"array",
    "description":"The subscription contacts resource is used to view, create, delete and, update the external party contacts.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-subscriptionContact-item-response"
    }
}

Nested Schema : Subscription Teams

Type: array

Title: Subscription Teams

The subscription team is used to view the internal and external contacts of the subscription.

Show Source

• Array of: object subscriptions-subscriptionTeam-item-response

{
    "title":"Subscription Teams",
    "type":"array",
    "description":"The subscription team is used to view the internal and external contacts of the subscription.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-subscriptionTeam-item-response"
    }
}

Nested Schema : Supporting Document Attachments

Type: array

Title: Supporting Document Attachments

The supporting document attachments resource is used to view, create, and update supporting document attachments.

Show Source

• Array of: object subscriptions-supportingDocumentAttachments-item-response

{
    "title":"Supporting Document Attachments",
    "type":"array",
    "description":"The supporting document attachments resource is used to view, create, and update supporting document attachments.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-supportingDocumentAttachments-item-response"
    }
}

Nested Schema : Validate Subscriptions

Type: array

Title: Validate Subscriptions

The validate subscriptions resource to view, create, update, and delete the validation errors for a subscription.

Show Source

• Array of: object subscriptions-validateSubscription-item-response

{
    "title":"Validate Subscriptions",
    "type":"array",
    "description":"The validate subscriptions resource to view, create, update, and delete the validation errors for a subscription.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-validateSubscription-item-response"
    }
}

Nested Schema : subscriptions-contractAttachment-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

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

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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 : subscriptions-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 record.
• CreationDate: string (date-time)
  Read Only: true

  The date when the record was created.
• CreditCardId: integer (int64)
  The unique identifier of the credit card.
• CreditCardPuid: string
  Maximum Length: 120

  The credit card PUID.
• 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 record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Maximum Length: 32

  The login of the user who last updated the record.
• 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 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 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 record 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 credit card PUID.",
            "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 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 associated with the credit card.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "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 record 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 of the user who last updated the record.",
            "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 : subscriptions-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.
• SubscriptionId: integer (int64)
  The subscription header flexfield ID.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The subscription header flexfield ID.",
            "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 : subscriptions-parties-item-response

Type: object

Show Source

• contacts: array Contacts
  Title: Contacts

  The contacts resource to view, create, update, and delete the contacts in a subscription party.
• ContactsPresent: string
  Indicates if the subscription has at least one party contact.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date when the party was created.
• EnablePrimary: boolean
  Title: Enable Primary

  Indicates whether party can be enabled as primary or not.
• InternalFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the party is internal or not.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  The object version number.
• PartyId: integer (int64)
  Title: Party ID

  The unique identifier of the party.
• PartyName: string
  Title: Name

  The name of the party.
• PartyNumber: string
  Title: Party Number

  The alternate identifier of the party.
• PartyPuid: string
  Title: Party Number

  Maximum Length: 120

  The alternate identifier of the party.
• PartyRole: string
  Title: Role

  Maximum Length: 20

  The role of the party.
• PrimaryFlag: boolean
  Title: Primary

  Maximum Length: 1

  Default Value: false

  Indicates whether the party is primary or not.
• smartActions: array Subscription User Actions
  Title: Subscription User Actions

  The smart actions resource stores the endpoint and security details for every user action.
• SubscriptionId: integer (int64)
  The unique identifier of the subscription.
• SubscriptionPartyId: integer (int64)
  Title: Party ID

  The unique identifier of the subscription party.
• UpdateFlag: boolean
  Title: Update Flag

  Indicates whether update is allowed on party or not.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the party was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyRole":{
            "title":"Role",
            "maxLength":20,
            "type":"string",
            "description":"The role of the party.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the party is primary or not.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "InternalFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the party is internal or not.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "EnablePrimary":{
            "title":"Enable Primary",
            "type":"boolean",
            "description":"Indicates whether party can be enabled as primary or not.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionPartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the subscription party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Name",
            "type":"string",
            "description":"The name of the party.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "smartActions":{
            "title":"Subscription User Actions",
            "type":"array",
            "description":"The smart actions resource stores the endpoint and security details for every user action.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-parties-smartActions-item-response"
            }
        },
        "PartyNumber":{
            "title":"Party Number",
            "type":"string",
            "description":"The alternate identifier of the party.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactsPresent":{
            "type":"string",
            "description":"Indicates if the subscription has at least one party contact.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Update Flag",
            "type":"boolean",
            "description":"Indicates whether update is allowed on party or not.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number.",
            "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"
            }
        },
        "PartyPuid":{
            "title":"Party Number",
            "maxLength":120,
            "type":"string",
            "description":"The alternate identifier of the party.",
            "nullable":false,
            "x-queryable":true
        },
        "contacts":{
            "title":"Contacts",
            "type":"array",
            "description":"The contacts resource to view, create, update, and delete the contacts in a subscription party.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-parties-contacts-item-response"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the party 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 party.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Contacts

Type: array

Title: Contacts

The contacts resource to view, create, update, and delete the contacts in a subscription party.

Show Source

• Array of: object subscriptions-parties-contacts-item-response

{
    "title":"Contacts",
    "type":"array",
    "description":"The contacts resource to view, create, update, and delete the contacts in a subscription party.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-parties-contacts-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 : Subscription User Actions

Type: array

Title: Subscription User Actions

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

Show Source

• Array of: object subscriptions-parties-smartActions-item-response

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

Nested Schema : subscriptions-parties-contacts-item-response

Type: object

Show Source

• AccessLevel: string
  Maximum Length: 302

  The access level of the contact.
• BillingOwnerFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether this contact is a billing owner or not.
• ContactEmail: string
  Title: Email

  The contact's email address.
• ContactId: integer (int64)
  The unique identifier of the contact.
• ContactName: string
  Title: Name

  The contact name.
• ContactNumber: string
  Title: Party Contact Number

  The contact number.
• ContactPuid: string
  Maximum Length: 120

  The alternate subscription contact.
• ContactRole: string
  Title: Role

  Maximum Length: 30

  The contact role.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date when the contact was created.
• EndDate: string (date)
  The end date of the contact.
• InternalFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether this contact is internal or not.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  The object version number.
• OwnerFlag: boolean
  Title: Owner

  Maximum Length: 1

  Default Value: false

  Indicates whether the contact is the owner.
• PartyId: integer
  The unique identifier of the party.
• PartyNumber: string
  Title: Party Number

  Maximum Length: 120

  Party Number
• PartyPuid: string
  Title: Party Number

  Maximum Length: 120

  Party PUID
• PartyRole: string
  Title: Role

  Maximum Length: 20

  Party Role
• StartDate: string (date)
  The start date of the contact.
• SubscriptionContactId: integer (int64)
  The unique identifier of the subscription contact.
• SubscriptionId: integer (int64)
  The unique identifier of the subscription.
• SubscriptionNumber: string
  Title: Subscription Number

  Maximum Length: 120

  Subscription Number
• SubscriptionPartyId: integer (int64)
  The unique identifier of the subscription party.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the contact was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriptionPartyId":{
            "type":"integer",
            "description":"The unique identifier of the subscription party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContactId":{
            "type":"integer",
            "description":"The unique identifier of the contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContactRole":{
            "title":"Role",
            "maxLength":30,
            "type":"string",
            "description":"The contact role.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The start date of the contact.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ContactPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The alternate subscription contact.",
            "nullable":false,
            "x-queryable":true
        },
        "ContactNumber":{
            "title":"Party Contact Number",
            "type":"string",
            "description":"The contact number.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "sortable":false
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyRole":{
            "title":"Role",
            "maxLength":20,
            "type":"string",
            "description":"Party Role",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriptionNumber":{
            "title":"Subscription Number",
            "maxLength":120,
            "type":"string",
            "description":"Subscription Number",
            "nullable":true,
            "x-queryable":false
        },
        "OwnerFlag":{
            "title":"Owner",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the contact is the owner.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "InternalFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this contact is internal or not.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"The end date of the contact.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AccessLevel":{
            "maxLength":302,
            "type":"string",
            "description":"The access level of the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Party Number",
            "maxLength":120,
            "type":"string",
            "description":"Party Number",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party.",
            "nullable":true,
            "x-queryable":false
        },
        "ContactEmail":{
            "title":"Email",
            "type":"string",
            "description":"The contact's email address.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyPuid":{
            "title":"Party Number",
            "maxLength":120,
            "type":"string",
            "description":"Party PUID",
            "nullable":true,
            "x-queryable":true
        },
        "BillingOwnerFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this contact is a billing owner or not.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ContactName":{
            "title":"Name",
            "type":"string",
            "description":"The contact name.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the contact 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 contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriptionContactId":{
            "type":"integer",
            "description":"The unique identifier of the subscription contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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 : subscriptions-parties-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 Navigation
  Title: User Action Navigation

  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 Request Payload
  Title: User Action Request Payload

  The user action request payload resource stores the payload information for every user action request.
• UserActionURLBinding: array User Action URL Binding
  Title: User Action URL Binding

  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 URL Binding",
            "type":"array",
            "description":"The user action URL binding resource stores the binding metadata for a variable in the URL.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-parties-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 Navigation",
            "type":"array",
            "description":"The user action navigation resource stores the UI navigation metadata striped by app usage.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-parties-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 Request Payload",
            "type":"array",
            "description":"The user action request payload resource stores the payload information for every user action request.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-parties-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 Navigation

Type: array

Title: User Action Navigation

The user action navigation resource stores the UI navigation metadata striped by app usage.

Show Source

• Array of: object subscriptions-parties-smartActions-UserActionNavigation-item-response

{
    "title":"User Action Navigation",
    "type":"array",
    "description":"The user action navigation resource stores the UI navigation metadata striped by app usage.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-parties-smartActions-UserActionNavigation-item-response"
    }
}

Nested Schema : User Action Request Payload

Type: array

Title: User Action Request Payload

The user action request payload resource stores the payload information for every user action request.

Show Source

• Array of: object subscriptions-parties-smartActions-UserActionRequestPayload-item-response

{
    "title":"User Action Request Payload",
    "type":"array",
    "description":"The user action request payload resource stores the payload information for every user action request.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-parties-smartActions-UserActionRequestPayload-item-response"
    }
}

Nested Schema : User Action URL Binding

Type: array

Title: User Action URL Binding

The user action URL binding resource stores the binding metadata for a variable in the URL.

Show Source

• Array of: object subscriptions-parties-smartActions-UserActionURLBinding-item-response

{
    "title":"User Action URL Binding",
    "type":"array",
    "description":"The user action URL binding resource stores the binding metadata for a variable in the URL.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-parties-smartActions-UserActionURLBinding-item-response"
    }
}

Nested Schema : subscriptions-parties-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 : subscriptions-parties-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 : subscriptions-parties-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"
    }
}

Nested Schema : subscriptions-products-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 accounting rule name.
• AlignBillingDay: number
  Title: Align Billing Day

  The day part of the aling billing from 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 amend credit method of the product.
• AmendCreditMethodName: string
  The amend credit method name of the product.
• AmendDescription: string
  Title: Amendment Description

  Maximum Length: 2000

  The amend description of the product.
• AmendEffectiveDate: string (date)
  Title: Amendment Effective Date

  The amend effective date of the product.
• AmendReason: string
  Title: Amendment Reason

  Maximum Length: 30

  The amend reason of the product.
• AmendReasonName: string
  The amend reason name of the product.
• 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 suspension period 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 billing date code.
• BillingDateName: string
  The billing date name.
• BillingFrequency: string
  Title: Billing Frequency

  Maximum Length: 30

  The billing frequency.
• BillingFrequencyName: string
  Title: Billing Frequency

  The billing frequency name.
• 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.
• BillOnDay: number
  Title: Bill on Day

  The bill on day.
• BillToAccountDescription: string
  The bill-to account description.
• BillToAccountId: integer (int64)
  Title: Account Id

  The unique identifier of the bill-to account.
• BillToAccountNumber: string
  Title: Billing Account

  Maximum Length: 30

  The bill-to account number.
• 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 name of the subscription product bill-to site.
• 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 canceled amount of the product.
• CanceledDate: string (date)
  Title: Product Canceled Date

  The date on which 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 charges for a subscription.
• CheckActiveExpiredAssetsExists: string
  Indicates whether any underlying assets of the subscription productare active or expired.
• 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 churn probability for the product.
• CloseCreditMethod: string
  Title: Close Credit Method

  Maximum Length: 30

  The close credit method.
• ClosedAmount: number
  Title: Closed Amount

  The closed amount of the product.
• ClosedDate: string (date)
  Title: Product Close Date

  The date on which 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.
• CoverageName: string
  Title: Template Name

  The name of the coverage.
• CoverageScheduleId: integer (int64)
  Title: Coverage Schedule ID

  The coverage schedule.
• coveredLevels: array Covered Levels
  Title: Covered Levels

  The covered levels resource is used to view, create, update, and delete the subscription covered levels.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the product.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the product was created.
• creditCards: array Credit Cards
  Title: Credit Cards

  The credit cards resource is used to view, create, and update the credit card information associated with a subscription.
• CreditedAmount: number
  Title: Credited Amount

  The credited amount of the product.
• CreditType: string
  Title: Credit Type

  Maximum Length: 30

  Indicates the type of credit issued to the customer such as negative invoice or credit memo.
• CurcyConvRateType: string
  Title: Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type.
• Currency: string
  Maximum Length: 15

  The subscription product currency.
• 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 item master organization.
• Description: string
  Title: Product Description

  The subscription product description.
• DisplaySequence: number
  Title: Display Sequence

  The display sequence of the subscription product.
• DocumentTypeId: integer (int64)
  Title: Document Type

  Default Value: 10

  The unique 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 should be dropped while making the product change.
• Duration: integer
  Title: Duration

  The duration of the product.
• 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 early termination penalty name.
• EnableAdvBipTemplateFlag: boolean
  Title: Enable Advanced Configuration

  Maximum Length: 1

  Default Value: false

  Indicates whether advanced BIP configuration for usage invoice templates is enabled or not.
• 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 the billing is done upfront or not.
• EndDate: string (date)
  Title: Product End Date

  The end date of the product.
• 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 of 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 exempt certificate number.
• ExemptReason: string
  Title: Exemption Reason

  Maximum Length: 30

  The exempt reason.
• 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 of the product.
• ExternalRootAssetKey: string
  Title: External Root Asset Key

  Maximum Length: 120

  The external root asset key of the product.
• 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

  Indicates whether the billing schedule must be generated for the full period or not.
• GenerateBillingSchedule: string
  Title: Generate billing schedule for full period

  Maximum Length: 80

  Indicates whether billing schedule is to be generated or not.
• GracePeriod: integer (int64)
  Title: Grace Period in Days

  The grace period associated with the product.
• GroupingRuleNumberUsed: string
  Title: Grouping Rule Number

  Maximum Length: 120

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

  Maximum Length: 1

  Inflight Flag
• InterfaceOffsetDays: integer (int32)
  Title: Billing Interface Offset Days

  The number of offset days set by the interface.
• 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 BIP report template used for the invoice attachments.
• InvoicedAmount: number
  Title: Invoiced Amount

  The invoiced amount of the product.
• InvoiceText: string
  Title: Invoice Text

  Maximum Length: 4000

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

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

  The invoice rule name.
• IsProductCreatedFromAmendFlag: boolean
  Is Product Created From Amend Flag
• ItemUnitOfMeasure: string
  Title: Pricing UOM Code

  Maximum Length: 15

  The item unit of measure.
• 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 product was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the product.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the 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.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MilestoneBasedChargeFlag: boolean
  Milestone Based Charge Flag
• MonthlyRecurringRevenue: number
  Title: MRR

  The monthly recurring revenue of 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 Negotiated Volume Pricing Rules
  Title: Negotiated Volume Pricing Rules

  The negotiated volume pricing rules 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

  The next bill start date of the product.
• NextPricingDate: string (date)
  Title: Next Pricing Date

  The next pricing date of the product.
• 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 output tax classification.
• 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 payment method name.
• PaymentTermsId: integer (int64)
  Title: Payment Terms ID

  The unique identifier of the payment terms.
• PaymentTermsName: string
  Title: Payment Terms

  The payment terms name.
• PenaltyChargeName: string
  The penalty charge name.
• PenaltyValue: number
  Title: Penalty Value

  The penalty value associated with the product.
• 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 subscription product period.
• 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 PO number.
• PrePaymentNumber: integer (int64)
  Title: Prepayment Number

  The prepayment number.
• PriceAdjustmentBasis: string
  Title: Price Adjustment Basis

  Maximum Length: 30

  The basis on which the price is adjusted.
• PriceAdjustmentPercent: number
  Title: Price Adjustment Value

  The percentage of price adjustment.
• PriceAdjustmentType: string
  Title: Price Adjustment Type

  Maximum Length: 30

  The price adjustment type.
• PriceAsOf: string (date)
  Title: Price as of Date

  The price of the product.
• PriceListId: integer (int64)
  Title: Price List

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

  Maximum Length: 120

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

  The price transaction.
• PricingError: string
  Maximum Length: 2000

  The pricing error related to the product.
• PricingSystem: string
  The pricing system of the product.
• PricingTermsAdjustmentPCT: number
  Title: Pricing Term Adjustment Percentage

  The pricing terms adjustment of the product.
• PricingTermsDuration: number
  Title: Pricing Term Duration

  The pricing terms duration of the product.
• PricingTermsPeriod: string
  Title: Pricing Term

  Maximum Length: 15

  The pricing terms period of the product.
• PricingTermsPricingMethod: string
  Title: Pricing Method

  Maximum Length: 30

  The pricing terms pricing method of the product.
• PricingTermsStartDate: string (date)
  Title: Starting On

  The pricing terms start date of the product.
• 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 subscription product change.
• ProductChangeSchedule: string
  Title: Apply Change

  Maximum Length: 30

  The schedule for the subscription product change.
• ProductChangeScheduleFrom: string (date)
  Title: Product Change Schedule Effective Date

  The from of the subscription product change.
• 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

  Quote Id
• QuoteLineId: integer (int64)
  Title: Quote Line ID

  Quote Line Id
• 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 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 ID of the related inventory item of the subscription product.
• RelatedProductDescription: string
  Title: Description

  The related product description.
• RelatedProductName: string
  Title: Product Name

  Maximum Length: 300

  The name of the related inventory item of the 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.
• 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 renewal type.
• 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 on which 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 will be resumed.
• ResumeDuration: integer
  The time duration for which the product will be suspended.
• ResumePeriod: string
  The time period after which the product will be resumed.
• 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 is used to view, create, update, and delete the sales credits defined for subscription or subscription products.
• 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

  Sales Order Line Id
• 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 sales product type.
• serviceResources: array Service Resources
  Title: Service Resources

  The service resources resource 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 ship-to party name.
• 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 ship-to party site name.
• ShipToPartySiteNumber: string
  Title: Ship-to Site Number

  The ship-to party site number of the subscription product.
• smartActions: array Subscription User Actions
  Title: Subscription 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 source key.
• 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 source number.
• SourceSystem: string
  Title: Source System

  Maximum Length: 30

  The source system.
• StartDate: string (date)
  Title: Product Start Date

  The start date of the product.
• Status: string
  Title: Status

  Maximum Length: 30

  Default Value: DRAFT

  The subscription product status.
• StatusMeaning: string
  Title: Product Status

  Read Only: true

  Maximum Length: 80

  The status meaning of the 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.
• SubscriptionProductId: integer (int64)
  The unique identifier of the subscription product.
• SubscriptionProductPuid: string
  Title: Subscription Product Number

  Maximum Length: 120

  The subscription product PUID.
• SummarizedBillingFlag: boolean
  Title: Summarized billing

  Maximum Length: 1

  Indicates if the product uses summarized billing.
• 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

  The credit method used after suspension.
• 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 tax classification meaning.
• TaxError: string
  Title: Tax Error

  Maximum Length: 2000

  The taxation error for the product, if any.
• 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 total contract value.
• TotalUsageCharge: number
  Title: Total Usage Charges

  Read Only: true

  Total Usage Charge
• TransactionTypeName: string
  Title: Transaction Type

  Maximum Length: 30

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

  Maximum Length: 200

  The template used for the regular usage events rating model.
• UsageEventCommitmentInvTemplate: string
  Title: Commitment

  Maximum Length: 200

  The template used for the usage events allowance rating model.
• UsageEventEstimateInvTemplate: string
  Title: Estimate

  Maximum Length: 200

  The template used for the usage events estimate rating model.
• UsageEventRegularInvTemplate: string
  Title: Basic

  Maximum Length: 200

  The template used for the regular usage events commitment rating model.
• 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 next pricing date of the product.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "CurcyConvRateType":{
            "title":"Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion 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 will be resumed.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ChurnProbability":{
            "title":"Churn Probability",
            "type":"number",
            "description":"The churn probability for the product.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceKey":{
            "title":"Source Key",
            "maxLength":120,
            "type":"string",
            "description":"The source key.",
            "nullable":true,
            "x-queryable":false
        },
        "CheckActiveExpiredAssetsExists":{
            "type":"string",
            "description":"Indicates whether any underlying assets of the subscription productare active or expired.",
            "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 subscription product currency.",
            "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":"Sales Order Line Id",
            "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 product.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The subscription product status.",
            "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 product.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SubscriptionProductPuid":{
            "title":"Subscription Product Number",
            "maxLength":120,
            "type":"string",
            "description":"The subscription product PUID.",
            "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 credited amount of the product.",
            "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 payment terms name.",
            "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":"The amend description of the product.",
            "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 charges for a subscription.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-charges-item-response"
            }
        },
        "ShipToPartySiteName":{
            "title":"Ship-to Site",
            "type":"string",
            "description":"The ship-to party site name.",
            "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 suspension period should be auto extended.",
            "nullable":true,
            "x-queryable":false
        },
        "GracePeriod":{
            "title":"Grace Period in Days",
            "type":"integer",
            "description":"The grace period associated with the product.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AmendReasonName":{
            "type":"string",
            "description":"The amend reason name of the product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OutputTaxClassification":{
            "title":"Output Tax Class",
            "maxLength":50,
            "type":"string",
            "description":"The output tax classification.",
            "nullable":true,
            "x-queryable":false
        },
        "MonthlyRecurringRevenue":{
            "title":"MRR",
            "type":"number",
            "description":"The monthly recurring revenue of the product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "enableInGenAI":"true"
            }
        },
        "CanceledAmount":{
            "title":"Canceled Amount",
            "type":"number",
            "description":"The canceled amount of the product.",
            "nullable":true,
            "x-queryable":false
        },
        "QuoteId":{
            "title":"Quote Id",
            "type":"integer",
            "description":"Quote Id",
            "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 used for the usage events allowance rating model.",
            "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 tax classification meaning.",
            "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 billing date code.",
            "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.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-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/subscriptions-products-negotiatedEntitlementPlanCommitments-item-response"
            }
        },
        "PricingTermsDuration":{
            "title":"Pricing Term Duration",
            "type":"number",
            "description":"The pricing terms duration of the product.",
            "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 end date of the product.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "enableInGenAI":"true"
            },
            "x-queryable":true
        },
        "DocumentTypeId":{
            "title":"Document Type",
            "type":"integer",
            "description":"The unique 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 closed amount of the product.",
            "nullable":true,
            "x-queryable":false
        },
        "RelatedProductName":{
            "title":"Product Name",
            "maxLength":300,
            "type":"string",
            "description":"The name of the related inventory item of the 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 unit price of the product.",
            "nullable":true,
            "x-queryable":false
        },
        "ExternalRootAssetKey":{
            "title":"External Root Asset Key",
            "maxLength":120,
            "type":"string",
            "description":"The external root asset key of the product.",
            "nullable":true,
            "x-queryable":true
        },
        "ResumeDuration":{
            "type":"integer",
            "description":"The time duration for which the product will be suspended.",
            "nullable":true,
            "x-queryable":false
        },
        "PriceTransactionOn":{
            "title":"Price Transaction on Date",
            "type":"string",
            "description":"The price transaction.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "GenerateBillingSchedule":{
            "title":"Generate billing schedule for full period",
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether 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 product was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AmendReason":{
            "title":"Amendment Reason",
            "maxLength":30,
            "type":"string",
            "description":"The amend reason of the product.",
            "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 bill-to account number.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "BillingDateName":{
            "type":"string",
            "description":"The billing date name.",
            "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 User Actions",
            "type":"array",
            "description":"The smart actions resource stores the endpoint and security details for every user action.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-smartActions-item-response"
            }
        },
        "RelatedInventoryItemId":{
            "title":"Related Inventory Item ID",
            "type":"integer",
            "description":"The ID of the related inventory item of the 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/subscriptions-products-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":"Negotiated Volume Pricing Rules",
            "type":"array",
            "description":"The negotiated volume pricing rules 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/subscriptions-products-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 aling billing from date of a subscription product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Duration":{
            "title":"Duration",
            "type":"integer",
            "description":"The duration of the product.",
            "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 renewal type.",
            "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 price adjustment type.",
            "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 sales product type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PriceAsOf":{
            "title":"Price as of Date",
            "type":"string",
            "description":"The price of the product.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "CoverageName":{
            "title":"Template Name",
            "type":"string",
            "description":"The name of the coverage.",
            "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":"Is Product Created From Amend Flag",
            "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 schedule for the subscription product change.",
            "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 accounting rule name.",
            "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 pricing terms adjustment of the product.",
            "nullable":true,
            "x-queryable":false
        },
        "TaxError":{
            "title":"Tax Error",
            "maxLength":2000,
            "type":"string",
            "description":"The taxation error for the product, if any.",
            "nullable":true,
            "x-queryable":false
        },
        "InterfaceOffsetDays":{
            "title":"Billing Interface Offset Days",
            "type":"integer",
            "description":"The number of offset days set by the interface.",
            "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 issued to the customer such as negative invoice or credit memo.",
            "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 the 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.",
            "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 exempt certificate number.",
            "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 status meaning of the product.",
            "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/subscriptions-products-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 PO number.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PaymentMethod"
                ]
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the product 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":"Inflight Flag",
            "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 time period after which the product will be resumed.",
            "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 from of the subscription product change.",
            "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.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-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 BIP report template used for the invoice attachments.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SummarizedBillingFlag":{
            "title":"Summarized billing",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the product uses summarized billing.",
            "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 source number.",
            "nullable":true,
            "x-queryable":false
        },
        "PricingTermsPeriod":{
            "title":"Pricing Term",
            "maxLength":15,
            "type":"string",
            "description":"The pricing terms period of the product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CanceledDate":{
            "title":"Product Canceled Date",
            "type":"string",
            "description":"The date on which 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 percentage of price adjustment.",
            "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 of 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 pricing terms pricing method of the product.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "serviceResources":{
            "title":"Service Resources",
            "type":"array",
            "description":"The service resources resource is used to view, create, update, and delete the service identifier for a subscription product.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-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 invoiced amount of the product.",
            "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/subscriptions-products-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":"The subscription product description.",
            "nullable":true,
            "x-queryable":false
        },
        "RelatedProductDescription":{
            "title":"Description",
            "type":"string",
            "description":"The related product description.",
            "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 invoice rule name.",
            "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.",
            "nullable":false,
            "x-queryable":true
        },
        "PaymentMethodName":{
            "title":"Payment Method Name",
            "type":"string",
            "description":"The payment method name.",
            "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 of the product.",
            "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/subscriptions-products-flexFields-item-response"
            },
            "x-cardinality":"1"
        },
        "EarlyTerminationPenaltyName":{
            "type":"string",
            "description":"The early termination penalty name.",
            "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 total contract value.",
            "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 should be dropped while making the product change.",
            "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 view, create, update, and delete the subscription covered levels.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-coveredLevels-item-response"
            }
        },
        "CloseCreditMethod":{
            "title":"Close Credit Method",
            "maxLength":30,
            "type":"string",
            "description":"The close credit method.",
            "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 template used for the regular usage events commitment rating model.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "InvoiceBipReportCode"
                ]
            },
            "x-queryable":true
        },
        "PenaltyValue":{
            "title":"Penalty Value",
            "type":"number",
            "description":"The penalty value associated with the product.",
            "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 on which the product was closed.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystem":{
            "title":"Source System",
            "maxLength":30,
            "type":"string",
            "description":"The source system.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductChangeReason":{
            "title":"Change Reason",
            "maxLength":300,
            "type":"string",
            "description":"The reason for the subscription product change.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TransactionTypeName":{
            "title":"Transaction Type",
            "maxLength":30,
            "type":"string",
            "description":"The transaction type name.",
            "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":"Quote Line Id",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillToAccountDescription":{
            "type":"string",
            "description":"The bill-to account description.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "BillToAccountDescription1"
                ]
            }
        },
        "SuspendCreditMethod":{
            "title":"Suspend Credit Method",
            "maxLength":30,
            "type":"string",
            "description":"The credit method used after suspension.",
            "nullable":true,
            "x-queryable":false
        },
        "StartDate":{
            "title":"Product Start Date",
            "type":"string",
            "description":"The start date of the product.",
            "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 exempt reason.",
            "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 pricing terms start date of the product.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "PriceAdjustmentBasis":{
            "title":"Price Adjustment Basis",
            "maxLength":30,
            "type":"string",
            "description":"The basis on 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":"Milestone Based Charge Flag",
            "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.",
            "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 item unit of measure.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BillToSiteName":{
            "title":"Bill-to Site",
            "maxLength":255,
            "type":"string",
            "description":"The name of the subscription product bill-to site.",
            "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":"The coverage schedule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UsageEventEstimateInvTemplate":{
            "title":"Estimate",
            "maxLength":200,
            "type":"string",
            "description":"The template used for the usage events estimate rating model.",
            "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 subscription product period.",
            "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/subscriptions-products-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 bill on day.",
            "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 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 card information associated with a subscription.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-creditCards-item-response"
            }
        },
        "GenerateBillFullPeriodFlag":{
            "title":"Generate billing schedule for full period",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the billing schedule must be generated for the full period or not.",
            "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 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 amend credit method of the product.",
            "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 ship-to party name.",
            "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 invoice text.",
            "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 amend credit method name of the product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "NextBillStartDate":{
            "title":"Next Bill Start Date",
            "type":"string",
            "description":"The next bill start date of the product.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "AmendEffectiveDate":{
            "title":"Amendment Effective Date",
            "type":"string",
            "description":"The amend effective date of the product.",
            "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 price list name of the product.",
            "nullable":true,
            "x-queryable":false
        },
        "UsageEventAllowanceInvTemplate":{
            "title":"Allowance",
            "maxLength":200,
            "type":"string",
            "description":"The template used for the regular usage events rating model.",
            "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 on which 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 billing frequency name.",
            "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 is used to view, create, update, and delete the sales credits defined for subscription or subscription products.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-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 or not.",
            "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 related to 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 subscriptions-products-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/subscriptions-products-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.

Show Source

• Array of: object subscriptions-products-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.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-billLines-item-response"
    }
}

Nested Schema : Charges

Type: array

Title: Charges

The charges resource is used to view, create, update, and delete the charges for a subscription.

Show Source

• Array of: object subscriptions-products-charges-item-response

{
    "title":"Charges",
    "type":"array",
    "description":"The charges resource is used to view, create, update, and delete the charges for a subscription.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-charges-item-response"
    }
}

Nested Schema : Covered Levels

Type: array

Title: Covered Levels

The covered levels resource is used to view, create, update, and delete the subscription covered levels.

Show Source

• Array of: object subscriptions-products-coveredLevels-item-response

{
    "title":"Covered Levels",
    "type":"array",
    "description":"The covered levels resource is used to view, create, update, and delete the subscription covered levels.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-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 card information associated with a subscription.

Show Source

• Array of: object subscriptions-products-creditCards-item-response

{
    "title":"Credit Cards",
    "type":"array",
    "description":"The credit cards resource is used to view, create, and update the credit card information associated with a subscription.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-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 subscriptions-products-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/subscriptions-products-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 subscriptions-products-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/subscriptions-products-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 subscriptions-products-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/subscriptions-products-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 subscriptions-products-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/subscriptions-products-negotiatedEntitlementPlanEstimates-item-response"
    }
}

Nested Schema : Negotiated Volume Pricing Rules

Type: array

Title: Negotiated Volume Pricing Rules

The negotiated volume pricing rules 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 subscriptions-products-negotiatedVolumePricingRules-item-response

{
    "title":"Negotiated Volume Pricing Rules",
    "type":"array",
    "description":"The negotiated volume pricing rules 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/subscriptions-products-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 subscriptions-products-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/subscriptions-products-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.

Show Source

• Array of: object subscriptions-products-relationships-item-response

{
    "title":"Relationships",
    "type":"array",
    "description":"The relationships resource is used to view, create, update, and delete the subscription product relationships.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-relationships-item-response"
    }
}

Nested Schema : Sales Credits

Type: array

Title: Sales Credits

The sales credits resource is used to view, create, update, and delete the sales credits defined for subscription or subscription products.

Show Source

• Array of: object subscriptions-products-salesCredits-item-response

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

Nested Schema : Service Resources

Type: array

Title: Service Resources

The service resources resource is used to view, create, update, and delete the service identifier for a subscription product.

Show Source

• Array of: object subscriptions-products-serviceResources-item-response

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

Nested Schema : Subscription User Actions

Type: array

Title: Subscription User Actions

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

Show Source

• Array of: object subscriptions-products-smartActions-item-response

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

Nested Schema : subscriptions-products-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 : subscriptions-products-billLines-item-response

Type: object

Show Source

• AdhocBillLineFlag: boolean
  Default Value: false

  Adhoc BillLine Flag
• Amount: number
  Title: Amount

  The amount of the bill.
• 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.
• BillingPeriod: number
  Title: Sequence

  The billing period.
• BillLineId: integer (int64)
  The unique identifier of the bill line.
• BillLinePuid: string
  Maximum Length: 120

  The bill line PUID.
• 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.
• ChargePeriod: number
  Title: Period

  The charge period.
• ChargePeriodFactor: number
  The change period factor associated with the bill line.
• ChargePuid: string
  Title: Charge PUID

  The charge PUID.
• CoveredLevelId: integer (int64)
  The unique identifier of the coverage level.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date when the bill 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)
  The unique identifier of the customer transaction type sequence.
• DateBilledFrom: string (date)
  Title: Bill-from Date

  The date from which the billing is done.
• DateBilledTo: string (date)
  Title: Bill-to Date

  The date to which the billing is done.
• DateToInterface: string (date)
  Title: Interface Date

  The date to interface.
• InterfacedFlag: boolean
  Title: Interfaced

  Maximum Length: 1

  Default Value: false

  Indicates whether the bill line is interfaced or not.
• InvoiceBillLineId: integer (int64)
  The invoice bill line ID.
• InvoiceDate: string (date)
  The date when the invoice was raised.
• InvoiceText: string
  Title: Invoice Text

  Maximum Length: 240

  The invoice text of the transaction.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• ListPrice: number
  The list price.
• 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 pricing error.
• RecurringFlag: boolean
  Maximum Length: 1

  Indicates whether this 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 of the transaction.
• 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 of the transaction.
• TransactionNumber: string
  Title: Invoice Number

  Maximum Length: 30

  The alternate identifier of the transaction.
• TransactionTax: number
  Title: Tax

  The tax related to the transaction.
• TransactionTypeName: string
  The transaction type name of the subscription bill line.
• TruedUpYn: string
  Maximum Length: 3

  Indicates whether the bill line has a true up period.
• TrxId: integer (int64)
  The transaction identifier associated with the billing.
• TrxLineId: integer (int64)
  The unique identifier of the transaction line.
• UsageAcquiredFlag: boolean
  Maximum Length: 1

  Indicates whether the usage has been acquired or not.
• UsageCaptureDate: string (date)
  Title: Usage Capture Date

  The usage capture date.
• 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 usage line has been priced or not.
• UsageQuantity: number
  Title: Usage Quantity

  The usage quantity.
• UsageRatingProcess: string
  Title: Usage Rating Process

  Maximum Length: 30

  The process used for rating usage.

{
    "type":"object",
    "properties":{
        "TrxId":{
            "type":"integer",
            "description":"The transaction identifier associated with the billing.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the bill 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 charge PUID.",
            "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 usage line has been priced or not.",
            "nullable":true,
            "x-queryable":true
        },
        "UsageRatingProcess":{
            "title":"Usage Rating Process",
            "maxLength":30,
            "type":"string",
            "description":"The process used for rating usage.",
            "nullable":true,
            "x-queryable":true
        },
        "ListPrice":{
            "type":"number",
            "description":"The list price.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionTax":{
            "title":"Tax",
            "type":"number",
            "description":"The tax related to 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 bill line PUID.",
            "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 bill 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.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-billLines-billAdjustments-item-response"
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the bill line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BillingPeriod":{
            "title":"Sequence",
            "type":"number",
            "description":"The billing period.",
            "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.",
            "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 unique identifier of the transaction line.",
            "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 usage capture date.",
            "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 of the user who last updated the bill 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.",
            "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 alternate identifier 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":"The unique identifier of the customer transaction type sequence.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TruedUpYn":{
            "maxLength":3,
            "type":"string",
            "description":"Indicates whether the bill line has a true up 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 invoice text of the transaction.",
            "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 charge period.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionDate":{
            "title":"Invoice Date",
            "type":"string",
            "description":"The date of the transaction.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceBillLineId":{
            "type":"integer",
            "description":"The invoice bill line ID.",
            "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 of the bill.",
            "nullable":true,
            "x-queryable":true
        },
        "DateBilledTo":{
            "title":"Bill-to Date",
            "type":"string",
            "description":"The date to which the billing is done.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "UsageQuantity":{
            "title":"Usage Quantity",
            "type":"number",
            "description":"The usage quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "CoveredLevelId":{
            "type":"integer",
            "description":"The unique identifier of the coverage 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 of the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "RecurringFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this 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 billing is done.",
            "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 pricing error.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the bill 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.

Show Source

• Array of: object subscriptions-products-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.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-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 : subscriptions-products-billLines-billAdjustments-item-response

Type: object

Show Source

• AdjustmentBasis: string
  Title: Basis

  Maximum Length: 30

  The adjustment basis
• AdjustmentName: string
  Title: Adjustment

  Maximum Length: 120

  The adjustment name
• AdjustmentReasonCode: string
  Maximum Length: 30

  The code of the adjustment reason.
• AdjustmentType: string
  Title: Type

  Maximum Length: 30

  The adjustment type
• AdjustmentValue: number
  Title: Value

  The adjustment value
• AutoAdjustmentFlag: boolean
  Maximum Length: 3

  Flag indicating whether the adjustment is automatic or not
• BasisEnableFlag: boolean
  Indicates if the basis has been enabled for the bill.
• BillAdjustmentId: integer (int64)
  The bill adjustment ID
• BillAdjustmentPuid: string
  Maximum Length: 120

  The bill adjustment PUID
• BillLineId: integer (int64)
  The bill line ID
• ChargeAdjustmentId: integer (int64)
  The charge adjustment ID
• ChargeAdjustmentPuid: string
  Title: Charge Adjustment PUID

  Maximum Length: 120

  Charge Adjustment Puid
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The created by
• CreationDate: string (date-time)
  Read Only: true

  The creation date
• CurrencyCode: string
  The currency code. 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.
• Effectivity: string
  Maximum Length: 30

  The adjustment effectivity
• LastUpdateDate: string (date-time)
  Read Only: true

  The last update date
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The last updated by
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The last update login
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NumberOfPeriods: number
  The number of periods
• PeriodFrom: number
  The period from
• PeriodUntil: number
  The period until
• Reason: string
  Title: Reason Details

  Maximum Length: 120

  The adjustment reason
• 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
• SubscriptionId: integer (int64)
  The subscription ID
• SubscriptionProductId: integer (int64)
  The subscription product ID

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The creation date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AutoAdjustmentFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Flag indicating whether the adjustment is automatic or not",
            "nullable":false,
            "x-queryable":true
        },
        "AdjustmentBasis":{
            "title":"Basis",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment basis",
            "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 adjustment reason",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "type":"string",
            "description":"The currency code. 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
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The subscription ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"number",
            "description":"The sequence number",
            "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 subscription product ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillAdjustmentPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The bill adjustment PUID",
            "nullable":false,
            "x-queryable":true
        },
        "PeriodUntil":{
            "type":"number",
            "description":"The period until",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodFrom":{
            "type":"number",
            "description":"The period from",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The last updated by",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BillAdjustmentId":{
            "type":"integer",
            "description":"The bill adjustment ID",
            "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 created by",
            "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 charge adjustment ID",
            "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 adjustment effectivity",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment type",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdjustmentValue":{
            "title":"Value",
            "type":"number",
            "description":"The adjustment value",
            "nullable":false,
            "x-queryable":true
        },
        "BillLineId":{
            "type":"integer",
            "description":"The bill line ID",
            "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 adjustment name",
            "nullable":true,
            "x-queryable":true
        },
        "BasisEnableFlag":{
            "type":"boolean",
            "description":"Indicates if the basis has been enabled for the bill.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The last update date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The last update login",
            "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 : subscriptions-products-charges-item-response

Type: object

Show Source

• adjustments: array Adjustments
  Title: Adjustments

  The adjustments resource is used to view, create, update, and delete any adjustments to the subscription charge.
• AggregationMethod: string
  Title: Aggregation Method

  Maximum Length: 30

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

  The allowance
• 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 bill line ID
• BlockSize: number
  Title: Block Size

  The block size
• chargeComponents: array Subscription Charge Component Records
  Title: Subscription Charge Component Records

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

  Maximum Length: 30

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

  The charge definition name
• ChargeId: integer (int64)
  The charge ID
• 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 charge name
• 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 charge PUID
• chargeTiers: array Charge Tiers
  Title: Charge Tiers

  The charge tiers resource is used to view, create, update, and delete the subscription charge tier details for a subscription.
• CoveredLevelId: integer (int64)
  Title: Covered Level ID

  The unique identifier of the covered level.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The created by
• CreationDate: string (date-time)
  Read Only: true

  The creation date
• 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
• 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 last update date
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The last updated by
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The last update login
• 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
• PricePeriodicity: string
  Title: Periodicity

  Maximum Length: 30

  The price periodicity
• PricePeriodicityName: string
  Title: Periodicity

  The price periodicity name
• PriceType: string
  Title: Price Type

  Maximum Length: 30

  The price type
• 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 charges are rolled up.
• SequenceNumber: integer (int32)
  Title: Sequence Number

  The sequence number
• SubscriptionId: integer (int64)
  Title: Subscription ID

  The subscription ID
• SubscriptionProductId: integer (int64)
  Title: Subscription Product ID

  The subscription product ID
• TieredFlag: boolean
  Title: Tiered

  Maximum Length: 3

  The flag indicating 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 tier type
• TrueUpPeriod: string
  Title: True Up Period

  Maximum Length: 30

  Default Value: ORA_OSS_USAGE_BILLING_PERIOD

  The identifier of the true up period.
• TrueUpPeriodName: string
  Title: True Up Period

  The name of the true up period.
• UnitListPrice: number
  Title: List Price

  The unit list price
• UsagePriceLockFlag: boolean
  Title: Usage Price Lock

  Maximum Length: 3

  Flag indicating 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 creation date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargePuid":{
            "title":"Charge PUID",
            "maxLength":120,
            "type":"string",
            "description":"The charge PUID",
            "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/subscriptions-products-charges-chargeMilestoneEvents-item-response"
            }
        },
        "adjustments":{
            "title":"Adjustments",
            "type":"array",
            "description":"The adjustments resource is used to view, create, update, and delete any adjustments to the subscription charge.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-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 price periodicity name",
            "nullable":true,
            "x-queryable":true
        },
        "PrePaymentNumber":{
            "title":"Prepayment Number",
            "type":"integer",
            "description":"The prepayment number",
            "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 unit list price",
            "nullable":true,
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence Number",
            "type":"integer",
            "description":"The sequence number",
            "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 subscription product ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The last updated by",
            "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":"Subscription Charge Component Records",
            "type":"array",
            "description":"The subscription charge components records resoure is used to view the details of the subscription charge component records.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-charges-chargeComponents-item-response"
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The created by",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeName":{
            "title":"Charge Name",
            "maxLength":120,
            "type":"string",
            "description":"The charge name",
            "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":"The flag indicating whether the charge has tiers",
            "nullable":true,
            "x-queryable":true
        },
        "UsagePriceLockFlag":{
            "title":"Usage Price Lock",
            "maxLength":3,
            "type":"boolean",
            "description":"Flag indicating 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 for a subscription.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-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",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The last update login",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RollupFlag":{
            "title":"Rollup Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the charges are rolled up.",
            "nullable":true,
            "x-queryable":true
        },
        "TierType":{
            "title":"Tier Type",
            "maxLength":30,
            "type":"string",
            "description":"The tier type",
            "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 charge definition name",
            "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 subscription ID",
            "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 true up period.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ExternalKey":{
            "title":"External Key",
            "maxLength":120,
            "type":"string",
            "description":"The external key",
            "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",
            "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",
            "nullable":true,
            "x-queryable":true
        },
        "TrueUpPeriod":{
            "title":"True Up Period",
            "maxLength":30,
            "type":"string",
            "description":"The identifier of the true up period.",
            "nullable":true,
            "default":"ORA_OSS_USAGE_BILLING_PERIOD",
            "x-queryable":true
        },
        "BillLineId":{
            "type":"integer",
            "description":"The bill line ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The charge ID",
            "format":"int64",
            "nullable":false,
            "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 last update date",
            "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 any adjustments to the subscription charge.

Show Source

• Array of: object subscriptions-products-charges-adjustments-item-response

{
    "title":"Adjustments",
    "type":"array",
    "description":"The adjustments resource is used to view, create, update, and delete any adjustments to the subscription charge.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-charges-adjustments-item-response"
    }
}

Nested Schema : Subscription Charge Component Records

Type: array

Title: Subscription Charge Component Records

The subscription charge components records resoure is used to view the details of the subscription charge component records.

Show Source

• Array of: object subscriptions-products-charges-chargeComponents-item-response

{
    "title":"Subscription Charge Component Records",
    "type":"array",
    "description":"The subscription charge components records resoure is used to view the details of the subscription charge component records.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-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 subscriptions-products-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/subscriptions-products-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 for a subscription.

Show Source

• Array of: object subscriptions-products-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 for a subscription.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-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 : subscriptions-products-charges-adjustments-item-response

Type: object

Show Source

• AdjustmentBasis: string
  Title: Basis

  Maximum Length: 30

  The adjustment basis
• AdjustmentName: string
  Title: Adjustment

  Maximum Length: 120

  The adjustment name
• 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 adjustment type
• AdjustmentValue: number
  Title: Value

  The adjustment value
• AutoAdjustmentFlag: boolean
  Maximum Length: 3

  Flag indicating whether the adjustment is automatic or not
• ChargeAdjustmentId: integer (int64)
  The charge adjustment ID
• ChargeAdjustmentPuid: string
  Maximum Length: 120

  The charge adjustment PUID
• ChargeId: integer (int64)
  The charge ID
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The created by
• CreationDate: string (date-time)
  Read Only: true

  The creation date
• Effectivity: string
  Title: Effectivity

  Maximum Length: 30

  The adjustment effectivity
• LastUpdateDate: string (date-time)
  Read Only: true

  The last update date
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The last updated by
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The last update login
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NumberOfPeriods: number
  The number of periods
• ObjectVersionNumber: integer (int32)
  Object version number
• PeriodFrom: number
  The period from
• PeriodUntil: number
  The period until
• Reason: string
  Title: Reason Description

  Maximum Length: 120

  The adjustment reason
• SequenceNumber: integer (int32)
  Title: Sequence

  The sequence number
• SubscriptionId: integer (int64)
  The subscription ID
• SubscriptionProductId: integer (int64)
  The subscription product ID

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The creation date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AutoAdjustmentFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Flag indicating whether the adjustment is automatic or not",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentBasis":{
            "title":"Basis",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment basis",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Reason":{
            "title":"Reason Description",
            "maxLength":120,
            "type":"string",
            "description":"The adjustment reason",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The subscription ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object version number",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"integer",
            "description":"The sequence number",
            "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 subscription product ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PeriodUntil":{
            "type":"number",
            "description":"The period until",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodFrom":{
            "type":"number",
            "description":"The period from",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The last updated by",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The created by",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeAdjustmentPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The charge adjustment PUID",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeAdjustmentId":{
            "type":"integer",
            "description":"The charge adjustment ID",
            "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 adjustment type",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdjustmentValue":{
            "title":"Value",
            "type":"number",
            "description":"The adjustment value",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The charge ID",
            "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 adjustment name",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The last update date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The last update login",
            "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 : subscriptions-products-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 : subscriptions-products-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

  The PUID of the bill line associated with the milestone event.
• ChargeId: integer (int64)
  The charge ID with which the milestone event is associated.
• ChargePuid: string
  Maximum Length: 120

  Default Value: Charges.ChargePuid

  The PUID of the charge to which the milestone event is associated.
• CompletionDate: string (date)
  The completion date of the milestone event.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The login which 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 last 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 last 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 which 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":"The PUID of the bill line associated with the milestone event.",
            "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 : subscriptions-products-charges-chargeTiers-item-response

Type: object

Show Source

• AdditionalNumberFive: number
  Title: Additional Number Five

  The additional number five
• AdditionalNumberFour: number
  Title: Additional Number Four

  The additional number four
• AdditionalNumberOne: number
  Title: Additional Number One

  The additional number one
• AdditionalNumberSix: number
  Title: Additional Number Six

  The additional number six
• AdditionalNumberThree: number
  Title: Additional Number Three

  The additional number three
• AdditionalNumberTwo: number
  Title: Additional Number Two

  The additional number two
• AdditionalTextOne: string
  Title: Additional Text One

  Maximum Length: 4000

  The additional text one
• AdditionalTextTwo: string
  Title: Additional Text Two

  Maximum Length: 4000

  The additional text two
• AdditionalTimestampOne: string (date-time)
  Title: Additional Time-stamp One

  The additional timestamp one
• AdditionalTimestampThree: string (date-time)
  Title: Additional Time-stamp Three

  The additional timestamp three
• AdditionalTimestampTwo: string (date-time)
  Title: Additional Time-stamp Two

  The additional timestamp two
• AddtionalTextThree: string
  Title: Additional Text Three

  Maximum Length: 4000

  The additional text three
• BlockSize: number
  Title: Block Size

  The block size
• ChargeId: integer (int64)
  The charge ID
• ChargeTierId: integer (int64)
  The charge tier ID
• ChargeTierPuid: string
  Maximum Length: 120

  The charge tier PUID
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The created by
• CreationDate: string (date-time)
  Read Only: true

  The creation date
• LastUpdateDate: string (date-time)
  Read Only: true

  The last update date
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The last updated by
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The last update login
• 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 price format
• SequenceNumber: number
  The sequence number
• SubscriptionId: integer (int64)
  The subscription ID
• SubscriptionProductId: integer (int64)
  The subscription product ID
• TierFrom: number
  Title: Tier From

  The tier from
• TierTo: number
  Title: Tier To

  The tier to

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The creation date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdditionalTimestampTwo":{
            "title":"Additional Time-stamp Two",
            "type":"string",
            "description":"The additional timestamp two",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeTierPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The charge tier PUID",
            "nullable":false,
            "x-queryable":true
        },
        "AdditionalNumberThree":{
            "title":"Additional Number Three",
            "type":"number",
            "description":"The additional number three",
            "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":"The additional number five",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The subscription ID",
            "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":"The additional text three",
            "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 subscription product ID",
            "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":"The additional number two",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The last updated by",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeTierId":{
            "type":"integer",
            "description":"The charge tier ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The created by",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdditionalNumberFour":{
            "title":"Additional Number Four",
            "type":"number",
            "description":"The additional number four",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalTimestampOne":{
            "title":"Additional Time-stamp One",
            "type":"string",
            "description":"The additional timestamp one",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PriceFormat":{
            "title":"Price Format",
            "maxLength":30,
            "type":"string",
            "description":"The price format",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdditionalTextOne":{
            "title":"Additional Text One",
            "maxLength":4000,
            "type":"string",
            "description":"The additional text one",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalNumberSix":{
            "title":"Additional Number Six",
            "type":"number",
            "description":"The additional number six",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalNumberOne":{
            "title":"Additional Number One",
            "type":"number",
            "description":"The additional number one",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalTextTwo":{
            "title":"Additional Text Two",
            "maxLength":4000,
            "type":"string",
            "description":"The additional text two",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalTimestampThree":{
            "title":"Additional Time-stamp Three",
            "type":"string",
            "description":"The additional timestamp three",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The charge ID",
            "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 last update date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The last update login",
            "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 : subscriptions-products-coveredLevels-item-response

Type: object

Show Source

• Address: string
  Title: Address

  The address of the party site associated with child covered level.
• 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 universal serial number associated with 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.
• CalculatedCreditAmount: number
  Title: Calculated Credit Amount

  The calculated credit amount of the child covered level.
• CalculateEstimatedTaxFlag: boolean
  Indicates whether estimated tax will be calculated for the subscription child covered level.
• CancelDescription: string
  Title: Cancellation Description

  Maximum Length: 2000

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

  The amount that was cancelled.
• CanceledDate: string (date)
  Title: Canceled Date

  The date of cancellation.
• CancelReason: string
  Title: Cancellation Reason

  Maximum Length: 30

  The reason for cancellation.
• charges: array Charges
  Title: Charges

  The charges resource is used to view, create, update, and delete the charges for a subscription.
• childCoveredLevels: array Child Covered Levels
  Title: Child Covered Levels

  The child covered levels resource is used to view, create, update, and delete the subscription child covered levels.
• ClosedAmount: number
  Title: Closed Amount

  The amount when 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 child covered level.
• CloseReason: string
  Title: Covered Level Close Reason

  Maximum Length: 30

  The reason when the covered level was closed.
• CorpCurrencyCode: string
  Title: Currency Code

  Maximum Length: 15

  The corporate currency code associated with the account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• 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 covered parent for the 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 associated with child covered level.
• CoveredLevlNumber: string
  Title: Covered Level Number

  The alternate identifier of the covered level associated with child covered level.
• 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.
• CreditedAmount: number
  Title: Credited Amount

  The credited amount for the covered level.
• CreditType: string
  Title: Credit Type

  Maximum Length: 30

  Indicates the type of credit issued to the customer such as negative invoice or credit memo.
• CurcyConvRateType: string
  Title: Conversion Rate Type

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

  Maximum Length: 15

  The currency code. 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 associated with child covered level.
• CustomerName: string
  Title: Customer Account

  The name of the customer associated with child covered level.
• CustomerNumber: string
  Title: Customer Account Number

  The alternate unique identifier of the customer associated with child covered level.
• Description: string
  Title: Covered Level Description

  The description of the covered level.
• Duration: integer
  The duration for which the covered level is active.
• EndDate: string (date)
  Title: Covered Level End Date

  The end date for the covered level.
• ExplodeAssetHierarchy: string
  The explode hierarchy for the asset.
• GenBillSchReqdFlag: boolean
  Title: Billing schedule update required

  Maximum Length: 1

  Generate Bill Schedule Required Flag
• GenerateBillingSchedule: string
  The schedule by the bill is generated.
• HierarchyTotal: number
  The total when the covered level was closed.
• InventoryItemId: integer (int64)
  Title: Item ID

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

  The invoiced amount.
• InvoiceText: string
  Maximum Length: 2000

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

  Maximum Length: 15

  The unit of measure used by the item.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

  Maximum Length: 32

  The login of the user who last updated the record.
• 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 child 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 parent level for the level.
• PartyId: integer (int64)
  Title: Party ID

  The unique identifier of the party associated with child covered level.
• PartyName: string
  Title: Party Name

  The name of the party associated with child covered level.
• PartyNumber: string
  Title: Party Number

  The alternate identifier of the party associated with child covered level.
• PartySite: string
  Title: Party Site Number

  The name of the party site associated with child covered level.
• PartySiteId: integer (int64)
  Title: Party Site ID

  The unique identifier of the party site associated with child covered level.
• Period: string
  Maximum Length: 80

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

  The price of the covered level.
• 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 by the item.
• PriceUnitOfMeasureName: string
  Title: Pricing UOM

  The name of the unit of measure.
• PricingError: string
  Title: Pricing Error

  Maximum Length: 1000

  Any errors associated with the pricing.
• 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.
• PutOnHoldFlag: boolean
  Indicates if the covered level has been put on hold.
• Quantity: number
  Title: Quantity

  Default Value: 1

  The quantity for which the bill line was charged.
• relationships: array Relationships
  Title: Relationships

  The relationships resource is used to view, create, update, and delete the subscription product relationships.
• RemoveHoldFlag: boolean
  Indicates if the covered level's hold has to be removed.
• RenewalType: string
  Title: Renewal Type

  Maximum Length: 30

  The type of renewal.
• RenewedDate: string (date)
  Title: Renewed On

  The date when the covered level was renewed.
• RepriceFlag: boolean
  Indicates whether the subscription child covered level should be repriced or not. If passed as 'true', the subscription child covered level 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 return method for the credit after the covered level was closed.
• RevenueOption: string
  Title: Revenue Accounting Option

  Maximum Length: 30

  Revenue Option
• RollupTotal: number
  Title: Configured Asset Amount

  The total when the covered level was closed.
• SerialNumber: string
  Title: Covered Asset Serial Number

  Read Only: true

  Maximum Length: 80

  The serial number of the child covered level.
• SourceKey: string
  Title: Source Key

  Maximum Length: 120

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

  Maximum Length: 120

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

  Maximum Length: 120

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

  Maximum Length: 120

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

  Maximum Length: 30

  The source system of the child covered level.
• StartDate: string (date)
  Title: Covered Level Start Date

  The start date for the covered level.
• Status: string
  Title: Covered Level Status

  Maximum Length: 30

  The status of the covered level.
• StatusName: string
  Title: Status

  The description of the status.
• SubscriptionId: integer (int64)
  Title: Subscription ID

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

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

  The suppressed amount for the credit.
• SuspendCreditMethod: string
  Title: Suspend Credit Method

  Maximum Length: 30

  The suspend method for the credit after the covered level was closed.
• 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 when the covered level was suspended.
• TaxAmount: number
  Title: Tax Amount

  The amount of tax to be deducted.
• TaxError: string
  Maximum Length: 4000

  The tax error for the covered level.
• TotalContractValue: number
  Title: Covered Level Contract Value

  The total contract value
• Type: string
  Title: Type

  Maximum Length: 30

  The type of the covered level.
• TypeName: string
  Title: Covered Level Type

  The type name associated with the covered level.
• UnitPrice: number
  Title: Unit Price

  The unit price of the covered level associated with child covered level.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the record 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 child covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "Address":{
            "title":"Address",
            "type":"string",
            "description":"The address of the party site associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CancelDescription":{
            "title":"Cancellation Description",
            "maxLength":2000,
            "type":"string",
            "description":"The cancel description associated with a child covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Conversion Rate Type",
            "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
        },
        "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 total when the covered level was closed.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The currency code. 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.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-coveredLevels-relationships-item-response"
            }
        },
        "TaxAmount":{
            "title":"Tax Amount",
            "type":"number",
            "description":"The amount of tax to be deducted.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceKey":{
            "title":"Source Key",
            "maxLength":120,
            "type":"string",
            "description":"The source key of the child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CloseReason":{
            "title":"Covered Level Close Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason when the covered level was closed.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CoveredLevelParentPuid":{
            "type":"string",
            "description":"The covered parent for the parent.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceNumber":{
            "title":"External Source Number",
            "maxLength":120,
            "type":"string",
            "description":"The source number of the child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "PartySiteId":{
            "title":"Party Site ID",
            "type":"integer",
            "description":"The unique identifier of the party site associated with child covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CanceledDate":{
            "title":"Canceled Date",
            "type":"string",
            "description":"The date of cancellation.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ExplodeAssetHierarchy":{
            "type":"string",
            "description":"The explode hierarchy for the asset.",
            "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 record.",
            "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 record.",
            "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 credited amount for the covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusName":{
            "title":"Status",
            "type":"string",
            "description":"The description of the status.",
            "nullable":true,
            "x-queryable":true
        },
        "charges":{
            "title":"Charges",
            "type":"array",
            "description":"The charges resource is used to view, create, update, and delete the charges for a subscription.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-coveredLevels-charges-item-response"
            }
        },
        "SuppressedCreditAmount":{
            "title":"Suppressed Credit Amount",
            "type":"number",
            "description":"The suppressed amount for the credit.",
            "nullable":true,
            "x-queryable":true
        },
        "childCoveredLevels":{
            "title":"Child Covered Levels",
            "type":"array",
            "description":"The child covered levels resource is used to view, create, update, and delete the subscription child covered levels.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-coveredLevels-childCoveredLevels-item-response"
            }
        },
        "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 invoiced amount.",
            "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 of the user who last updated the record.",
            "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":"The description of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CanceledAmount":{
            "title":"Canceled Amount",
            "type":"number",
            "description":"The amount that was cancelled.",
            "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 associated 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.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-coveredLevels-billLines-item-response"
            }
        },
        "TotalContractValue":{
            "title":"Covered Level Contract Value",
            "type":"number",
            "description":"The total contract value",
            "nullable":true,
            "x-queryable":true
        },
        "SuspendReason":{
            "title":"Covered Level Suspend Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason when the covered level was suspended.",
            "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 when the covered level was closed.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"Covered Level End Date",
            "type":"string",
            "description":"The end date for the covered level.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ClosedAmount":{
            "title":"Closed Amount",
            "type":"number",
            "description":"The amount when the covered level was closed.",
            "nullable":true,
            "x-queryable":true
        },
        "CoveredLevlName":{
            "title":"Covered Level Name",
            "type":"string",
            "description":"The name of the covered level associated with child covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "OverrideCreditAmount":{
            "title":"Override Credit Amount",
            "type":"number",
            "description":"The override credit amount of the child covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "CalculateEstimatedTaxFlag":{
            "type":"boolean",
            "description":"Indicates whether estimated tax will be calculated for the subscription child 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 associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "GenerateBillingSchedule":{
            "type":"string",
            "description":"The schedule by the bill is generated.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the party associated with child covered level.",
            "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 child covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystem":{
            "title":"External Source System",
            "maxLength":30,
            "type":"string",
            "description":"The source system of the child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TypeName":{
            "title":"Covered Level Type",
            "type":"string",
            "description":"The type name associated with the covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ProductName":{
            "title":"Product Name",
            "type":"string",
            "description":"The name of the product.",
            "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/subscriptions-products-coveredLevels-productAssetRelationships-item-response"
            }
        },
        "ParentCoveredLevelId":{
            "title":"Parent Covered Level ID",
            "type":"integer",
            "description":"The parent level for the level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Party Name",
            "type":"string",
            "description":"The name of the party associated with child covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "SuspendCreditMethod":{
            "title":"Suspend Credit Method",
            "maxLength":30,
            "type":"string",
            "description":"The suspend method for the credit after the covered level was closed.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Covered Level Start Date",
            "type":"string",
            "description":"The start date for the covered level.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "CustomerNumber":{
            "title":"Customer Account Number",
            "type":"string",
            "description":"The alternate unique identifier of the customer associated with child covered level.",
            "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 account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemUnitOfMeasure":{
            "title":"UOM",
            "maxLength":15,
            "type":"string",
            "description":"The unit of measure used by the item.",
            "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 during which the covered level is used.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Duration":{
            "type":"integer",
            "description":"The duration for which the covered level is active.",
            "nullable":true,
            "x-queryable":false
        },
        "RenewalType":{
            "title":"Renewal Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of 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 universal serial number associated with the asset.",
            "nullable":true,
            "x-queryable":true
        },
        "CancelReason":{
            "title":"Cancellation Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason for cancellation.",
            "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 child covered level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PriceUnitOfMeasureName":{
            "title":"Pricing UOM",
            "type":"string",
            "description":"The 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 return method for the credit after the covered level was closed.",
            "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 child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CoveredLevlNumber":{
            "title":"Covered Level Number",
            "type":"string",
            "description":"The alternate identifier of the covered level associated with child 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 of the covered level.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PartySite":{
            "title":"Party Site Number",
            "type":"string",
            "description":"The name of the party site associated with child covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "InvoiceText":{
            "maxLength":2000,
            "type":"string",
            "description":"The text to be included in the invoice.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerAccountId":{
            "title":"Customer Account ID",
            "type":"integer",
            "description":"The unique identifier of the customer account associated with child covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaxError":{
            "maxLength":4000,
            "type":"string",
            "description":"The tax error for the covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerName":{
            "title":"Customer Account",
            "type":"string",
            "description":"The name of the customer associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CreditType":{
            "title":"Credit Type",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of credit issued to the customer such as negative invoice or credit memo.",
            "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 child 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 child covered level should be repriced or not. If passed as 'true', the subscription child covered level 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 for which the bill line was charged.",
            "nullable":false,
            "default":1,
            "x-queryable":true
        },
        "PriceUnitOfMeasure":{
            "title":"Pricing UOM",
            "maxLength":30,
            "type":"string",
            "description":"The unit of measure used by the item.",
            "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 associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "RemoveHoldFlag":{
            "type":"boolean",
            "description":"Indicates if the covered level's hold has to be removed.",
            "nullable":true,
            "x-queryable":false
        },
        "PricingError":{
            "title":"Pricing Error",
            "maxLength":1000,
            "type":"string",
            "description":"Any errors associated with the pricing.",
            "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.

Show Source

• Array of: object subscriptions-products-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.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-coveredLevels-billLines-item-response"
    }
}

Nested Schema : Charges

Type: array

Title: Charges

The charges resource is used to view, create, update, and delete the charges for a subscription.

Show Source

• Array of: object subscriptions-products-coveredLevels-charges-item-response

{
    "title":"Charges",
    "type":"array",
    "description":"The charges resource is used to view, create, update, and delete the charges for a subscription.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-coveredLevels-charges-item-response"
    }
}

Nested Schema : Child Covered Levels

Type: array

Title: Child Covered Levels

The child covered levels resource is used to view, create, update, and delete the subscription child covered levels.

Show Source

• Array of: object subscriptions-products-coveredLevels-childCoveredLevels-item-response

{
    "title":"Child Covered Levels",
    "type":"array",
    "description":"The child covered levels resource is used to view, create, update, and delete the subscription child covered levels.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-coveredLevels-childCoveredLevels-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 subscriptions-products-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/subscriptions-products-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.

Show Source

• Array of: object subscriptions-products-coveredLevels-relationships-item-response

{
    "title":"Relationships",
    "type":"array",
    "description":"The relationships resource is used to view, create, update, and delete the subscription product relationships.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-coveredLevels-relationships-item-response"
    }
}

Nested Schema : subscriptions-products-coveredLevels-billLines-item-response

Type: object

Show Source

• AdhocBillLineFlag: boolean
  Default Value: false

  Adhoc BillLine Flag
• Amount: number
  Title: Amount

  The amount of the bill.
• 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.
• BillingPeriod: number
  Title: Sequence

  The billing period.
• BillLineId: integer (int64)
  The unique identifier of the bill line.
• BillLinePuid: string
  Maximum Length: 120

  The bill line PUID.
• 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.
• ChargePeriod: number
  Title: Period

  The charge period.
• ChargePeriodFactor: number
  The change period factor associated with the bill line.
• ChargePuid: string
  Title: Charge PUID

  The charge PUID.
• CoveredLevelId: integer (int64)
  The unique identifier of the coverage level.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date when the bill 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)
  The unique identifier of the customer transaction type sequence.
• DateBilledFrom: string (date)
  Title: Bill-from Date

  The date from which the billing is done.
• DateBilledTo: string (date)
  Title: Bill-to Date

  The date to which the billing is done.
• DateToInterface: string (date)
  Title: Interface Date

  The date to interface.
• InterfacedFlag: boolean
  Title: Interfaced

  Maximum Length: 1

  Default Value: false

  Indicates whether the bill line is interfaced or not.
• InvoiceBillLineId: integer (int64)
  The invoice bill line ID.
• InvoiceDate: string (date)
  The date when the invoice was raised.
• InvoiceText: string
  Title: Invoice Text

  Maximum Length: 240

  The invoice text of the transaction.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• ListPrice: number
  The list price.
• 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 pricing error.
• RecurringFlag: boolean
  Maximum Length: 1

  Indicates whether this 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 of the transaction.
• 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 of the transaction.
• TransactionNumber: string
  Title: Invoice Number

  Maximum Length: 30

  The alternate identifier of the transaction.
• TransactionTax: number
  Title: Tax

  The tax related to the transaction.
• TransactionTypeName: string
  The transaction type name of the subscription bill line.
• TruedUpYn: string
  Maximum Length: 3

  Indicates whether the bill line has a true up period.
• TrxId: integer (int64)
  The transaction identifier associated with the billing.
• TrxLineId: integer (int64)
  The unique identifier of the transaction line.
• UsageAcquiredFlag: boolean
  Maximum Length: 1

  Indicates whether the usage has been acquired or not.
• UsageCaptureDate: string (date)
  Title: Usage Capture Date

  The usage capture date.
• 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 usage line has been priced or not.
• UsageQuantity: number
  Title: Usage Quantity

  The usage quantity.
• UsageRatingProcess: string
  Title: Usage Rating Process

  Maximum Length: 30

  The process used for rating usage.

{
    "type":"object",
    "properties":{
        "TrxId":{
            "type":"integer",
            "description":"The transaction identifier associated with the billing.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the bill 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 charge PUID.",
            "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 usage line has been priced or not.",
            "nullable":true,
            "x-queryable":true
        },
        "UsageRatingProcess":{
            "title":"Usage Rating Process",
            "maxLength":30,
            "type":"string",
            "description":"The process used for rating usage.",
            "nullable":true,
            "x-queryable":true
        },
        "ListPrice":{
            "type":"number",
            "description":"The list price.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionTax":{
            "title":"Tax",
            "type":"number",
            "description":"The tax related to 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 bill line PUID.",
            "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 bill 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.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-coveredLevels-billLines-billAdjustments-item-response"
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the bill line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BillingPeriod":{
            "title":"Sequence",
            "type":"number",
            "description":"The billing period.",
            "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.",
            "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 unique identifier of the transaction line.",
            "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 usage capture date.",
            "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 of the user who last updated the bill 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.",
            "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 alternate identifier 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":"The unique identifier of the customer transaction type sequence.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TruedUpYn":{
            "maxLength":3,
            "type":"string",
            "description":"Indicates whether the bill line has a true up 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 invoice text of the transaction.",
            "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 charge period.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionDate":{
            "title":"Invoice Date",
            "type":"string",
            "description":"The date of the transaction.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceBillLineId":{
            "type":"integer",
            "description":"The invoice bill line ID.",
            "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 of the bill.",
            "nullable":true,
            "x-queryable":true
        },
        "DateBilledTo":{
            "title":"Bill-to Date",
            "type":"string",
            "description":"The date to which the billing is done.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "UsageQuantity":{
            "title":"Usage Quantity",
            "type":"number",
            "description":"The usage quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "CoveredLevelId":{
            "type":"integer",
            "description":"The unique identifier of the coverage 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 of the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "RecurringFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this 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 billing is done.",
            "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 pricing error.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the bill 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.

Show Source

• Array of: object subscriptions-products-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.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-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 : subscriptions-products-coveredLevels-billLines-billAdjustments-item-response

Type: object

Show Source

• AdjustmentBasis: string
  Title: Basis

  Maximum Length: 30

  The adjustment basis
• AdjustmentName: string
  Title: Adjustment

  Maximum Length: 120

  The adjustment name
• AdjustmentReasonCode: string
  Maximum Length: 30

  The code of the adjustment reason.
• AdjustmentType: string
  Title: Type

  Maximum Length: 30

  The adjustment type
• AdjustmentValue: number
  Title: Value

  The adjustment value
• AutoAdjustmentFlag: boolean
  Maximum Length: 3

  Flag indicating whether the adjustment is automatic or not
• BasisEnableFlag: boolean
  Indicates if the basis has been enabled for the bill.
• BillAdjustmentId: integer (int64)
  The bill adjustment ID
• BillAdjustmentPuid: string
  Maximum Length: 120

  The bill adjustment PUID
• BillLineId: integer (int64)
  The bill line ID
• ChargeAdjustmentId: integer (int64)
  The charge adjustment ID
• ChargeAdjustmentPuid: string
  Title: Charge Adjustment PUID

  Maximum Length: 120

  Charge Adjustment Puid
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The created by
• CreationDate: string (date-time)
  Read Only: true

  The creation date
• CurrencyCode: string
  The currency code. 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.
• Effectivity: string
  Maximum Length: 30

  The adjustment effectivity
• LastUpdateDate: string (date-time)
  Read Only: true

  The last update date
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The last updated by
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The last update login
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NumberOfPeriods: number
  The number of periods
• PeriodFrom: number
  The period from
• PeriodUntil: number
  The period until
• Reason: string
  Title: Reason Details

  Maximum Length: 120

  The adjustment reason
• 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
• SubscriptionId: integer (int64)
  The subscription ID
• SubscriptionProductId: integer (int64)
  The subscription product ID

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The creation date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AutoAdjustmentFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Flag indicating whether the adjustment is automatic or not",
            "nullable":false,
            "x-queryable":true
        },
        "AdjustmentBasis":{
            "title":"Basis",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment basis",
            "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 adjustment reason",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "type":"string",
            "description":"The currency code. 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
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The subscription ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"number",
            "description":"The sequence number",
            "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 subscription product ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillAdjustmentPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The bill adjustment PUID",
            "nullable":false,
            "x-queryable":true
        },
        "PeriodUntil":{
            "type":"number",
            "description":"The period until",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodFrom":{
            "type":"number",
            "description":"The period from",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The last updated by",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BillAdjustmentId":{
            "type":"integer",
            "description":"The bill adjustment ID",
            "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 created by",
            "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 charge adjustment ID",
            "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 adjustment effectivity",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment type",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdjustmentValue":{
            "title":"Value",
            "type":"number",
            "description":"The adjustment value",
            "nullable":false,
            "x-queryable":true
        },
        "BillLineId":{
            "type":"integer",
            "description":"The bill line ID",
            "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 adjustment name",
            "nullable":true,
            "x-queryable":true
        },
        "BasisEnableFlag":{
            "type":"boolean",
            "description":"Indicates if the basis has been enabled for the bill.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The last update date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The last update login",
            "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 : subscriptions-products-coveredLevels-charges-item-response

Type: object

Show Source

• adjustments: array Adjustments
  Title: Adjustments

  The adjustments resource is used to view, create, update, and delete any adjustments to the subscription charge.
• AggregationMethod: string
  Title: Aggregation Method

  Maximum Length: 30

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

  The allowance
• 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 bill line ID
• BlockSize: number
  Title: Block Size

  The block size
• chargeComponents: array Subscription Charge Component Records
  Title: Subscription Charge Component Records

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

  Maximum Length: 30

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

  The charge definition name
• ChargeId: integer (int64)
  The charge ID
• 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 charge name
• 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 charge PUID
• chargeTiers: array Charge Tiers
  Title: Charge Tiers

  The charge tiers resource is used to view, create, update, and delete the subscription charge tier details for a subscription.
• CoveredLevelId: integer (int64)
  Title: Covered Level ID

  The unique identifier of the covered level.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The created by
• CreationDate: string (date-time)
  Read Only: true

  The creation date
• 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
• 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 last update date
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The last updated by
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The last update login
• 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
• PricePeriodicity: string
  Title: Periodicity

  Maximum Length: 30

  The price periodicity
• PricePeriodicityName: string
  Title: Periodicity

  The price periodicity name
• PriceType: string
  Title: Price Type

  Maximum Length: 30

  The price type
• 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 charges are rolled up.
• SequenceNumber: integer (int32)
  Title: Sequence Number

  The sequence number
• SubscriptionId: integer (int64)
  Title: Subscription ID

  The subscription ID
• SubscriptionProductId: integer (int64)
  Title: Subscription Product ID

  The subscription product ID
• TieredFlag: boolean
  Title: Tiered

  Maximum Length: 3

  The flag indicating 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 tier type
• TrueUpPeriod: string
  Title: True Up Period

  Maximum Length: 30

  Default Value: ORA_OSS_USAGE_BILLING_PERIOD

  The identifier of the true up period.
• TrueUpPeriodName: string
  Title: True Up Period

  The name of the true up period.
• UnitListPrice: number
  Title: List Price

  The unit list price
• UsagePriceLockFlag: boolean
  Title: Usage Price Lock

  Maximum Length: 3

  Flag indicating 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 creation date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargePuid":{
            "title":"Charge PUID",
            "maxLength":120,
            "type":"string",
            "description":"The charge PUID",
            "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/subscriptions-products-coveredLevels-charges-chargeMilestoneEvents-item-response"
            }
        },
        "adjustments":{
            "title":"Adjustments",
            "type":"array",
            "description":"The adjustments resource is used to view, create, update, and delete any adjustments to the subscription charge.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-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 price periodicity name",
            "nullable":true,
            "x-queryable":true
        },
        "PrePaymentNumber":{
            "title":"Prepayment Number",
            "type":"integer",
            "description":"The prepayment number",
            "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 unit list price",
            "nullable":true,
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence Number",
            "type":"integer",
            "description":"The sequence number",
            "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 subscription product ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The last updated by",
            "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":"Subscription Charge Component Records",
            "type":"array",
            "description":"The subscription charge components records resoure is used to view the details of the subscription charge component records.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-coveredLevels-charges-chargeComponents-item-response"
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The created by",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeName":{
            "title":"Charge Name",
            "maxLength":120,
            "type":"string",
            "description":"The charge name",
            "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":"The flag indicating whether the charge has tiers",
            "nullable":true,
            "x-queryable":true
        },
        "UsagePriceLockFlag":{
            "title":"Usage Price Lock",
            "maxLength":3,
            "type":"boolean",
            "description":"Flag indicating 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 for a subscription.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-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",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The last update login",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RollupFlag":{
            "title":"Rollup Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the charges are rolled up.",
            "nullable":true,
            "x-queryable":true
        },
        "TierType":{
            "title":"Tier Type",
            "maxLength":30,
            "type":"string",
            "description":"The tier type",
            "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 charge definition name",
            "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 subscription ID",
            "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 true up period.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ExternalKey":{
            "title":"External Key",
            "maxLength":120,
            "type":"string",
            "description":"The external key",
            "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",
            "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",
            "nullable":true,
            "x-queryable":true
        },
        "TrueUpPeriod":{
            "title":"True Up Period",
            "maxLength":30,
            "type":"string",
            "description":"The identifier of the true up period.",
            "nullable":true,
            "default":"ORA_OSS_USAGE_BILLING_PERIOD",
            "x-queryable":true
        },
        "BillLineId":{
            "type":"integer",
            "description":"The bill line ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The charge ID",
            "format":"int64",
            "nullable":false,
            "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 last update date",
            "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 any adjustments to the subscription charge.

Show Source

• Array of: object subscriptions-products-coveredLevels-charges-adjustments-item-response

{
    "title":"Adjustments",
    "type":"array",
    "description":"The adjustments resource is used to view, create, update, and delete any adjustments to the subscription charge.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-coveredLevels-charges-adjustments-item-response"
    }
}

Nested Schema : Subscription Charge Component Records

Type: array

Title: Subscription Charge Component Records

The subscription charge components records resoure is used to view the details of the subscription charge component records.

Show Source

• Array of: object subscriptions-products-coveredLevels-charges-chargeComponents-item-response

{
    "title":"Subscription Charge Component Records",
    "type":"array",
    "description":"The subscription charge components records resoure is used to view the details of the subscription charge component records.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-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 subscriptions-products-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/subscriptions-products-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 for a subscription.

Show Source

• Array of: object subscriptions-products-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 for a subscription.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-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 : subscriptions-products-coveredLevels-charges-adjustments-item-response

Type: object

Show Source

• AdjustmentBasis: string
  Title: Basis

  Maximum Length: 30

  The adjustment basis
• AdjustmentName: string
  Title: Adjustment

  Maximum Length: 120

  The adjustment name
• 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 adjustment type
• AdjustmentValue: number
  Title: Value

  The adjustment value
• AutoAdjustmentFlag: boolean
  Maximum Length: 3

  Flag indicating whether the adjustment is automatic or not
• ChargeAdjustmentId: integer (int64)
  The charge adjustment ID
• ChargeAdjustmentPuid: string
  Maximum Length: 120

  The charge adjustment PUID
• ChargeId: integer (int64)
  The charge ID
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The created by
• CreationDate: string (date-time)
  Read Only: true

  The creation date
• Effectivity: string
  Title: Effectivity

  Maximum Length: 30

  The adjustment effectivity
• LastUpdateDate: string (date-time)
  Read Only: true

  The last update date
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The last updated by
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The last update login
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NumberOfPeriods: number
  The number of periods
• ObjectVersionNumber: integer (int32)
  Object version number
• PeriodFrom: number
  The period from
• PeriodUntil: number
  The period until
• Reason: string
  Title: Reason Description

  Maximum Length: 120

  The adjustment reason
• SequenceNumber: integer (int32)
  Title: Sequence

  The sequence number
• SubscriptionId: integer (int64)
  The subscription ID
• SubscriptionProductId: integer (int64)
  The subscription product ID

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The creation date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AutoAdjustmentFlag":{
            "maxLength":3,
            "type":"boolean",
            "description":"Flag indicating whether the adjustment is automatic or not",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentBasis":{
            "title":"Basis",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment basis",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Reason":{
            "title":"Reason Description",
            "maxLength":120,
            "type":"string",
            "description":"The adjustment reason",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The subscription ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object version number",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"integer",
            "description":"The sequence number",
            "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 subscription product ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PeriodUntil":{
            "type":"number",
            "description":"The period until",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodFrom":{
            "type":"number",
            "description":"The period from",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The last updated by",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The created by",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeAdjustmentPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The charge adjustment PUID",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeAdjustmentId":{
            "type":"integer",
            "description":"The charge adjustment ID",
            "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 adjustment type",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdjustmentValue":{
            "title":"Value",
            "type":"number",
            "description":"The adjustment value",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The charge ID",
            "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 adjustment name",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The last update date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The last update login",
            "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 : subscriptions-products-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 : subscriptions-products-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

  The PUID of the bill line associated with the milestone event.
• ChargeId: integer (int64)
  The charge ID with which the milestone event is associated.
• ChargePuid: string
  Maximum Length: 120

  Default Value: Charges.ChargePuid

  The PUID of the charge to which the milestone event is associated.
• CompletionDate: string (date)
  The completion date of the milestone event.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The login which 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 last 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 last 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 which 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":"The PUID of the bill line associated with the milestone event.",
            "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 : subscriptions-products-coveredLevels-charges-chargeTiers-item-response

Type: object

Show Source

• AdditionalNumberFive: number
  Title: Additional Number Five

  The additional number five
• AdditionalNumberFour: number
  Title: Additional Number Four

  The additional number four
• AdditionalNumberOne: number
  Title: Additional Number One

  The additional number one
• AdditionalNumberSix: number
  Title: Additional Number Six

  The additional number six
• AdditionalNumberThree: number
  Title: Additional Number Three

  The additional number three
• AdditionalNumberTwo: number
  Title: Additional Number Two

  The additional number two
• AdditionalTextOne: string
  Title: Additional Text One

  Maximum Length: 4000

  The additional text one
• AdditionalTextTwo: string
  Title: Additional Text Two

  Maximum Length: 4000

  The additional text two
• AdditionalTimestampOne: string (date-time)
  Title: Additional Time-stamp One

  The additional timestamp one
• AdditionalTimestampThree: string (date-time)
  Title: Additional Time-stamp Three

  The additional timestamp three
• AdditionalTimestampTwo: string (date-time)
  Title: Additional Time-stamp Two

  The additional timestamp two
• AddtionalTextThree: string
  Title: Additional Text Three

  Maximum Length: 4000

  The additional text three
• BlockSize: number
  Title: Block Size

  The block size
• ChargeId: integer (int64)
  The charge ID
• ChargeTierId: integer (int64)
  The charge tier ID
• ChargeTierPuid: string
  Maximum Length: 120

  The charge tier PUID
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The created by
• CreationDate: string (date-time)
  Read Only: true

  The creation date
• LastUpdateDate: string (date-time)
  Read Only: true

  The last update date
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The last updated by
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The last update login
• 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 price format
• SequenceNumber: number
  The sequence number
• SubscriptionId: integer (int64)
  The subscription ID
• SubscriptionProductId: integer (int64)
  The subscription product ID
• TierFrom: number
  Title: Tier From

  The tier from
• TierTo: number
  Title: Tier To

  The tier to

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The creation date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdditionalTimestampTwo":{
            "title":"Additional Time-stamp Two",
            "type":"string",
            "description":"The additional timestamp two",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeTierPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The charge tier PUID",
            "nullable":false,
            "x-queryable":true
        },
        "AdditionalNumberThree":{
            "title":"Additional Number Three",
            "type":"number",
            "description":"The additional number three",
            "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":"The additional number five",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The subscription ID",
            "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":"The additional text three",
            "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 subscription product ID",
            "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":"The additional number two",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The last updated by",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeTierId":{
            "type":"integer",
            "description":"The charge tier ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The created by",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdditionalNumberFour":{
            "title":"Additional Number Four",
            "type":"number",
            "description":"The additional number four",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalTimestampOne":{
            "title":"Additional Time-stamp One",
            "type":"string",
            "description":"The additional timestamp one",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PriceFormat":{
            "title":"Price Format",
            "maxLength":30,
            "type":"string",
            "description":"The price format",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdditionalTextOne":{
            "title":"Additional Text One",
            "maxLength":4000,
            "type":"string",
            "description":"The additional text one",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalNumberSix":{
            "title":"Additional Number Six",
            "type":"number",
            "description":"The additional number six",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalNumberOne":{
            "title":"Additional Number One",
            "type":"number",
            "description":"The additional number one",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalTextTwo":{
            "title":"Additional Text Two",
            "maxLength":4000,
            "type":"string",
            "description":"The additional text two",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalTimestampThree":{
            "title":"Additional Time-stamp Three",
            "type":"string",
            "description":"The additional timestamp three",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The charge ID",
            "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 last update date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The last update login",
            "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 : subscriptions-products-coveredLevels-childCoveredLevels-item-response

Type: object

Show Source

• Address: string
  Title: Address

  The address of the party site associated with child covered level.
• 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 universal serial number associated with the asset.
• BatchTag: string
  Title: Batch Tag

  Maximum Length: 30

  Batch Tag
• CalculatedCreditAmount: number
  Title: Calculated Credit Amount

  The calculated credit amount of the child covered level.
• CalculateEstimatedTaxFlag: boolean
  Indicates whether estimated tax will be calculated for the subscription child covered level.
• CancelDescription: string
  Title: Cancellation Description

  Maximum Length: 2000

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

  The amount that was cancelled.
• CanceledDate: string (date)
  Title: Canceled Date

  The date of cancellation.
• CancelReason: string
  Title: Cancellation Reason

  Maximum Length: 30

  The reason for cancellation.
• ClosedAmount: number
  Title: Closed Amount

  The amount when 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 child covered level.
• CloseReason: string
  Title: Covered Level Close Reason

  Maximum Length: 30

  The reason when the covered level was closed.
• CorpCurrencyCode: string
  Title: Currency Code

  Maximum Length: 15

  The corporate currency code associated with the account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• 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 covered parent for the 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 associated with child covered level.
• CoveredLevlNumber: string
  Title: Covered Level Number

  The alternate identifier of the covered level associated with child covered level.
• 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.
• CreditedAmount: number
  Title: Credited Amount

  The credited amount for the covered level.
• CreditType: string
  Title: Credit Type

  Maximum Length: 30

  Indicates the type of credit issued to the customer such as negative invoice or credit memo.
• CurcyConvRateType: string
  Title: Conversion Rate Type

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

  Maximum Length: 15

  The currency code. 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 associated with child covered level.
• CustomerName: string
  Title: Customer Account

  The name of the customer associated with child covered level.
• CustomerNumber: string
  Title: Customer Account Number

  The alternate unique identifier of the customer associated with child covered level.
• Description: string
  Title: Covered Level Description

  The description of the covered level.
• Duration: integer
  The duration for which the covered level is active.
• EndDate: string (date)
  Title: Covered Level End Date

  The end date for the covered level.
• ExplodeAssetHierarchy: string
  The explode hierarchy for the asset.
• GenBillSchReqdFlag: boolean
  Title: Billing schedule update required

  Maximum Length: 1

  Generate Bill Schedule Required Flag
• GenerateBillingSchedule: string
  The schedule by the bill is generated.
• HierarchyTotal: number
  The total when the covered level was closed.
• InventoryItemId: integer (int64)
  Title: Item ID

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

  The invoiced amount.
• InvoiceText: string
  Maximum Length: 2000

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

  Maximum Length: 15

  The unit of measure used by the item.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

  Maximum Length: 32

  The login of the user who last updated the record.
• 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 child 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 parent level for the level.
• PartyId: integer (int64)
  Title: Party ID

  The unique identifier of the party associated with child covered level.
• PartyName: string
  Title: Party Name

  The name of the party associated with child covered level.
• PartyNumber: string
  Title: Party Number

  The alternate identifier of the party associated with child covered level.
• PartySite: string
  Title: Party Site Number

  The name of the party site associated with child covered level.
• PartySiteId: integer (int64)
  Title: Party Site ID

  The unique identifier of the party site associated with child covered level.
• Period: string
  Maximum Length: 80

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

  The price of the covered level.
• 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 by the item.
• PriceUnitOfMeasureName: string
  Title: Pricing UOM

  The name of the unit of measure.
• PricingError: string
  Title: Pricing Error

  Maximum Length: 1000

  Any errors associated with the pricing.
• 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.
• PutOnHoldFlag: boolean
  Indicates if the covered level has been put on hold.
• Quantity: number
  Title: Quantity

  Default Value: 1

  The quantity for which the bill line was charged.
• RemoveHoldFlag: boolean
  Indicates if the covered level's hold has to be removed.
• RenewalType: string
  Title: Renewal Type

  Maximum Length: 30

  The type of renewal.
• RenewedDate: string (date)
  Title: Renewed On

  The date when the covered level was renewed.
• RepriceFlag: boolean
  Indicates whether the subscription child covered level should be repriced or not. If passed as 'true', the subscription child covered level 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 return method for the credit after the covered level was closed.
• RevenueOption: string
  Title: Revenue Accounting Option

  Maximum Length: 30

  Revenue Option
• RollupTotal: number
  Title: Configured Asset Amount

  The total when the covered level was closed.
• SerialNumber: string
  Title: Covered Asset Serial Number

  Read Only: true

  Maximum Length: 80

  The serial number of the child covered level.
• SourceKey: string
  Title: Source Key

  Maximum Length: 120

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

  Maximum Length: 120

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

  Maximum Length: 120

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

  Maximum Length: 120

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

  Maximum Length: 30

  The source system of the child covered level.
• StartDate: string (date)
  Title: Covered Level Start Date

  The start date for the covered level.
• Status: string
  Title: Covered Level Status

  Maximum Length: 30

  The status of the covered level.
• StatusName: string
  Title: Status

  The description of the status.
• SubscriptionId: integer (int64)
  Title: Subscription ID

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

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

  The suppressed amount for the credit.
• SuspendCreditMethod: string
  Title: Suspend Credit Method

  Maximum Length: 30

  The suspend method for the credit after the covered level was closed.
• 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 when the covered level was suspended.
• TaxAmount: number
  Title: Tax Amount

  The amount of tax to be deducted.
• TaxError: string
  Maximum Length: 4000

  The tax error for the covered level.
• TotalContractValue: number
  Title: Covered Level Contract Value

  The total contract value
• Type: string
  Title: Type

  Maximum Length: 30

  The type of the covered level.
• TypeName: string
  Title: Covered Level Type

  The type name associated with the covered level.
• UnitPrice: number
  Title: Unit Price

  The unit price of the covered level associated with child covered level.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the record 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 child covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "Address":{
            "title":"Address",
            "type":"string",
            "description":"The address of the party site associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CancelDescription":{
            "title":"Cancellation Description",
            "maxLength":2000,
            "type":"string",
            "description":"The cancel description associated with a child covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Conversion Rate Type",
            "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
        },
        "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 total when the covered level was closed.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The currency code. 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
        },
        "TaxAmount":{
            "title":"Tax Amount",
            "type":"number",
            "description":"The amount of tax to be deducted.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceKey":{
            "title":"Source Key",
            "maxLength":120,
            "type":"string",
            "description":"The source key of the child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CloseReason":{
            "title":"Covered Level Close Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason when the covered level was closed.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CoveredLevelParentPuid":{
            "type":"string",
            "description":"The covered parent for the parent.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceNumber":{
            "title":"External Source Number",
            "maxLength":120,
            "type":"string",
            "description":"The source number of the child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "PartySiteId":{
            "title":"Party Site ID",
            "type":"integer",
            "description":"The unique identifier of the party site associated with child covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CanceledDate":{
            "title":"Canceled Date",
            "type":"string",
            "description":"The date of cancellation.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ExplodeAssetHierarchy":{
            "type":"string",
            "description":"The explode hierarchy for the asset.",
            "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 record.",
            "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 record.",
            "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 credited amount for the covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusName":{
            "title":"Status",
            "type":"string",
            "description":"The description of the status.",
            "nullable":true,
            "x-queryable":true
        },
        "SuppressedCreditAmount":{
            "title":"Suppressed Credit Amount",
            "type":"number",
            "description":"The suppressed amount for the credit.",
            "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 invoiced amount.",
            "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 of the user who last updated the record.",
            "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":"The description of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CanceledAmount":{
            "title":"Canceled Amount",
            "type":"number",
            "description":"The amount that was cancelled.",
            "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 associated 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
        },
        "TotalContractValue":{
            "title":"Covered Level Contract Value",
            "type":"number",
            "description":"The total contract value",
            "nullable":true,
            "x-queryable":true
        },
        "SuspendReason":{
            "title":"Covered Level Suspend Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason when the covered level was suspended.",
            "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 when the covered level was closed.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"Covered Level End Date",
            "type":"string",
            "description":"The end date for the covered level.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ClosedAmount":{
            "title":"Closed Amount",
            "type":"number",
            "description":"The amount when the covered level was closed.",
            "nullable":true,
            "x-queryable":true
        },
        "CoveredLevlName":{
            "title":"Covered Level Name",
            "type":"string",
            "description":"The name of the covered level associated with child covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "OverrideCreditAmount":{
            "title":"Override Credit Amount",
            "type":"number",
            "description":"The override credit amount of the child covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "CalculateEstimatedTaxFlag":{
            "type":"boolean",
            "description":"Indicates whether estimated tax will be calculated for the subscription child 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 associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "GenerateBillingSchedule":{
            "type":"string",
            "description":"The schedule by the bill is generated.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the party associated with child covered level.",
            "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 child covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystem":{
            "title":"External Source System",
            "maxLength":30,
            "type":"string",
            "description":"The source system of the child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TypeName":{
            "title":"Covered Level Type",
            "type":"string",
            "description":"The type name associated with the covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ProductName":{
            "title":"Product Name",
            "type":"string",
            "description":"The name of the product.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ParentCoveredLevelId":{
            "title":"Parent Covered Level ID",
            "type":"integer",
            "description":"The parent level for the level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Party Name",
            "type":"string",
            "description":"The name of the party associated with child covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "SuspendCreditMethod":{
            "title":"Suspend Credit Method",
            "maxLength":30,
            "type":"string",
            "description":"The suspend method for the credit after the covered level was closed.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Covered Level Start Date",
            "type":"string",
            "description":"The start date for the covered level.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "CustomerNumber":{
            "title":"Customer Account Number",
            "type":"string",
            "description":"The alternate unique identifier of the customer associated with child covered level.",
            "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 account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemUnitOfMeasure":{
            "title":"UOM",
            "maxLength":15,
            "type":"string",
            "description":"The unit of measure used by the item.",
            "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 during which the covered level is used.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Duration":{
            "type":"integer",
            "description":"The duration for which the covered level is active.",
            "nullable":true,
            "x-queryable":false
        },
        "RenewalType":{
            "title":"Renewal Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of 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 universal serial number associated with the asset.",
            "nullable":true,
            "x-queryable":true
        },
        "CancelReason":{
            "title":"Cancellation Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason for cancellation.",
            "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 child covered level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PriceUnitOfMeasureName":{
            "title":"Pricing UOM",
            "type":"string",
            "description":"The 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 return method for the credit after the covered level was closed.",
            "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 child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CoveredLevlNumber":{
            "title":"Covered Level Number",
            "type":"string",
            "description":"The alternate identifier of the covered level associated with child 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 of the covered level.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PartySite":{
            "title":"Party Site Number",
            "type":"string",
            "description":"The name of the party site associated with child covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "InvoiceText":{
            "maxLength":2000,
            "type":"string",
            "description":"The text to be included in the invoice.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerAccountId":{
            "title":"Customer Account ID",
            "type":"integer",
            "description":"The unique identifier of the customer account associated with child covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaxError":{
            "maxLength":4000,
            "type":"string",
            "description":"The tax error for the covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerName":{
            "title":"Customer Account",
            "type":"string",
            "description":"The name of the customer associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CreditType":{
            "title":"Credit Type",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of credit issued to the customer such as negative invoice or credit memo.",
            "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 child 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 child covered level should be repriced or not. If passed as 'true', the subscription child covered level 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 for which the bill line was charged.",
            "nullable":false,
            "default":1,
            "x-queryable":true
        },
        "PriceUnitOfMeasure":{
            "title":"Pricing UOM",
            "maxLength":30,
            "type":"string",
            "description":"The unit of measure used by the item.",
            "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 associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "RemoveHoldFlag":{
            "type":"boolean",
            "description":"Indicates if the covered level's hold has to be removed.",
            "nullable":true,
            "x-queryable":false
        },
        "PricingError":{
            "title":"Pricing Error",
            "maxLength":1000,
            "type":"string",
            "description":"Any errors associated with the pricing.",
            "nullable":true,
            "x-queryable":true
        },
        "BatchTag":{
            "title":"Batch Tag",
            "maxLength":30,
            "type":"string",
            "description":"Batch Tag",
            "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 : subscriptions-products-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 : subscriptions-products-coveredLevels-relationships-item-response

Type: object

Show Source

• 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.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  The object version number.
• OperationLinksPuid: string
  Title: Operation Links PUID

  Maximum Length: 120

  The operation links PUID.
• RelationshipTypeCode: string
  Title: Type

  Maximum Length: 30

  The relationship type code.
• 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 source product association PUID.
• SourceProductPuid: string
  Title: Source Product PUID

  Maximum Length: 120

  The source product PUID.
• 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 target product association PUID.
• TargetProductPuid: string
  Title: Target Product PUID

  Maximum Length: 120

  The target product PUID.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":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
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "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 source product PUID.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipTypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The relationship type code.",
            "nullable":false,
            "x-queryable":true
        },
        "OperationLinksPuid":{
            "title":"Operation Links PUID",
            "maxLength":120,
            "type":"string",
            "description":"The operation links PUID.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number.",
            "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 source product association PUID.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetProductPuid":{
            "title":"Target Product PUID",
            "maxLength":120,
            "type":"string",
            "description":"The target product PUID.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetProdAssociationPuid":{
            "title":"Target Product Association PUID",
            "maxLength":120,
            "type":"string",
            "description":"The target product association PUID.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record 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 record.",
            "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 : subscriptions-products-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 record.
• CreationDate: string (date-time)
  Read Only: true

  The date when the record was created.
• CreditCardId: integer (int64)
  The unique identifier of the credit card.
• CreditCardPuid: string
  Maximum Length: 120

  The credit card PUID.
• 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 record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Maximum Length: 32

  The login of the user who last updated the record.
• 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 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 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 record 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 credit card PUID.",
            "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 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 associated with the credit card.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "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 record 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 of the user who last updated the record.",
            "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 : subscriptions-products-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 : subscriptions-products-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 : subscriptions-products-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 charge definition code under subscription entitlement plan details.
• ChargeDefinitionId: integer (int64)
  The unique identifier for charge definition 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 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 charge definition code 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 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 unique identifier for charge definition 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 : subscriptions-products-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 whether 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 of allowance 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 whether 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 of allowance 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 : subscriptions-products-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 : subscriptions-products-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 : subscriptions-products-relationships-item-response

Type: object

Show Source

• 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.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  The object version number.
• OperationLinksPuid: string
  Title: Operation Links PUID

  Maximum Length: 120

  The operation links PUID.
• RelationshipTypeCode: string
  Title: Type

  Maximum Length: 30

  The relationship type code.
• 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 source product association PUID.
• SourceProductPuid: string
  Title: Source Product PUID

  Maximum Length: 120

  The source product PUID.
• 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 target product association PUID.
• TargetProductPuid: string
  Title: Target Product PUID

  Maximum Length: 120

  The target product PUID.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":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
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "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 source product PUID.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipTypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The relationship type code.",
            "nullable":false,
            "x-queryable":true
        },
        "OperationLinksPuid":{
            "title":"Operation Links PUID",
            "maxLength":120,
            "type":"string",
            "description":"The operation links PUID.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number.",
            "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 source product association PUID.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetProductPuid":{
            "title":"Target Product PUID",
            "maxLength":120,
            "type":"string",
            "description":"The target product PUID.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetProdAssociationPuid":{
            "title":"Target Product Association PUID",
            "maxLength":120,
            "type":"string",
            "description":"The target product association PUID.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record 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 record.",
            "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 : subscriptions-products-salesCredits-item-response

Type: object

Show Source

• 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.
• EndDate: string (date)
  Title: End Date

  The date when the credit card becomes invalid.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• Percentage: number
  Title: Percent

  The percentage of sales credit.
• QuotaFlag: boolean
  Read Only: true

  Maximum Length: 1

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

  Maximum Length: 120

  The sales credit PUID.
• SalesCreditType: string
  The sales credit type.
• SalesCreditTypeId: integer (int64)
  Title: Credit Type

  The unique identifier of the sales credit type.
• SalesPerson: string
  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 starts.
• SubscriptionId: integer (int64)
  The unique identifier of the subscription.
• SubscriptionProductId: integer (int64)
  Title: Subscription Product ID

  The subscription product ID.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":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
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Percentage":{
            "title":"Percent",
            "type":"number",
            "description":"The percentage of sales credit.",
            "nullable":false,
            "x-hints":{
                "precision":5,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "scale":2
            },
            "x-queryable":true
        },
        "SalesPerson":{
            "type":"string",
            "description":"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 sales credit type.",
            "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 the quota of the sales credit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesCreditType":{
            "type":"string",
            "description":"The sales credit type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the credit card becomes invalid.",
            "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 starts.",
            "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 sales credit PUID.",
            "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 subscription product ID.",
            "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 record 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 record.",
            "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 : subscriptions-products-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 : subscriptions-products-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 Navigation
  Title: User Action Navigation

  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 Request Payload
  Title: User Action Request Payload

  The user action request payload resource stores the payload information for every user action request.
• UserActionURLBinding: array User Action URL Binding
  Title: User Action URL Binding

  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 URL Binding",
            "type":"array",
            "description":"The user action URL binding resource stores the binding metadata for a variable in the URL.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-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 Navigation",
            "type":"array",
            "description":"The user action navigation resource stores the UI navigation metadata striped by app usage.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-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 Request Payload",
            "type":"array",
            "description":"The user action request payload resource stores the payload information for every user action request.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-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 Navigation

Type: array

Title: User Action Navigation

The user action navigation resource stores the UI navigation metadata striped by app usage.

Show Source

• Array of: object subscriptions-products-smartActions-UserActionNavigation-item-response

{
    "title":"User Action Navigation",
    "type":"array",
    "description":"The user action navigation resource stores the UI navigation metadata striped by app usage.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-smartActions-UserActionNavigation-item-response"
    }
}

Nested Schema : User Action Request Payload

Type: array

Title: User Action Request Payload

The user action request payload resource stores the payload information for every user action request.

Show Source

• Array of: object subscriptions-products-smartActions-UserActionRequestPayload-item-response

{
    "title":"User Action Request Payload",
    "type":"array",
    "description":"The user action request payload resource stores the payload information for every user action request.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-smartActions-UserActionRequestPayload-item-response"
    }
}

Nested Schema : User Action URL Binding

Type: array

Title: User Action URL Binding

The user action URL binding resource stores the binding metadata for a variable in the URL.

Show Source

• Array of: object subscriptions-products-smartActions-UserActionURLBinding-item-response

{
    "title":"User Action URL Binding",
    "type":"array",
    "description":"The user action URL binding resource stores the binding metadata for a variable in the URL.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-smartActions-UserActionURLBinding-item-response"
    }
}

Nested Schema : subscriptions-products-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 : subscriptions-products-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 : subscriptions-products-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"
    }
}

Nested Schema : subscriptions-salesCredits-item-response

Type: object

Show Source

• 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.
• EndDate: string (date)
  Title: End Date

  The date when the credit card becomes invalid.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• Percentage: number
  Title: Percent

  The percentage of sales credit.
• QuotaFlag: boolean
  Read Only: true

  Maximum Length: 1

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

  Maximum Length: 120

  The sales credit PUID.
• SalesCreditType: string
  The sales credit type.
• SalesCreditTypeId: integer (int64)
  Title: Credit Type

  The unique identifier of the sales credit type.
• SalesPerson: string
  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 starts.
• SubscriptionId: integer (int64)
  The unique identifier of the subscription.
• SubscriptionProductId: integer (int64)
  Title: Subscription Product ID

  The subscription product ID.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":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
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Percentage":{
            "title":"Percent",
            "type":"number",
            "description":"The percentage of sales credit.",
            "nullable":false,
            "x-hints":{
                "precision":5,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "scale":2
            },
            "x-queryable":true
        },
        "SalesPerson":{
            "type":"string",
            "description":"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 sales credit type.",
            "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 the quota of the sales credit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesCreditType":{
            "type":"string",
            "description":"The sales credit type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the credit card becomes invalid.",
            "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 starts.",
            "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 sales credit PUID.",
            "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 subscription product ID.",
            "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 record 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 record.",
            "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 : subscriptions-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 Navigation
  Title: User Action Navigation

  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 Request Payload
  Title: User Action Request Payload

  The user action request payload resource stores the payload information for every user action request.
• UserActionURLBinding: array User Action URL Binding
  Title: User Action URL Binding

  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 URL Binding",
            "type":"array",
            "description":"The user action URL binding resource stores the binding metadata for a variable in the URL.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-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 Navigation",
            "type":"array",
            "description":"The user action navigation resource stores the UI navigation metadata striped by app usage.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-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 Request Payload",
            "type":"array",
            "description":"The user action request payload resource stores the payload information for every user action request.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-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 Navigation

Type: array

Title: User Action Navigation

The user action navigation resource stores the UI navigation metadata striped by app usage.

Show Source

• Array of: object subscriptions-smartActions-UserActionNavigation-item-response

{
    "title":"User Action Navigation",
    "type":"array",
    "description":"The user action navigation resource stores the UI navigation metadata striped by app usage.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-smartActions-UserActionNavigation-item-response"
    }
}

Nested Schema : User Action Request Payload

Type: array

Title: User Action Request Payload

The user action request payload resource stores the payload information for every user action request.

Show Source

• Array of: object subscriptions-smartActions-UserActionRequestPayload-item-response

{
    "title":"User Action Request Payload",
    "type":"array",
    "description":"The user action request payload resource stores the payload information for every user action request.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-smartActions-UserActionRequestPayload-item-response"
    }
}

Nested Schema : User Action URL Binding

Type: array

Title: User Action URL Binding

The user action URL binding resource stores the binding metadata for a variable in the URL.

Show Source

• Array of: object subscriptions-smartActions-UserActionURLBinding-item-response

{
    "title":"User Action URL Binding",
    "type":"array",
    "description":"The user action URL binding resource stores the binding metadata for a variable in the URL.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-smartActions-UserActionURLBinding-item-response"
    }
}

Nested Schema : subscriptions-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 : subscriptions-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 : subscriptions-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"
    }
}

Nested Schema : subscriptions-subscriptionContact-item-response

Type: object

Show Source

• AccessLevel: string
  Maximum Length: 302

  The access level of the contact.
• BillingOwnerFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether this contact is a billing owner or not.
• ContactEmail: string
  Title: Email

  The email address of the contact.
• ContactId: integer (int64)
  The unique identifier of the contact.
• ContactName: string
  Title: Name

  The contact name.
• ContactNumber: string
  Title: Party Contact Number

  The number of the subscription contact.
• ContactPuid: string
  Maximum Length: 120

  The PUID of the subscription contact.
• ContactRole: string
  Title: Role

  Maximum Length: 30

  The contact role of the subscription contact.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date when the contact was created.
• EndDate: string (date)
  The end date of the contact.
• InternalFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether this contact is internal or not.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  The object version number of the contact.
• OwnerFlag: boolean
  Title: Owner

  Maximum Length: 1

  Default Value: false

  Indicates whether the contact is the owner.
• PartyId: integer
  The unique identifier of the party.
• PartyNumber: string
  Title: Party Number

  Maximum Length: 120

  The number of the party to which the contact belongs.
• PartyPuid: string
  Title: Party Number

  Maximum Length: 120

  The party PUID of the contact.
• PartyRole: string
  Title: Role

  Maximum Length: 20

  The party role of the contact.
• smartActions: array Subscription User Actions
  Title: Subscription User Actions

  The smart actions resource stores the endpoint and security details for every user action.
• StartDate: string (date)
  The start date of the contact.
• SubscriptionContactId: integer (int64)
  The unique identifier of the subscription contact.
• SubscriptionId: integer (int64)
  The unique identifier of the subscription.
• SubscriptionNumber: string
  Title: Subscription Number

  Maximum Length: 120

  The subscription number to which the contact belongs.
• SubscriptionPartyId: integer (int64)
  The unique identifier of the subscription party.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the contact was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriptionPartyId":{
            "type":"integer",
            "description":"The unique identifier of the subscription party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "ContactId":{
            "type":"integer",
            "description":"The unique identifier of the contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContactRole":{
            "title":"Role",
            "maxLength":30,
            "type":"string",
            "description":"The contact role of the subscription contact.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "smartActions":{
            "title":"Subscription User Actions",
            "type":"array",
            "description":"The smart actions resource stores the endpoint and security details for every user action.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-subscriptionContact-smartActions-item-response"
            }
        },
        "StartDate":{
            "type":"string",
            "description":"The start date of the contact.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the contact.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ContactPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The PUID of the subscription contact.",
            "nullable":false,
            "x-queryable":true
        },
        "ContactNumber":{
            "title":"Party Contact Number",
            "type":"string",
            "description":"The number of the subscription contact.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "sortable":false
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyRole":{
            "title":"Role",
            "maxLength":20,
            "type":"string",
            "description":"The party role of the contact.",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriptionNumber":{
            "title":"Subscription Number",
            "maxLength":120,
            "type":"string",
            "description":"The subscription number to which the contact belongs.",
            "nullable":true,
            "x-queryable":false
        },
        "OwnerFlag":{
            "title":"Owner",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the contact is the owner.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "InternalFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this contact is internal or not.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"The end date of the contact.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AccessLevel":{
            "maxLength":302,
            "type":"string",
            "description":"The access level of the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Party Number",
            "maxLength":120,
            "type":"string",
            "description":"The number of the party to which the contact belongs.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party.",
            "nullable":true,
            "x-queryable":false
        },
        "ContactEmail":{
            "title":"Email",
            "type":"string",
            "description":"The email address of the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyPuid":{
            "title":"Party Number",
            "maxLength":120,
            "type":"string",
            "description":"The party PUID of the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "BillingOwnerFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this contact is a billing owner or not.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ContactName":{
            "title":"Name",
            "type":"string",
            "description":"The contact name.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the contact 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 contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriptionContactId":{
            "type":"integer",
            "description":"The unique identifier of the subscription contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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 : Subscription User Actions

Type: array

Title: Subscription User Actions

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

Show Source

• Array of: object subscriptions-subscriptionContact-smartActions-item-response

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

Nested Schema : subscriptions-subscriptionContact-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 Navigation
  Title: User Action Navigation

  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 Request Payload
  Title: User Action Request Payload

  The user action request payload resource stores the payload information for every user action request.
• UserActionURLBinding: array User Action URL Binding
  Title: User Action URL Binding

  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 URL Binding",
            "type":"array",
            "description":"The user action URL binding resource stores the binding metadata for a variable in the URL.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-subscriptionContact-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 Navigation",
            "type":"array",
            "description":"The user action navigation resource stores the UI navigation metadata striped by app usage.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-subscriptionContact-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 Request Payload",
            "type":"array",
            "description":"The user action request payload resource stores the payload information for every user action request.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-subscriptionContact-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 Navigation

Type: array

Title: User Action Navigation

The user action navigation resource stores the UI navigation metadata striped by app usage.

Show Source

• Array of: object subscriptions-subscriptionContact-smartActions-UserActionNavigation-item-response

{
    "title":"User Action Navigation",
    "type":"array",
    "description":"The user action navigation resource stores the UI navigation metadata striped by app usage.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-subscriptionContact-smartActions-UserActionNavigation-item-response"
    }
}

Nested Schema : User Action Request Payload

Type: array

Title: User Action Request Payload

The user action request payload resource stores the payload information for every user action request.

Show Source

• Array of: object subscriptions-subscriptionContact-smartActions-UserActionRequestPayload-item-response

{
    "title":"User Action Request Payload",
    "type":"array",
    "description":"The user action request payload resource stores the payload information for every user action request.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-subscriptionContact-smartActions-UserActionRequestPayload-item-response"
    }
}

Nested Schema : User Action URL Binding

Type: array

Title: User Action URL Binding

The user action URL binding resource stores the binding metadata for a variable in the URL.

Show Source

• Array of: object subscriptions-subscriptionContact-smartActions-UserActionURLBinding-item-response

{
    "title":"User Action URL Binding",
    "type":"array",
    "description":"The user action URL binding resource stores the binding metadata for a variable in the URL.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-subscriptionContact-smartActions-UserActionURLBinding-item-response"
    }
}

Nested Schema : subscriptions-subscriptionContact-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 : subscriptions-subscriptionContact-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 : subscriptions-subscriptionContact-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"
    }
}

Nested Schema : subscriptions-subscriptionTeam-item-response

Type: object

Show Source

• AccessLevel: string
  Maximum Length: 302

  The access level of the contact.
• BillingOwnerFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether this contact is a billing owner or not.
• ContactEmail: string
  Title: Email

  The email address of the contact.
• ContactId: integer (int64)
  The unique identifier of the contact.
• ContactName: string
  Title: Name

  The contact name.
• ContactNumber: string
  Title: Party Contact Number

  The number of the subscription contact.
• ContactPuid: string
  Maximum Length: 120

  The PUID of the subscription contact.
• ContactRole: string
  Title: Role

  Maximum Length: 30

  The contact role of the subscription contact.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date when the contact was created.
• EndDate: string (date)
  The end date of the contact.
• InternalFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether this contact is internal or not.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  The object version number of the contact.
• OwnerFlag: boolean
  Title: Owner

  Maximum Length: 1

  Default Value: false

  Indicates whether the contact is the owner.
• PartyId: integer
  The unique identifier of the party.
• PartyNumber: string
  Title: Party Number

  Maximum Length: 120

  The number of the party to which the contact belongs.
• PartyPuid: string
  Title: Party Number

  Maximum Length: 120

  The party PUID of the contact.
• PartyRole: string
  Title: Role

  Maximum Length: 20

  The party role of the contact.
• smartActions: array Subscription User Actions
  Title: Subscription User Actions

  The smart actions resource stores the endpoint and security details for every user action.
• StartDate: string (date)
  The start date of the contact.
• SubscriptionContactId: integer (int64)
  The unique identifier of the subscription contact.
• SubscriptionId: integer (int64)
  The unique identifier of the subscription.
• SubscriptionNumber: string
  Title: Subscription Number

  Maximum Length: 120

  The subscription number to which the contact belongs.
• SubscriptionPartyId: integer (int64)
  The unique identifier of the subscription party.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the contact was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriptionPartyId":{
            "type":"integer",
            "description":"The unique identifier of the subscription party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContactId":{
            "type":"integer",
            "description":"The unique identifier of the contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContactRole":{
            "title":"Role",
            "maxLength":30,
            "type":"string",
            "description":"The contact role of the subscription contact.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "smartActions":{
            "title":"Subscription User Actions",
            "type":"array",
            "description":"The smart actions resource stores the endpoint and security details for every user action.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-subscriptionTeam-smartActions-item-response"
            }
        },
        "StartDate":{
            "type":"string",
            "description":"The start date of the contact.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the contact.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ContactPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The PUID of the subscription contact.",
            "nullable":false,
            "x-queryable":true
        },
        "ContactNumber":{
            "title":"Party Contact Number",
            "type":"string",
            "description":"The number of the subscription contact.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "sortable":false
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyRole":{
            "title":"Role",
            "maxLength":20,
            "type":"string",
            "description":"The party role of the contact.",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriptionNumber":{
            "title":"Subscription Number",
            "maxLength":120,
            "type":"string",
            "description":"The subscription number to which the contact belongs.",
            "nullable":true,
            "x-queryable":false
        },
        "OwnerFlag":{
            "title":"Owner",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the contact is the owner.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "InternalFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this contact is internal or not.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"The end date of the contact.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AccessLevel":{
            "maxLength":302,
            "type":"string",
            "description":"The access level of the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Party Number",
            "maxLength":120,
            "type":"string",
            "description":"The number of the party to which the contact belongs.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party.",
            "nullable":true,
            "x-queryable":false
        },
        "ContactEmail":{
            "title":"Email",
            "type":"string",
            "description":"The email address of the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyPuid":{
            "title":"Party Number",
            "maxLength":120,
            "type":"string",
            "description":"The party PUID of the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "BillingOwnerFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this contact is a billing owner or not.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ContactName":{
            "title":"Name",
            "type":"string",
            "description":"The contact name.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the contact 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 contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriptionContactId":{
            "type":"integer",
            "description":"The unique identifier of the subscription contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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 : Subscription User Actions

Type: array

Title: Subscription User Actions

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

Show Source

• Array of: object subscriptions-subscriptionTeam-smartActions-item-response

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

Nested Schema : subscriptions-subscriptionTeam-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 Navigation
  Title: User Action Navigation

  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 Request Payload
  Title: User Action Request Payload

  The user action request payload resource stores the payload information for every user action request.
• UserActionURLBinding: array User Action URL Binding
  Title: User Action URL Binding

  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 URL Binding",
            "type":"array",
            "description":"The user action URL binding resource stores the binding metadata for a variable in the URL.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-subscriptionTeam-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 Navigation",
            "type":"array",
            "description":"The user action navigation resource stores the UI navigation metadata striped by app usage.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-subscriptionTeam-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 Request Payload",
            "type":"array",
            "description":"The user action request payload resource stores the payload information for every user action request.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-subscriptionTeam-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 Navigation

Type: array

Title: User Action Navigation

The user action navigation resource stores the UI navigation metadata striped by app usage.

Show Source

• Array of: object subscriptions-subscriptionTeam-smartActions-UserActionNavigation-item-response

{
    "title":"User Action Navigation",
    "type":"array",
    "description":"The user action navigation resource stores the UI navigation metadata striped by app usage.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-subscriptionTeam-smartActions-UserActionNavigation-item-response"
    }
}

Nested Schema : User Action Request Payload

Type: array

Title: User Action Request Payload

The user action request payload resource stores the payload information for every user action request.

Show Source

• Array of: object subscriptions-subscriptionTeam-smartActions-UserActionRequestPayload-item-response

{
    "title":"User Action Request Payload",
    "type":"array",
    "description":"The user action request payload resource stores the payload information for every user action request.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-subscriptionTeam-smartActions-UserActionRequestPayload-item-response"
    }
}

Nested Schema : User Action URL Binding

Type: array

Title: User Action URL Binding

The user action URL binding resource stores the binding metadata for a variable in the URL.

Show Source

• Array of: object subscriptions-subscriptionTeam-smartActions-UserActionURLBinding-item-response

{
    "title":"User Action URL Binding",
    "type":"array",
    "description":"The user action URL binding resource stores the binding metadata for a variable in the URL.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-subscriptionTeam-smartActions-UserActionURLBinding-item-response"
    }
}

Nested Schema : subscriptions-subscriptionTeam-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 : subscriptions-subscriptionTeam-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 : subscriptions-subscriptionTeam-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"
    }
}

Nested Schema : subscriptions-supportingDocumentAttachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

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

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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 : subscriptions-validateSubscription-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The user who created the record.
• ErrorSeverity: string
  Maximum Length: 30

  The severity of the error.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• MessageText: string
  Maximum Length: 4000

  The error message text.
• ObjectId: integer (int64)
  The unique identifier of the object.
• ObjectName: string
  Maximum Length: 1000

  The name of the object.
• ObjectType: string
  Maximum Length: 30

  The object type.
• ObjectVersionNumber: integer (int32)
  The object version number.
• SubscriptionNumber: string
  Maximum Length: 120

  The subscription number.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The user who created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The date when the record was created.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriptionNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The subscription number.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique identifier of the object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ErrorSeverity":{
            "maxLength":30,
            "type":"string",
            "description":"The severity of the error.",
            "nullable":false,
            "x-queryable":true
        },
        "MessageText":{
            "maxLength":4000,
            "type":"string",
            "description":"The error message text.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectName":{
            "maxLength":1000,
            "type":"string",
            "description":"The name of the object.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectType":{
            "maxLength":30,
            "type":"string",
            "description":"The object type.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number.",
            "format":"int32",
            "nullable":false,
            "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"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record 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 record.",
            "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"
    }
}

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

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

Parameters:

• finder: CustomerIdAndAddressIdFinder%3BBillToAddressId%3D{BillToSiteUseId}%2CBillToCustomerId%3D{BillToAccountId}

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%3Bbu_id%3D{BusinessUnitId}%2CBindCustAcctId%3D{BillToAccountId}%2CBindSiteUseCd%3DBILL_TO%2CBindStatus%3DA

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

BillingDayLOVVO

Operation: /crmRestApi/resources/11.13.18.05/subsProfBillingDays

The list of values indicating the bill on day.

The following properties are defined on the LOV link relation:

• Source Attribute: BillOnDay; Target Attribute: OffsetDay
• Display Attribute: OffsetDay

BillingFrequencyVA

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

BusinessUnitAllVA

Operation: /crmRestApi/resources/11.13.18.05/crmBusinessUnits

The list of values indicating all the business units.

The following properties are defined on the LOV link relation:

• Source Attribute: BusinessUnitName; Target Attribute: Name
• Display Attribute: Name

CancelReasonVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_CANCEL_REASONS

The list of values indicating the cancel reason of the subscription product.

The following properties are defined on the LOV link relation:

• Source Attribute: CancelReason; Target Attribute: LookupCode
• Display Attribute: Meaning

CloseReasonVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_CLOSE_REASONS

The list of values indicating the close reason of the subscription product.

The following properties are defined on the LOV link relation:

• Source Attribute: CloseReason; Target Attribute: LookupCode
• Display Attribute: Meaning

CommunicationChannelVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_COMM_CHANNEL

The list of values indicating communication channel.

The following properties are defined on the LOV link relation:

• Source Attribute: CommunicationChannel; Target Attribute: LookupCode
• Display Attribute: Meaning

ConversionRateTypeVA

Operation: /crmRestApi/resources/11.13.18.05/conversionRateTypes

The list of values indicating the currency conversion rate types.

The following properties are defined on the LOV link relation:

• Source Attribute: CurrencyConversionRateType; Target Attribute: ConversionType
• Display Attribute: UserConversionType

CreditTypeVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_CREDIT_TYPES

The list of values indicating the credit types for the subscription.

The following properties are defined on the LOV link relation:

• Source Attribute: CreditType; Target Attribute: LookupCode
• Display Attribute: Meaning

CustomerAcceptanceVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_CUST_ACCEPTANCE

The list of values indicating the renewal customer acceptance.

The following properties are defined on the LOV link relation:

• Source Attribute: RenewalCustomerAcceptance; Target Attribute: LookupCode
• Display Attribute: Meaning

DefinitionOrgVA

Operation: /crmRestApi/resources/11.13.18.05/definitionOrgs

The list of values indicating the definition organization names.

The following properties are defined on the LOV link relation:

• Source Attribute: DefinitionOrganizationName; Target Attribute: OrganizationName
• Display Attribute: OrganizationId, OrganizationName

DocFiscalClassificationVA

Operation: /crmRestApi/resources/11.13.18.05/documentSubtypes

The list of values indicating the document fiscal classification.

The following properties are defined on the LOV link relation:

• Source Attribute: DocumentFiscalClassification; Target Attribute: ClassificationCode
• Display Attribute: ClassificationName, ClassificationCode

ExemptCertificateVA

Operation: /crmRestApi/resources/11.13.18.05/taxExemptCertificates

Parameters:

• finder: TaxExemptCertificateByBusinessUnitIdAndCustomerPartyIdAndCustomerPartySiteIdAndEffectivePeriodFinder%3BbindBusinessUnitId%3D{BusinessUnitId}%2CbindCustomerPartyId%3D{PrimaryPartyId}%2CbindDate%3D2025-07-23

The list of values indicating the exempt certificate number.

The following properties are defined on the LOV link relation:

• Source Attribute: ExemptCertificateNumber; Target Attribute: ExemptCertificateNumber
• Display Attribute: ExemptCertificateNumber, ExemptReasonMeaning

ExternalContactsVA

Operation: /crmRestApi/resources/11.13.18.05/externalContacts

Parameters:

• finder: ExternalContactsbyPartyIdFinder%3BbindPartyId%3D{PrimaryPartyId}

The list of values indicating the customer contact name.

The following properties are defined on the LOV link relation:

• Source Attribute: CustomerContactName; Target Attribute: ContactName
• Display Attribute: ContactName, EmailAddress

InternalApprovalVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_INT_APPROVAL_OPTIONS

The list of values indicating the renewal internal approval.

The following properties are defined on the LOV link relation:

• Source Attribute: RenewalInternalApproval; 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

LanguageVA

Operation: /crmRestApi/resources/11.13.18.05/languages

Parameters:

• finder: LanguageFinder

The list of values indicating the negotiation language.

The following properties are defined on the LOV link relation:

• Source Attribute: NegotiationLanguage; Target Attribute: LanguageCode
• Display Attribute: Description

LayoutTemplateVA

Operation: /crmRestApi/resources/11.13.18.05/subscriptionsTemplates

Parameters:

• finder: ReportPathFinder%3BReportPath%3D{LayoutReportPath}

The list of values indicating the layout template.

The following properties are defined on the LOV link relation:

• Source Attribute: LayoutTemplate; Target Attribute: TemplateName
• Display Attribute: TemplateName

LegalEntityAllVA

Operation: /crmRestApi/resources/11.13.18.05/subscriptionLegalEntities

The list of values indicating the legal entities.

The following properties are defined on the LOV link relation:

• Source Attribute: LegalEntityName; Target Attribute: Name
• Display Attribute: Name

OutputTaxClassificationVA

Operation: /crmRestApi/resources/11.13.18.05/outputTaxClassifications

Parameters:

• finder: OrgIdFinder%3BbindOrgId%3D{BusinessUnitId}

The list of values indicating the tax classification meaning.

The following properties are defined on the LOV link relation:

• Source Attribute: TaxClassificationMeaning; Target Attribute: TaxClassificationMeaning
• Display Attribute: TaxClassificationMeaning, Description

PaymentTermsLOVVA

Operation: /crmRestApi/resources/11.13.18.05/paymentTerms

Parameters:

• finder: PaymentTermsByEndDateFinder%3BbuId%3D{BusinessUnitId}%2CBindEndDate%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

PeriodStartLookupVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_PERIOD_START

The list of values indicating the partial period start.

The following properties are defined on the LOV link relation:

• Source Attribute: PartialPeriodStart; Target Attribute: LookupCode
• Display Attribute: Meaning

PeriodTypeLookupVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_PERIOD_TYPE

The list of values indicating the partial period type.

The following properties are defined on the LOV link relation:

• Source Attribute: PartialPeriodType; Target Attribute: LookupCode
• Display Attribute: Meaning

PeriodVA

Operation: /crmRestApi/resources/11.13.18.05/timeUnitOfMeasures

The list of values indicating the periods.

The following properties are defined on the LOV link relation:

• Source Attribute: Period; Target Attribute: UomCode
• Display Attribute: UnitOfMeasure

PreviewBipReportCodeVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_BIP_REPORT_TYPE

The following properties are defined on the LOV link relation:

• Source Attribute: PreviewBipReportCode; Target Attribute: LookupCode
• Display Attribute: Meaning

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 renewal price adjustment basis.

The following properties are defined on the LOV link relation:

• Source Attribute: RenewalPriceAdjustmentBasis; 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 renewal price adjustment type.

The following properties are defined on the LOV link relation:

• Source Attribute: RenewalPriceAdjustmentType; 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

RenewalTypeVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_RENEWAL_TYPE

The list of values indicating the renewal process.

The following properties are defined on the LOV link relation:

• Source Attribute: RenewalProcess; Target Attribute: LookupCode
• Display Attribute: Meaning

RenewalVA

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

RevenueManagementRuleVA

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

The following properties are defined on the LOV link relation:

• Source Attribute: DefaultRevenueAction; Target Attribute: LookupCode
• Display Attribute: Meaning

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

The following properties are defined on the LOV link relation:

• Source Attribute: RevenueOption; Target Attribute: LookupCode
• Display Attribute: Meaning

ShipToAccountVA

Operation: /crmRestApi/resources/11.13.18.05/shipToAccounts

Parameters:

• finder: SubscriptionIdAndPrimaryPartyIdFinder%3BbindSubscriptionId%3D{SubscriptionId}%2CprimaryPartyId%3D{ShipToParty}

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{ShipToParty}

The list of values indicating the ship to contact name.

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%3Bbu_id%3D{BusinessUnitId}%2CBindPartyId%3D{ShipToParty}

The list of values indicating the ship to sites.

The following properties are defined on the LOV link relation:

• Source Attribute: ShipToSite; 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

StatusVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_STATUS

The list of values indicating the status.

The following properties are defined on the LOV link relation:

• Source Attribute: Status; Target Attribute: LookupCode
• Display Attribute: Meaning

StrategyPriceListsVA

Operation: /crmRestApi/resources/11.13.18.05/requestedPriceLists

Parameters:

• finder: PriceListPickerFinder%3Bline_type_code%3DORA_BUY%2Cbusiness_unit_id%3D{BusinessUnitId}

The following properties are defined on the LOV link relation:

• Source Attribute: RenewalPriceListName; Target Attribute: Name
• Display Attribute: Name

SubscriptionProfileVA

Operation: /crmRestApi/resources/11.13.18.05/subscriptionProfiles

The list of values indicating the subscription profiles.

The following properties are defined on the LOV link relation:

• Source Attribute: SubscriptionProfileName; Target Attribute: SubscriptionProfileName
• Display Attribute: SubscriptionProfileName

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

TransactionTypeVA

Operation: /crmRestApi/resources/11.13.18.05/transactionTypes

Parameters:

• finder: BuIdFinder%3BbuId%3D{BusinessUnitId}

The list of values indicating the transaction type names.

The following properties are defined on the LOV link relation:

• Source Attribute: TransactionTypeName; Target Attribute: Name
• Display Attribute: Name

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

UserPVA

Operation: /crmRestApi/resources/11.13.18.05/users

The list of values indicating the LastUpdatedBy user.

The following properties are defined on the LOV link relation:

• Source Attribute: LastUpdatedBy; Target Attribute: LoginUsername
• Display Attribute: Username, DisplayName

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: OrganizationName, OrganizationCode

activate

Operation: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/action/activate

Parameters:

• SubscriptionNumber: $request.path.SubscriptionNumber

This method lets you activate a subscription. You must activate the subscription after creating it. Specify the Subscription Number to activate.

calculateCreditAmount

Operation: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/action/calculateCreditAmount

Parameters:

• SubscriptionNumber: $request.path.SubscriptionNumber

This method lets you calculate credit amount for a given subscription product PUID or a given external asset key. If both are specified, the subscription product PUID is given precedence.

calculateEarlyTerminationFee

Operation: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/action/calculateEarlyTerminationFee

Parameters:

• SubscriptionNumber: $request.path.SubscriptionNumber

This method lets you calculate early termination fee for a given subscription product or a given external asset key.

cancel

Operation: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/action/cancel

Parameters:

• SubscriptionNumber: $request.path.SubscriptionNumber

This method lets you cancel a subscription. You must provide a Subscription Number in order to cancel a subscription.

close

Operation: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/action/close

Parameters:

• SubscriptionNumber: $request.path.SubscriptionNumber

This method lets you close a subscription. You must specify a Subscription Number to close a subscription.

contractAttachment

Operation: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/contractAttachment

Parameters:

• SubscriptionNumber: $request.path.SubscriptionNumber

The contract attachments resource is used to view, create, and update attachments.

creditCards

Operation: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/creditCards

Parameters:

• SubscriptionNumber: $request.path.SubscriptionNumber

The credit cards resource is used to view, create, and update the credit card information associated with a subscription.

duplicateSubscription

Operation: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/action/duplicateSubscription

Parameters:

• SubscriptionNumber: $request.path.SubscriptionNumber

This method lets you duplicate a subscription. You must provide a Subscription Number to duplicate a subscription.

flexFields

Operation: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/flexFields

Parameters:

• SubscriptionNumber: $request.path.SubscriptionNumber

The descriptive flexfields resource is used to view, create, update, and delete a descriptive flexfield.

getEventTemplateOutput

Operation: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/action/getEventTemplateOutput

Parameters:

• SubscriptionNumber: $request.path.SubscriptionNumber

This method lets you get event template output in the form of subject, message text, and attachments given the subscription number, event code and language as inputs.

moveProducts

Operation: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/action/moveProducts

Parameters:

• SubscriptionNumber: $request.path.SubscriptionNumber

This method lets you move all products of a subscription to a target subscription.

parties

Operation: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/parties

Parameters:

• SubscriptionNumber: $request.path.SubscriptionNumber

The parties resource to view, create, update, and delete the subscription parties.

previewSubscriptions

Operation: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/action/previewSubscriptions

Parameters:

• SubscriptionNumber: $request.path.SubscriptionNumber

This method lets you preview a subscription. You must specify the subscription number in order to preview it.

products

Operation: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products

Parameters:

• SubscriptionNumber: $request.path.SubscriptionNumber

The products resource is used to view, create, update, and delete the product details for a subscription, such as start and end dates, item, unit price, amount, bill-to details, ship-to details, billing frequency, invoice rule, and payment method.

putOnHold

Operation: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/action/putOnHold

Parameters:

• SubscriptionNumber: $request.path.SubscriptionNumber

This method lets you put a subscription on hold. You must provide a Subscription Number in order to hold a subscription.

raiseUserTransition

Operation: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/action/raiseUserTransition

Parameters:

• SubscriptionNumber: $request.path.SubscriptionNumber

This method lets you raise a user transition for a subscription.

removeHold

Operation: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/action/removeHold

Parameters:

• SubscriptionNumber: $request.path.SubscriptionNumber

This method lets you remove hold on a subscription. You must specify a Subscription Number to remove hold on a subscription.

renew

Operation: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/action/renew

Parameters:

• SubscriptionNumber: $request.path.SubscriptionNumber

This method lets you renew a subscription. You must specify the Subscription Number in order to renew a subscription.

salesCredits

Operation: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/salesCredits

Parameters:

• SubscriptionNumber: $request.path.SubscriptionNumber

The sales credits resource is used to view, create, update, and delete the sales credits defined for subscription or subscription products.

smartActions

Operation: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/smartActions

Parameters:

• SubscriptionNumber: $request.path.SubscriptionNumber

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

submitEssJobRequest

Operation: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/action/submitEssJobRequest

Parameters:

• SubscriptionNumber: $request.path.SubscriptionNumber

This method lets you submit a scheduled process with a job name and other input parameters.

submitValidation

Operation: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/action/submitValidation

Parameters:

• SubscriptionNumber: $request.path.SubscriptionNumber

This method lets you validate a subscription.

subscriptionContact

Operation: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/subscriptionContact

Parameters:

• SubscriptionNumber: $request.path.SubscriptionNumber

The subscription contacts resource is used to view, create, delete and, update the external party contacts.

subscriptionTeam

Operation: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/subscriptionTeam

Parameters:

• SubscriptionNumber: $request.path.SubscriptionNumber

The subscription team is used to view the internal and external contacts of the subscription.

supportingDocumentAttachments

Operation: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/supportingDocumentAttachments

Parameters:

• SubscriptionNumber: $request.path.SubscriptionNumber

The supporting document attachments resource is used to view, create, and update supporting document attachments.

validateSubscription

Operation: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/validateSubscription

Parameters:

• SubscriptionNumber: $request.path.SubscriptionNumber

The validate subscriptions resource to view, create, update, and delete the validation errors for a subscription.

Back to Top

Examples

The following example shows how to create a subscription by submitting a POST request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptions

Example of Request Body

The following example shows the contents of the request body in JSON format.

{
    "SubscriptionNumber": "SUB-05678",
    "BusinessUnitId": 204,
    "LegalEntityId": 204,
    "SubscriptionProfileId": 300100172161473,
    "PrimaryPartyId": 1001,
    "Currency": "USD",
    "StartDate": "2019-01-01",
    "EndDate": "2024-12-31",
    "DefinitionOrganizationId": 204,
    "BillToAccountId": 1001,
    "BillToAccountNumber": "1001",
    "BillToSiteUseId": 1006,
    "PaymentTermsName": "Immediate"
}

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
{
    "SubscriptionId": 300100187385307,
    "SubscriptionNumber": "SUB-05678",
    "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": "2020-09-14T00: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": 6,
    "Period": "0zE",
    "EndDate": "2024-12-31",
    "DefinitionOrganizationId": 204,
    "DefinitionOrganizationName": "Vision Operations",
    "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": "2020-09-14T07:40:27+00:00",
    "LastUpdatedBy": "CONMGR",
    "LastUpdateDate": "2020-09-14T07:40:27.289+00:00",
    "LastUpdateLogin": "AE71B091FD86A49DE0530740F00A31E4",
    "RenewalType": null,
    "CustomerTrxTypeSequenceId": 806,
    "UsageCapture": "ORA_THIRD_PARTY",
    "LineAutonumberEnabledYn": false,
    "RenewalPaymentMethod": null,
    "RenewalPoNumber": null,
    "RenewalWireNumber": null,
    "RenewalPaymentMethodName": null,
    "UserStatusName": null,

...
}

Activate Subscription

You must activate the subscription after creating it. The following examples shows how to activate a subscription by submitting a POST request on the REST resource using cURL.

cURL Command

cURL Command curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptions/SUB-05678

Example of Request Body

The following shows the contents of the request body in JSON format.

{
"Status": "ORA_ACTIVE",
"StartDate": "2020-09-01",
"AccountingRuleId":-106,
"TransactionTypeName":"ORA_OSS_Invoice",
"BillToAccountId":1001,
"BillToSiteUseId":1006,
"PaymentTermsId":4
}

Example of Response Body

The following shows the contents of the response body in JSON format.

{
    "SubscriptionId": 300100187385307,
    "SubscriptionNumber": "SUB-05678",
    "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": "2020-09-14T00: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": "2020-09-01",
    "Duration": 52,
    "Period": "0zG",
    "EndDate": "2024-12-31",
    "DefinitionOrganizationId": 204,
    "DefinitionOrganizationName": "Vision Operations",
    "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": -106,
    "AccountingRuleName": "Daily Rate All Periods",
    "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": 4,
    "PaymentTermsName": "30 Net",
    "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": "2020-09-14T07:40:27+00:00",
    "LastUpdatedBy": "CONMGR",
    "LastUpdateDate": "2020-09-14T07:42:41+00:00",
    "LastUpdateLogin": "AE71AEEB979FA490E0530740F00A6F56",
    "RenewalType": null,
    "CustomerTrxTypeSequenceId": 806,
    "UsageCapture": "ORA_THIRD_PARTY",
    "LineAutonumberEnabledYn": false,
    "RenewalPaymentMethod": null,
    "RenewalPoNumber": null,
    "RenewalWireNumber": null,
    "RenewalPaymentMethodName": null,
    "UserStatusName": null,
...
}

Add Multiple Products or Covered Assets for a Subscription

The following example shows how to create multiple products or covered assets for a subscription by submitting a POST request on the REST resource using cURL.

cURL Command

curl --user sales_cloud_user -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptions

Example of Request Body

The following shows the contents of the request body in JSON format.

{
    "SubscriptionNumber": "GP-3333",
    "BusinessUnitId": 204,
    "LegalEntityId": 204,
    "SubscriptionProfileId": 300100172161474,
    "PrimaryPartyId": 1001,
    "Currency": "USD",
    "StartDate": "2020-01-30",
    "EndDate": "2021-01-29",
    "DefinitionOrganizationId": 204,
    "BillToAccountId": 1001,
    "BillToAccountNumber": "1001",
    "BillToSiteUseId": 1006,
    "CustomerAcceptance": "NOTREQUIRED",
    "InternalApproval": "NOTREQUIRED",
    "GenerateBillingSchedule": "Y",
    "products": [
        {
            "LineNumber": "P1",
            "ProductName": "Cloud Backup Service",
            "Quantity": 1,
            "charges": [
                {
                    "ChargeDefinition": "QP_SALE_PRICE",
                    "ChargeName": "Activation Fee",
                    "PriceType": "ONE_TIME",
                    "PricePeriodicity": "0zG",
                    "UnitListPrice": 500,
                    "adjustments": [
                        {
                            "AdjustmentType": "ORA_DISCOUNT_AMOUNT",
                            "AdjustmentValue": 50,
                            "Reason": "Special festival offer",
                            "SequenceNumber": 1,
                            "AdjustmentName": "Spl Discount",
                            "Effectivity": "ORA_ALL_TERM"
                        }
                    ]
                },
                {
                    "ChargeDefinition": "QP_RECURRING_SALE_PRICE",
                    "ChargeName": "Monthly Recurring Fee",
                    "PriceType": "RECURRING",
                    "PricePeriodicity": "0zG",
                    "UnitListPrice": 5.99
                }
            ]
        },
        {
            "LineNumber": "P2",
            "ProductName": "Dell Extend Warranty Online",
            "Quantity": 1,
            "coveredLevels": [
                {
                    "LineNumber": "1",
                    "AssetId": 4032,
                    "Type": "ORA_ASSET",
                    "Quantity": 1,
                    "ItemUnitOfMeasure": "Ea",
                    "PriceUnitOfMeasure": "0zE",
                    "charges": [
                        {
                            "ChargeDefinition": "OSS_YF",
                            "ChargeName": "Yearly Fee",
                            "PriceType": "RECURRING",
                            "PricePeriodicity": "0zE",
                            "UnitListPrice": 825
                        }
                    ]
                },
                {
                    "LineNumber": "2",
                    "AssetId": 4033,
                    "Type": "ORA_ASSET",
                    "Quantity": 1,
                    "ItemUnitOfMeasure": "Ea",
                    "PriceUnitOfMeasure": "0zE",
                    "charges": [
                        {
                            "ChargeDefinition": "OSS_YF",
                            "ChargeName": "Yearly Fee",
                            "PriceType": "RECURRING",
                            "PricePeriodicity": "0zE",
                            "UnitListPrice": 825
                        }
                    ]
                }
            ]
        }
    ]
}

Example of Response Body

The following shows the contents of the response body in JSON format.

{
    "SubscriptionId": 300100188538668,
    "SubscriptionNumber": "GP-3333",
    "BusinessUnitId": 204,
    "BusinessUnitName": "Vision Operations",
    "LegalEntityId": 204,
    "LegalEntityName": "Vision Operations",
    "SubscriptionProfileId": 300100172161474,
    "SubscriptionProfileName": "zOSS_SP_CalendarMonthActual_Advance_Month",
    "PrimaryPartyId": 1001,
    "PrimaryPartyName": "A T & T SOLUTIONS INC",
    "PricedOnDate": "2021-02-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": "2020-01-30",
    "Duration": 1,
    "Period": "0zE",
    "EndDate": "2021-01-29",
    "DefinitionOrganizationId": 204,
    "DefinitionOrganizationName": "Vision Operations",
    "PartialPeriodType": "ORA_ACTUAL",
    "PartialPeriodStart": "ORA_CALENDAR",
    "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": "NOTREQUIRED",
    "InternalApproval": "NOTREQUIRED",
    "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": "Y",
    "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": "2021-02-04T05:35:21+00:00",
    "LastUpdatedBy": "CONMGR",
    "LastUpdateDate": "2021-02-04T05:35:27.662+00:00",
    "LastUpdateLogin": "B9859778AE60F3AFE0533AFDF40A7CA6",
    "RenewalType": null,
    "CustomerTrxTypeSequenceId": 806,
    "UsageCapture": "ORA_THIRD_PARTY",
    "LineAutonumberEnabledYn": false,
    "RenewalPaymentMethod": null,
    "RenewalPoNumber": null,
    "RenewalWireNumber": null,
    "RenewalPaymentMethodName": null,
    "UserStatusName": null,
    "RepriceFlag": null,
    "products": [
        {
            "SubscriptionProductId": 300100188538671,
            "SubscriptionId": 300100188538668,
            "LineNumber": "P1",
            "SubscriptionProductPuid": "GP-3333-PRDT-6001",
            "DefinitionOrganizationId": 204,
            "SubscriptionNumber": "GP-3333",
            "SalesProductType": "SUBSCRIPTION",
            "Description": "Cloud Backup Service",
            "InventoryItemId": 300100178580511,
            "ItemUnitOfMeasure": "Ea",
            "ProductName": "Cloud Backup Service",
            "Quantity": 1,
            "StartDate": "2020-01-30",
            "EndDate": "2021-01-29",
            "CloseReason": null,
            "CloseCreditMethod": null,
            "CancelReason": null,
            "ClosedDate": null,
            "CanceledDate": null,
            "RenewedDate": null,
            "PriceListId": null,
            "UnitPrice": null,
            "Status": "ORA_DRAFT",
            "Currency": "USD",
            "InvoicingRuleId": -2,
            "InvoicingRuleName": "Advance Invoice",
            "BillOnDay": null,
            "BillingOffsetDays": null,
            "BillingFrequency": "0zG",
            "BillingFrequencyName": "MONTH",
            "AccountingRuleId": 300100033038413,
            "AccountingRuleName": "3 Months, Deferred",
            "TransactionTypeName": "ORA_OSS_Invoice",
            "InvoiceText": "[$Item Name]: [$Charge Name] [$Bill from Date]-[$Bill to Date]",
            "BillToAccountId": 1001,
            "BillToAccountNumber": "1001",
            "BillToAccountDescription": "A T & T SOLUTIONS INC",
            "BillToSiteUseId": 1006,
            "BillToAddress": "32 Ave of the Americas, , New York, NY 10013",
            "ShipToPartyId": null,
            "ShipToPartyName": null,
            "ShipToPartySiteId": null,
            "ShipToPartySiteName": null,
            "PaymentMethod": null,
            "PaymentMethodName": null,
            "PONumber": null,
            "WireNumber": null,
            "PaymentTermsId": 1064,
            "PaymentTermsName": "Immediate",
            "PrePaymentNumber": null,
            "TaxExemptionHandling": "S",
            "TaxExemptionHandlingName": "Standard",
            "ExemptCertificateNumber": null,
            "ExemptReason": null,
            "OutputTaxClassification": null,
            "ProductFiscClassification": null,
            "TaxError": null,
            "CoverageScheduleId": null,
            "RenewalType": "RENEW",
            "BillingDateCode": "ORA_PERIOD_START",
            "BillingDateName": "Period start",
            "TotalContractValue": null,
            "EstimatedTax": null,
            "PricingError": null,
            "PriceAsOf": "2021-02-04",
            "PriceTransactionOn": "2021-02-04",
            "InvoicedAmount": null,
            "CreditedAmount": null,
            "CanceledAmount": null,
            "ClosedAmount": null,
            "SourceSystem": null,
            "SourceKey": null,
            "SourceNumber": null,
            "SourceLineKey": null,
            "SourceLineNumber": null,
            "MonthlyRecurringRevenue": null,
            "Duration": 1,
            "Period": "0zE",
            "GenerateBillingSchedule": "Y",
            "ExternalAssetKey": null,
            "ExternalParentAssetKey": null,
            "ExternalPriceListId": null,
            "ExternalRootAssetKey": null,
            "PriceListName": null,
            "NextPricingDate": null,
            "PricingTermsStartDate": null,
            "PricingTermsPricingMethod": null,
            "PricingTermsPeriod": null,
            "PricingTermsDuration": null,
            "PricingTermsAdjustmentPCT": null,
            "CorpCurrencyCode": "USD",
            "CurcyConvRateType": "Corporate",
            "AmendCreditMethod": null,
            "AmendCreditMethodName": null,
            "AmendDescription": null,
            "AmendEffectiveDate": null,
            "AmendReason": null,
            "AmendReasonName": null,
            "StatusMeaning": "Draft",
            "EnablePricingTermsFlag": null,
            "NextBillStartDate": null,
            "TaxClassificationMeaning": null,
            "CreatedBy": "CONMGR",
            "CreationDate": "2021-02-04T05:35:22.797+00:00",
            "LastUpdatedBy": "CONMGR",
            "LastUpdateDate": "2021-02-04T05:35:27.732+00:00",
            "LastUpdateLogin": "B9859778AE60F3AFE0533AFDF40A7CA6",
            "SummarizedBillingFlag": null,
            "InterfaceOffsetDays": null,
            "CoverageName": null,
            "SuspendReason": null,
            "SuspendedDate": null,
            "SuspendCreditMethod": null,
            "ResumeDate": null,
            "ResumeDuration": null,
            "ResumePeriod": null,
            "AutoExtendFlag": null,
            "ChurnProbability": null,
            "EarlyTerminationPenalty": null,
            "EarlyTerminationFee": null,
            "GracePeriod": null,
            "PenaltyValue": null,
            "PenaltyChargeName": "Penalty Fee",
            "EarlyTerminationPenaltyName": null,
            "ChurnPredictionTrend": null,
            "PriceAdjustmentType": null,
            "PriceAdjustmentBasis": null,
            "PriceAdjustmentPercent": null,
            "DisplaySequence": null,
            "RelatedInventoryItemId": null,
            "RelatedProductName": null,
            "ProductChangeReason": null,
            "ProductChangeSchedule": null,
            "ProductChangeScheduleFrom": null,
            "DropOneTimeChargeFlag": null,
            "RelatedProductDescription": null,
            "GenerateBillFullPeriodFlag": null,
            "RenewalPaymentMethod": null,
            "RenewalPoNumber": null,
            "RenewalWireNumber": null,
            "RenewalPaymentMethodName": null,
            "CustomerTrxTypeSequenceId": 806,
            "RepriceFlag": null,
            "charges": [
                {
                    "BillLineId": null,
                    "ChargeDefinition": "QP_SALE_PRICE",
                    "ChargeId": 300100188538672,
                    "ChargePuid": "GP-3333-PRDT-6001-CHRG-7001",
                    "CoveredLevelId": null,
                    "PrePaymentNumber": null,
                    "PricePeriodicity": "0zG",
                    "PriceType": "ONE_TIME",
                    "RollupFlag": false,
                    "SequenceNumber": null,
                    "SubscriptionId": 300100188538668,
                    "SubscriptionProductId": 300100188538671,
                    "ChargeName": "Activation Fee",
                    "ExternalKey": null,
                    "ExternalParentKey": null,
                    "UnitListPrice": 500,
                    "Allowance": null,
                    "BlockSize": null,
                    "TieredFlag": null,
                    "TierType": null,
                    "UsagePriceLockFlag": null,
                    "PricePeriodicityName": "MONTH",
                    "ChargeDefinitionName": null,
                    "CreatedBy": "CONMGR",
                    "CreationDate": "2021-02-04T05:35:23.071+00:00",
                    "LastUpdateDate": "2021-02-04T05:35:27.260+00:00",
                    "LastUpdateLogin": "B9859778AE60F3AFE0533AFDF40A7CA6",
                    "LastUpdatedBy": "CONMGR",
                    "MeterDefinitionId": null,
                    "MeterId": null,
                    "InitialMeterReadingId": null,
                    "AggregationMethod": null,
                    "AssetMeterYn": null,
                    "TrueUpPeriod": null,
                    "TrueUpPeriodName": null,
                    "EstimatedAmount": null,
                    "EstimatedMethodName": null,
                    "EstimatedQuantity": null,
                    "EstimationMethod": null,
                    "MinimumAmount": null,
                    "MinimumQuantity": null,
                    "InvoicingRuleId": null,
                    "InvoicingRuleName": null,
                    "PeriodicBillingFlag": null,
                    "adjustments": [
                        {
                            "ChargeAdjustmentId": 300100188538673,
                            "ChargeAdjustmentPuid": "GP-3333-PRDT-6001-CHRG-7001-MADJ-3001",
                            "ChargeId": 300100188538672,
                            "PeriodFrom": null,
                            "PeriodUntil": null,
                            "AdjustmentType": "ORA_DISCOUNT_AMOUNT",
                            "AdjustmentValue": 50,
                            "AdjustmentBasis": null,
                            "Reason": "Special festival offer",
                            "SequenceNumber": 1,
                            "SubscriptionId": 300100188538668,
                            "SubscriptionProductId": 300100188538671,
                            "AdjustmentName": "Spl Discount",
                            "AutoAdjustmentFlag": null,
                            "Effectivity": "ORA_ALL_TERM",
                            "NumberOfPeriods": null,
                            "ObjectVersionNumber": 1,
                            "CreatedBy": "CONMGR",
                            "CreationDate": "2021-02-04T05:35:23.114+00:00",
                            "LastUpdateDate": "2021-02-04T05:35:27.292+00:00",
                            "LastUpdateLogin": "B9859778AE60F3AFE0533AFDF40A7CA6",
                            "LastUpdatedBy": "CONMGR",
...
}

Back to Top