Jump to

• Request
• Response
• Examples

Create a covered level

post

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

Request

Path Parameters

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

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode:
  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

• Address: string
  Title: Address

  The address of the party site.
• AssetGroupId: integer (int64)
  The unique identifier of the asset group.
• AssetGroupName: string
  Title: Asset Group Name

  The name of the asset group.
• AssetGroupNumber: string
  Title: Asset Group Number

  The alternate identifier of an asset group.
• AssetId: integer (int64)
  The unique identifier of the asset.
• AssetName: string
  Title: Covered Level Asset Name

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

  The serial number of the asset.
• billLines: array Bill Lines
  Title: Bill Lines

  The bill lines resource is used to view, create, update, and delete the subscription bill line details, such as charge period, date bill from, date billed to, amount, recurring flag, invoice text, usage quantity, and usage flags.
• CalculatedCreditAmount: number
  Title: Calculated Credit Amount

  The calculated credit amount of the covered level.
• CancelDescription: string
  Title: Cancellation Description

  Maximum Length: 2000

  The cancellation description associated with a covered level.
• CanceledAmount: number
  The amount that was canceled.
• CanceledDate: string (date)
  Title: Canceled Date

  The date when the covered level was canceled.
• CancelReason: string
  Title: Cancellation Reason

  Maximum Length: 30

  The reason for cancelling the covered level.
• charges: array Charges
  Title: Charges

  The charges resource is used to view, create, update, and delete the subscription charge details, such as charge name, charge definition, price type, price periodicity, and tiered flag.
• ClosedAmount: number
  The amount at which the covered level was closed.
• ClosedDate: string (date)
  Title: Covered Level Close Date

  The date when the covered level was closed.
• CloseDescription: string
  Title: Covered Level Close Description

  Maximum Length: 2000

  The close description associated with a covered level.
• CloseReason: string
  Title: Covered Level Close Reason

  Maximum Length: 30

  The reason why the covered level was closed.
• CorpCurrencyCode: string
  Maximum Length: 15

  The corporate currency code associated with the covered level. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.
• CoveredLevelId: integer (int64)
  The unique identifier of the covered level.
• CoveredLevelName: string
  Title: Covered Level Name

  Maximum Length: 300

  The name of the covered level.
• CoveredLevelParentPuid: string
  The alternate unique identifier of the covered level parent.
• CoveredLevelPuid(required): string
  Maximum Length: 120

  The public unique identifier of the covered level.
• CoveredLevlName: string
  Title: Covered Level Name

  The name of the covered level.
• CoveredLevlNumber: string
  Title: Covered Level Number

  The alternate identifier of the covered level.
• CreditedAmount: number
  The amount that was credited.
• CurcyConvRateType: string
  Maximum Length: 30

  The currency conversion rate type associated with the covered level. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE.
• CurrencyCode: string
  Maximum Length: 15

  The currency code associated with the covered level. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• CustomerAccountId: integer (int64)
  The unique identifier of the customer account.
• CustomerName: string
  Title: Customer Account

  The name of the customer.
• CustomerNumber: string
  Title: Customer Account Number

  The alternate unique identifier of the customer.
• Description: string
  Title: Covered Level Description

  A brief description of the covered level.
• Duration: integer
  The duration of the covered level.
• EndDate: string (date)
  Title: Covered Level End Date

  The date when the covered level ends.
• ExplodeAssetHierarchy: string
  Indicates if the assest hierarchy should be copied to other hierarchies.
• GenerateBillingSchedule: string
  Indicates whether the billing schedule is to be generated.
• HierarchyTotal: number
  The total covered level of the hierarchy.
• InventoryItemId: integer (int64)
  The unique identifier of the inventory item.
• InvoicedAmount: number
  The amount for which the invoice was created.
• InvoiceText: string
  Maximum Length: 2000

  The text included in the invoice.
• ItemUnitOfMeasure: string
  Maximum Length: 15

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

  Maximum Length: 300

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

  The override credit amount of the covered level.
• ParentCoveredAssetId: integer (int64)
  The unique identifier of the parent covered asset.
• ParentCoveredLevelId: integer (int64)
  The unique identifier of the parent covered level.
• PartyId: integer (int64)
  The unique identifier of the party.
• PartyName: string
  Title: Party Name

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

  The alternate identifier of the party.
• PartySite: string
  Title: Party Site Number

  The name of the party site.
• PartySiteId: integer (int64)
  The unique identifier of the party site.
• Period: string
  Maximum Length: 80

  The period of the covered level.
• PriceAsOf: string (date)
  The price as of a certain date.
• PriceListId: integer (int64)
  The unique identifier of the price list.
• PriceUnitOfMeasure: string
  Maximum Length: 30

  The unit of measure used to indicate the price.
• PriceUnitOfMeasureName: string
  Title: Pricing UOM

  The display name of the unit of measure.
• PricingError: string
  Maximum Length: 1000

  The error in the pricing, if any.
• ProductGroupId: integer (int64)
  The unique identifier of the product group.
• ProductGroupName: string
  Title: Product Group Name

  The name of the product group.
• ProductGroupNumber: string
  Title: Product Group Number

  The alternate identifier of a product group.
• ProductName: string
  Title: Product Name

  The name of the product associated with the covered level.
• PutOnHoldFlag: boolean
  Indicates if the covered level has been put on hold.
• Quantity: number
  Title: Quantity

  Default Value: 1

  The quantity of the covered level.
• relationships: array Relationships
  Title: Relationships

  The relationships resource is used to view, create, update, and delete the subscription product relationships details, such as relationship type, source subscription product PUID, and target subscription product PUID.
• RemoveHoldFlag: boolean
  Indicates if the hold on the covered level has to be removed.
• RenewalType: string
  Title: Renewal Type

  Maximum Length: 30

  The type of the covered level renewal.
• RenewedDate: string (date)
  The date when the covered level was renewed.
• RepriceFlag: boolean
  Indicates whether the subscription covered level should be repriced or not. If passed as 'true', the subscription covered level and its child covered levels will be repriced.
• ReturnCreditMethod: string
  Title: Close Credit Method

  Maximum Length: 230

  The method used to return the credit.
• RevenueOption: string
  Title: Revenue Accounting Option

  Maximum Length: 30

  Revenue Option
• RollupTotal: number
  The rollup total of covered level.
• SourceKey: string
  Maximum Length: 120

  The source key of the covered level.
• SourceLineKey: string
  Maximum Length: 120

  The source line key of the covered level.
• SourceLineNumber: string
  Maximum Length: 120

  The source line number of the covered level.
• SourceNumber: string
  Maximum Length: 120

  The source number of the covered level.
• SourceSystem: string
  Maximum Length: 30

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

  The date when the covered level starts.
• Status: string
  Title: Covered Level Status

  Maximum Length: 30

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

  The meaning of the status of the covered level.
• SubscriptionId(required): integer (int64)
  The unique identifier of the subscription.
• SubscriptionProductId(required): integer (int64)
  The unique identifier of the subscription product.
• SuppressedCreditAmount: number
  The credit amount that was suppressed.
• SuspendCreditMethod: string
  Maximum Length: 30

  Indicates if the credit method has to be suspended.
• SuspendedDate: string (date)
  Title: Covered Level Suspend Date

  The date when the covered level was suspended.
• SuspendReason: string
  Title: Covered Level Suspend Reason

  Maximum Length: 30

  The reason for suspending the credit method for the covered level.
• TaxAmount: number
  The tax amount levied on the transaction.
• TaxError: string
  Maximum Length: 4000

  The tax error, if any, in the calculated amount.
• TotalContractValue: number
  Title: Covered Level Contract Value

  The total contract value associated with the covered level.
• Type(required): string
  Title: Type

  Maximum Length: 30

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

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

  The unit price of the covered level.

{
    "required":[
        "CoveredLevelPuid",
        "StartDate",
        "SubscriptionId",
        "SubscriptionProductId",
        "Type"
    ],
    "type":"object",
    "properties":{
        "TypeName":{
            "title":"Covered Level Type",
            "type":"string",
            "description":"The name of the type of the covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CalculatedCreditAmount":{
            "title":"Calculated Credit Amount",
            "type":"number",
            "description":"The calculated credit amount of the covered level.",
            "nullable":true
        },
        "ProductName":{
            "title":"Product Name",
            "type":"string",
            "description":"The name of the product associated with the covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "Address":{
            "title":"Address",
            "type":"string",
            "description":"The address of the party site.",
            "nullable":true,
            "x-queryable":false
        },
        "ParentCoveredLevelId":{
            "type":"integer",
            "description":"The unique identifier of the parent covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "PartyName":{
            "title":"Party Name",
            "type":"string",
            "description":"The name of the party.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "CancelDescription":{
            "title":"Cancellation Description",
            "maxLength":"2000",
            "type":"string",
            "description":"The cancellation description associated with a covered level.",
            "nullable":true
        },
        "CurcyConvRateType":{
            "maxLength":"30",
            "type":"string",
            "description":"The currency conversion rate type associated with the covered level. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE.",
            "nullable":true
        },
        "ProductGroupName":{
            "title":"Product Group Name",
            "type":"string",
            "description":"The name of the product group.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "RollupTotal":{
            "type":"number",
            "description":"The rollup total of covered level.",
            "nullable":true
        },
        "SuspendCreditMethod":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates if the credit method has to be suspended.",
            "nullable":true
        },
        "StartDate":{
            "title":"Covered Level Start Date",
            "type":"string",
            "description":"The date when the covered level starts.",
            "format":"date",
            "nullable":false
        },
        "CurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The currency code associated with the covered level. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true
        },
        "ParentCoveredAssetId":{
            "type":"integer",
            "description":"The unique identifier of the parent covered asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "relationships":{
            "title":"Relationships",
            "type":"array",
            "description":"The relationships resource is used to view, create, update, and delete the subscription product relationships details, such as relationship type, source subscription product PUID, and target subscription product PUID.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-relationships-item-post-request"
            }
        },
        "TaxAmount":{
            "type":"number",
            "description":"The tax amount levied on the transaction.",
            "nullable":true
        },
        "SourceKey":{
            "maxLength":"120",
            "type":"string",
            "description":"The source key of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CloseReason":{
            "title":"Covered Level Close Reason",
            "maxLength":"30",
            "type":"string",
            "description":"The reason why the covered level was closed.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CustomerNumber":{
            "title":"Customer Account Number",
            "type":"string",
            "description":"The alternate unique identifier of the customer.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "CoveredLevelParentPuid":{
            "type":"string",
            "description":"The alternate unique identifier of the covered level parent.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceNumber":{
            "maxLength":"120",
            "type":"string",
            "description":"The source number of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "PartySiteId":{
            "type":"integer",
            "description":"The unique identifier of the party site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "CanceledDate":{
            "title":"Canceled Date",
            "type":"string",
            "description":"The date when the covered level was canceled.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ExplodeAssetHierarchy":{
            "type":"string",
            "description":"Indicates if the assest hierarchy should be copied to other hierarchies.",
            "nullable":true,
            "x-queryable":false
        },
        "AssetGroupId":{
            "type":"integer",
            "description":"The unique identifier of the asset group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CorpCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code associated with the covered level. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.",
            "nullable":true
        },
        "ItemUnitOfMeasure":{
            "maxLength":"15",
            "type":"string",
            "description":"The unit of measure used to measure the items in the covered level.",
            "nullable":true
        },
        "Status":{
            "title":"Covered Level Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the covered level.",
            "nullable":true
        },
        "CoveredLevelName":{
            "title":"Covered Level Name",
            "maxLength":"300",
            "type":"string",
            "description":"The name of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "AssetGroupNumber":{
            "title":"Asset Group Number",
            "type":"string",
            "description":"The alternate identifier of an asset group.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"The unique identifier of the inventory item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "CreditedAmount":{
            "type":"number",
            "description":"The amount that was credited.",
            "nullable":true
        },
        "Period":{
            "maxLength":"80",
            "type":"string",
            "description":"The period of the covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Duration":{
            "type":"integer",
            "description":"The duration of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "StatusName":{
            "title":"Status",
            "type":"string",
            "description":"The meaning of the status of the covered level.",
            "nullable":true
        },
        "RenewalType":{
            "title":"Renewal Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the covered level renewal.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AssetName":{
            "title":"Covered Level Asset Name",
            "type":"string",
            "description":"The name of the asset.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "AssetSerialNumber":{
            "title":"Covered Asset Serial Number",
            "type":"string",
            "description":"The serial number of the asset.",
            "nullable":true
        },
        "charges":{
            "title":"Charges",
            "type":"array",
            "description":"The charges resource is used to view, create, update, and delete the subscription charge details, such as charge name, charge definition, price type, price periodicity, and tiered flag.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-charges-item-post-request"
            }
        },
        "CancelReason":{
            "title":"Cancellation Reason",
            "maxLength":"30",
            "type":"string",
            "description":"The reason for cancelling the covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SuppressedCreditAmount":{
            "type":"number",
            "description":"The credit amount that was suppressed.",
            "nullable":true
        },
        "PriceUnitOfMeasureName":{
            "title":"Pricing UOM",
            "type":"string",
            "description":"The display name of the unit of measure.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PriceListId":{
            "type":"integer",
            "description":"The unique identifier of the price list.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ReturnCreditMethod":{
            "title":"Close Credit Method",
            "maxLength":"230",
            "type":"string",
            "description":"The method used to return the credit.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AssetId":{
            "type":"integer",
            "description":"The unique identifier of the asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "InvoicedAmount":{
            "type":"number",
            "description":"The amount for which the invoice was created.",
            "nullable":true
        },
        "SuspendedDate":{
            "title":"Covered Level Suspend Date",
            "type":"string",
            "description":"The date when the covered level was suspended.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "SourceLineNumber":{
            "maxLength":"120",
            "type":"string",
            "description":"The source line number of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CoveredLevlNumber":{
            "title":"Covered Level Number",
            "type":"string",
            "description":"The alternate identifier of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "ProductGroupNumber":{
            "title":"Product Group Number",
            "type":"string",
            "description":"The alternate identifier of a product group.",
            "nullable":true,
            "x-queryable":false
        },
        "AssetGroupName":{
            "title":"Asset Group Name",
            "type":"string",
            "description":"The name of the asset group.",
            "nullable":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Covered Level Description",
            "type":"string",
            "description":"A brief description of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CanceledAmount":{
            "type":"number",
            "description":"The amount that was canceled.",
            "nullable":true
        },
        "PriceAsOf":{
            "type":"string",
            "description":"The price as of a certain date.",
            "format":"date",
            "nullable":true
        },
        "LineNumber":{
            "title":"Number",
            "maxLength":"300",
            "type":"string",
            "description":"The line number",
            "nullable":true,
            "x-queryable":false
        },
        "PartySite":{
            "title":"Party Site Number",
            "type":"string",
            "description":"The name of the party site.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "InvoiceText":{
            "maxLength":"2000",
            "type":"string",
            "description":"The text included in the invoice.",
            "nullable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CoveredLevelPuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The public unique identifier of the covered level.",
            "nullable":false
        },
        "CustomerAccountId":{
            "type":"integer",
            "description":"The unique identifier of the customer account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "RevenueOption":{
            "title":"Revenue Accounting Option",
            "maxLength":"30",
            "type":"string",
            "description":"Revenue Option",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TaxError":{
            "maxLength":"4000",
            "type":"string",
            "description":"The tax error, if any, in the calculated amount.",
            "nullable":true
        },
        "CustomerName":{
            "title":"Customer Account",
            "type":"string",
            "description":"The name of the customer.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceLineKey":{
            "maxLength":"120",
            "type":"string",
            "description":"The source line key of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "ProductGroupId":{
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "RepriceFlag":{
            "type":"boolean",
            "description":"Indicates whether the subscription covered level should be repriced or not. If passed as 'true', the subscription covered level and its child covered levels will be repriced.",
            "nullable":true,
            "x-queryable":false
        },
        "billLines":{
            "title":"Bill Lines",
            "type":"array",
            "description":"The bill lines resource is used to view, create, update, and delete the subscription bill line details, such as charge period, date bill from, date billed to, amount, recurring flag, invoice text, usage quantity, and usage flags.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-billLines-item-post-request"
            }
        },
        "RenewedDate":{
            "type":"string",
            "description":"The date when the covered level was renewed.",
            "format":"date",
            "nullable":true
        },
        "TotalContractValue":{
            "title":"Covered Level Contract Value",
            "type":"number",
            "description":"The total contract value associated with the covered level.",
            "nullable":true
        },
        "SuspendReason":{
            "title":"Covered Level Suspend Reason",
            "maxLength":"30",
            "type":"string",
            "description":"The reason for suspending the credit method for the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity of the covered level.",
            "nullable":false,
            "default":"1"
        },
        "CoveredLevelId":{
            "type":"integer",
            "description":"The unique identifier of the covered level.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PriceUnitOfMeasure":{
            "maxLength":"30",
            "type":"string",
            "description":"The unit of measure used to indicate the price.",
            "nullable":true
        },
        "HierarchyTotal":{
            "type":"number",
            "description":"The total covered level of the hierarchy.",
            "nullable":true
        },
        "EndDate":{
            "title":"Covered Level End Date",
            "type":"string",
            "description":"The date when the covered level ends.",
            "format":"date",
            "nullable":true
        },
        "ClosedAmount":{
            "type":"number",
            "description":"The amount at which the covered level was closed.",
            "nullable":true
        },
        "CoveredLevlName":{
            "title":"Covered Level Name",
            "type":"string",
            "description":"The name of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "OverrideCreditAmount":{
            "title":"Override Credit Amount",
            "type":"number",
            "description":"The override credit amount of the covered level.",
            "nullable":true
        },
        "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.",
            "nullable":true,
            "x-queryable":false
        },
        "UnitPrice":{
            "title":"Unit Price",
            "type":"number",
            "description":"The unit price of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "GenerateBillingSchedule":{
            "type":"string",
            "description":"Indicates whether the billing schedule is to be generated.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "RemoveHoldFlag":{
            "type":"boolean",
            "description":"Indicates if the hold on the covered level has to be removed.",
            "nullable":true,
            "x-queryable":false
        },
        "ClosedDate":{
            "title":"Covered Level Close Date",
            "type":"string",
            "description":"The date when the covered level was closed.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "PricingError":{
            "maxLength":"1000",
            "type":"string",
            "description":"The error in the pricing, if any.",
            "nullable":true
        },
        "CloseDescription":{
            "title":"Covered Level Close Description",
            "maxLength":"2000",
            "type":"string",
            "description":"The close description associated with a covered level.",
            "nullable":true
        },
        "SourceSystem":{
            "maxLength":"30",
            "type":"string",
            "description":"The source system of the covered level.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Bill Lines

Type: array

Title: Bill Lines

The bill lines resource is used to view, create, update, and delete the subscription bill line details, such as charge period, date bill from, date billed to, amount, recurring flag, invoice text, usage quantity, and usage flags.

Show Source

• Array of: object schema

{
    "title":"Bill Lines",
    "type":"array",
    "description":"The bill lines resource is used to view, create, update, and delete the subscription bill line details, such as charge period, date bill from, date billed to, amount, recurring flag, invoice text, usage quantity, and usage flags.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-billLines-item-post-request"
    }
}

Nested Schema : Charges

Type: array

Title: Charges

The charges resource is used to view, create, update, and delete the subscription charge details, such as charge name, charge definition, price type, price periodicity, and tiered flag.

Show Source

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

{
    "title":"Charges",
    "type":"array",
    "description":"The charges resource is used to view, create, update, and delete the subscription charge details, such as charge name, charge definition, price type, price periodicity, and tiered flag.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-charges-item-post-request"
    }
}

Nested Schema : Relationships

Type: array

Title: Relationships

The relationships resource is used to view, create, update, and delete the subscription product relationships details, such as relationship type, source subscription product PUID, and target subscription product PUID.

Show Source

• Array of: object schema

{
    "title":"Relationships",
    "type":"array",
    "description":"The relationships resource is used to view, create, update, and delete the subscription product relationships details, such as relationship type, source subscription product PUID, and target subscription product PUID.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-relationships-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• Amount: number
  Title: Amount

  The amount for which the bill is generated.
• billAdjustments: array Bill Adjustments
  Title: Bill Adjustments

  The bill adjustments resource is used to view, create, update, and delete the subscription bill adjustment details, such as adjustment name, adjustment value, adjustment type, reason, and effectivity.
• BillingPeriod(required): number
  Title: Sequence

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

  The public unique identifier of the bill line.
• BusinessUnitId: integer
  The ID of the business unit associated with the bill line.
• ChargeDefinition: string
  Maximum Length: 30

  The definition that indicates the purpose of the charge.
• ChargeId: integer (int64)
  The unique identifier of the charge.
• ChargeName: string
  Title: Charge Name

  Maximum Length: 120

  The name of the charge associated with the bill line.
• ChargePeriod: number
  Title: Period

  The usage period that was charged.
• ChargePeriodFactor: number
  The change period factor associated with the bill line.
• CoveredLevelId: integer (int64)
  The unique identifier of the covered level.
• CreditMemoAmount: number
  The amount for the credit memo.
• CreditMemoFlag: string
  Indicates if there is a credit memo associated with the bill line.
• CreditMemoReason: string
  The reason to raise the credit memo.
• CreditMemoReasonCode: string
  Maximum Length: 30

  The code of the credit memo reason code.
• CustomerTrxTypeSequenceId: integer (int64)
  Customer Transaction Type Sequence Id
• DateBilledFrom(required): string (date)
  Title: Bill-from Date

  The date from which the bill was generated.
• DateBilledTo(required): string (date)
  Title: Bill-to Date

  The date up to which the bill is generated.
• DateToInterface: string (date)
  Title: Interface Date

  The date to interface for the bill line.
• InterfacedFlag: boolean
  Title: Interfaced

  Maximum Length: 1

  Default Value: false

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

  Maximum Length: 240

  The text in the bill line invoice.
• ListPrice: number
  The list price of the product associated with the bill line.
• MilestoneEventId: integer (int64)
  The ID of the milestone event associated with the bill line.
• MilestoneEventName: string
  The name of the milestone event associated with the bill line.
• NewCreditMemoPUID: string
  The unique public identifier of the new credit memo.
• PricedQuantity: number
  The quantity for which the bill line was charged.
• PricingError: string
  Maximum Length: 1000

  The error in pricing, if any.
• RecurringFlag(required): boolean
  Maximum Length: 1

  Indicates whether the line is recurring or not.
• RetrieveInvoiceFlag: boolean
  Title: Retrieve Invoice from Receivables

  Maximum Length: 1

  Retrieve Invoice Flag
• RevenueLineId: integer (int64)
  The unique identifier of the revenue line.
• RevenueOption: string
  Title: Revenue Accounting Option

  Maximum Length: 30

  Revenue Option
• RevenuePeriod: string
  Title: Revenue Effectivity Periods

  Maximum Length: 30

  Revenue Period
• SentDate: string (date)
  Title: Sent Date

  The date invoice information is sent to receivables.
• SubscriptionId: integer (int64)
  The unique identifier of the subscription.
• SubscriptionProductId: integer (int64)
  The unique identifier of the subscription product.
• SummarizedBillLineId: integer
  Title: Summarized Bill Line ID

  Summarized Bill Line ID
• TransactionAmount: number
  Title: Invoice Amount

  The amount for which the transaction occurred.
• TransactionClass: string
  Title: Transaction Class

  Maximum Length: 30

  The class of the transaction.
• TransactionClassMeaning: string
  Title: Class

  The meaning of transaction class lookup.
• TransactionDate: string (date)
  Title: Invoice Date

  The date when the transaction occurred.
• TransactionNumber: string
  Title: Invoice Number

  Maximum Length: 30

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

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

  Indicates if the bill line has a trueup period.
• TrxId: integer (int64)
  The AR transaction ID.
• TrxLineId: integer (int64)
  The AR transaction line ID.
• UsageAcquiredFlag: boolean
  Maximum Length: 1

  Indicates whether the usage has been acquired or not.
• UsageCaptureDate: string (date)
  The date when the usage was captured.
• UsageChargeType: string
  Title: Usage Charge Type

  Maximum Length: 30

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

  Indicates whether the line is a usage line or not.
• UsagePricedFlag: boolean
  Maximum Length: 1

  Indicates whether the usage line has been priced or not.
• UsageQuantity: number
  Title: Usage Quantity

  The quantity of the usage.

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

Nested Schema : Bill Adjustments

Type: array

Title: Bill Adjustments

The bill adjustments resource is used to view, create, update, and delete the subscription bill adjustment details, such as adjustment name, adjustment value, adjustment type, reason, and effectivity.

Show Source

• Array of: object subscriptionProducts-coveredLevels-billLines-billAdjustments-item-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, such as adjustment name, adjustment value, adjustment type, reason, and effectivity.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-billLines-billAdjustments-item-post-request"
    }
}

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

Type: object

Show Source

• AdjustmentBasis: string
  Title: Basis

  Maximum Length: 30

  The basis on which the bill is adjusted.
• AdjustmentName: string
  Title: Adjustment

  Maximum Length: 120

  The name of the bill adjustment.
• AdjustmentReasonCode: string
  Maximum Length: 30

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

  Maximum Length: 30

  The type of the bill adjustment.
• AdjustmentValue: number
  Title: Value

  The value by which the bill is adjusted.
• AutoAdjustmentFlag: boolean
  Maximum Length: 3

  Indicates whether the adjustment is automatic or not.
• BasisEnableFlag: boolean
  Indicates if the base has been enabled for the bill adjustment.
• BillAdjustmentId: integer (int64)
  The unique identifier of the bill adjustment.
• BillAdjustmentPuid: string
  Maximum Length: 120

  The public unique identifier of the bill adjustment.
• BillLineId: integer (int64)
  The unique identifier of the bill line.
• ChargeAdjustmentId: integer (int64)
  The unique identifier of the charge adjustment.
• CurrencyCode: string
  The current code used for the bill adjustment.
• Effectivity: string
  Maximum Length: 30

  The effectivity of the bill adjustment.
• NumberOfPeriods: number
  The number of periods
• PeriodFrom: number
  The period from which the bill was adjusted.
• PeriodUntil: number
  The period until which the bill is adjusted.
• Reason: string
  Title: Reason Details

  Maximum Length: 120

  The reason why the bill is adjusted.
• RevenueAdjustmentFromDate: string (date)
  Title: Revenue Effective Start Date

  Revenue Adjustment From Date
• RevenueAdjustmentToDate: string (date)
  Title: Revenue Effective End Date

  Revenue Adjustment To Date
• RevenueOption: string
  Title: Revenue Accounting Option

  Maximum Length: 30

  Revenue Option
• RevenuePeriod: string
  Title: Revenue Effectivity Periods

  Maximum Length: 30

  Revenue Period
• SequenceNumber: number
  Title: Sequence

  The sequence number of the bill adjustment.
• SubscriptionId: integer (int64)
  The unique identifier of the subscription.
• SubscriptionProductId: integer (int64)
  The unique identifier of the subscription product.

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

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

Type: object

Show Source

• adjustments: array Adjustments
  Title: Adjustments

  The adjustments resource is used to view, create, update, and delete the subscription charge adjustment details, such as adjustment name, adjustment type, adjustment value, adjustment reason, and effectivity.
• AggregationMethod: string
  Maximum Length: 30

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

  The allowance part of the charge.
• AssetMeterYn: boolean
  Maximum Length: 1

  The flag whether it is an asset meter or not.
• BillingFreq: string
  Maximum Length: 30

  Billing Frequency
• BillingFreqName: string
  Title: Billing Frequency

  Maximum Length: 255

  Billing Frequency Name
• BillLineId: integer (int64)
  The unique identifier of the bill line.
• BlockSize: number
  Title: Block Size

  The block size of the charge.
• ChargeDefinition: string
  Title: Charge Name

  Maximum Length: 30

  The definition that indicates the purpose of the charge.
• ChargeDefinitionName: string
  The name of the charge definition.
• ChargeId: integer (int64)
  The unique identifier of the charge.
• chargeMilestoneEvents: array Charge Milestone Events
  Title: Charge Milestone Events

  The charge milestone events resource is used to view, create, update, and delete the milestone events associated with a charge of a subscription.
• ChargeName: string
  Title: Charge Name

  Maximum Length: 120

  The name of the charge.
• ChargePeriodCode: string
  Maximum Length: 30

  The code of the charge period associated with the charge.
• ChargePuid: string
  Maximum Length: 120

  The public unique identifier of the charge.
• chargeTiers: array Charge Tiers
  Title: Charge Tiers

  The charge tiers resource is used to view, create, update, and delete the subscription charge tier details, such as tier from, tier to, and list price.
• CoveredLevelId: integer (int64)
  The unique identifier of the covered level.
• EnableProration: string
  Maximum Length: 1

  Indicates whether proration is enabled or not.
• EstimatedAmount: number
  Title: Estimated Amount

  The estimated amount of the charges.
• EstimatedMethodName: string
  Title: Estimation Method

  The method used to estimate the amount.
• EstimatedQuantity: number
  Title: Estimated Quantity

  The estimated quantity for the charge.
• EstimationMethod: string
  Title: Estimation Method

  Maximum Length: 30

  The method used to estimate the amount.
• ExternalKey: string
  Maximum Length: 120

  The external key used to measure the charge.
• ExternalParentKey: string
  Maximum Length: 120

  The external parent key.
• InitialMeterReadingId: integer (int64)
  The initial meter reading identifier value.
• InvoicingRuleId: integer (int64)
  The ID of the invoice rule.
• InvoicingRuleName: string
  Title: Invoicing Rule

  The name of the invoice rule.
• MeterDefinitionId: integer (int64)
  The unique identifier of the meter definition associated with the charges.
• MeterId: integer (int64)
  The unique identifier of the meter associated with the charges.
• MilestoneBillingFlag: boolean
  Indicates whether the billing is impacted by milestone events or not.
• MilestoneRevenueFlag: boolean
  Indicates whether the revenue is impacted by milestone events or not.
• MilestoneTemplateId: integer (int64)
  The ID of the milestone event associated with a charge.
• MilestoneTemplateName: string
  Maximum Length: 120

  The name of the milestone template associated with a charge.
• MinimumAmount: number
  Title: Minimum Amount

  The minimum amount to be charged.
• MinimumQuantity: number
  Title: Minimum Quantity

  The minimum quantity that is allowed.
• PeriodicBillingFlag: boolean
  Maximum Length: 1

  Indicates whether periodic billing is allowed or not.
• PeriodicRevenueFlag: boolean
  Title: Enable Periodic Revenue Recognition

  Maximum Length: 1

  Indicates the periodic revenue recognition of one-time charges.
• PrePaymentNumber: integer (int64)
  Title: Prepayment Number

  The prepayment number for the charge.
• PricePeriodicity: string
  Title: Periodicity

  Maximum Length: 30

  The price periodicity for the charge. Indicates the frequency when the charge has to be applied.
• PricePeriodicityName: string
  The name of the price periodicity.
• PriceType(required): string
  Maximum Length: 30

  The price type associated with the charge.
• QuotedTcv: number
  The quoted TCV of the charge.
• RecurringPricePeriodicityCode: string
  Maximum Length: 30

  The recurring price periodicity code of the charge.
• RollupFlag: boolean
  Maximum Length: 1

  Indicates if the charge needs to be rolled up.
• SequenceNumber: integer (int32)
  The sequence number for the charge.
• SubscriptionId: integer (int64)
  The unique identifier of the subscription.
• SubscriptionProductId: integer (int64)
  The unique identifier of the subscription product.
• TieredFlag: boolean
  Maximum Length: 3

  Indicates whether the charge has tiers.
• TierType: string
  Title: Tier Type

  Maximum Length: 30

  The type of the charge tier.
• TrueUpPeriod: string
  Title: True Up Period

  Maximum Length: 30

  Default Value: ORA_OSS_USAGE_BILLING_PERIOD

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

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

  The price of the unit list.
• UsagePriceLockFlag: boolean
  Maximum Length: 3

  Indicates whether the usage price is locked or not.
• UsageUnitOfMeasure: string
  Maximum Length: 3

  The usage unit of measure of the charge.

{
    "required":[
        "PriceType"
    ],
    "type":"object",
    "properties":{
        "AggregationMethod":{
            "maxLength":"30",
            "type":"string",
            "description":"The aggregation method used for the charges.",
            "nullable":true
        },
        "ChargePuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The public unique identifier of the charge.",
            "nullable":true
        },
        "chargeMilestoneEvents":{
            "title":"Charge Milestone Events",
            "type":"array",
            "description":"The charge milestone events resource is used to view, create, update, and delete the milestone events associated with a charge of a subscription.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-charges-chargeMilestoneEvents-item-post-request"
            }
        },
        "adjustments":{
            "title":"Adjustments",
            "type":"array",
            "description":"The adjustments resource is used to view, create, update, and delete the subscription charge adjustment details, such as adjustment name, adjustment type, adjustment value, adjustment reason, and effectivity.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-charges-adjustments-item-post-request"
            }
        },
        "ChargeDefinition":{
            "title":"Charge Name",
            "maxLength":"30",
            "type":"string",
            "description":"The definition that indicates the purpose of the charge.",
            "nullable":true
        },
        "AssetMeterYn":{
            "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":{
            "type":"string",
            "description":"The name of the price periodicity.",
            "nullable":true
        },
        "PrePaymentNumber":{
            "title":"Prepayment Number",
            "type":"integer",
            "description":"The prepayment number for the charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "BillingFreq":{
            "maxLength":"30",
            "type":"string",
            "description":"Billing Frequency",
            "nullable":true
        },
        "MeterDefinitionId":{
            "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":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether periodic billing is allowed or not.",
            "nullable":true
        },
        "MilestoneBillingFlag":{
            "type":"boolean",
            "description":"Indicates whether the billing is impacted by milestone events or not.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "ExternalParentKey":{
            "maxLength":"120",
            "type":"string",
            "description":"The external parent key.",
            "nullable":true
        },
        "UnitListPrice":{
            "title":"List Price",
            "type":"number",
            "description":"The price of the unit list.",
            "nullable":true
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"The sequence number for the charge.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            }
        },
        "InitialMeterReadingId":{
            "type":"integer",
            "description":"The initial meter reading identifier value.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "EstimatedQuantity":{
            "title":"Estimated Quantity",
            "type":"number",
            "description":"The estimated quantity for the charge.",
            "nullable":true
        },
        "ChargeName":{
            "title":"Charge Name",
            "maxLength":"120",
            "type":"string",
            "description":"The name of the charge.",
            "nullable":true
        },
        "RecurringPricePeriodicityCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The recurring price periodicity code of the charge.",
            "nullable":true
        },
        "QuotedTcv":{
            "type":"number",
            "description":"The quoted TCV of the charge.",
            "nullable":true
        },
        "TieredFlag":{
            "maxLength":"3",
            "type":"boolean",
            "description":"Indicates whether the charge has tiers.",
            "nullable":true
        },
        "UsagePriceLockFlag":{
            "maxLength":"3",
            "type":"boolean",
            "description":"Indicates whether the usage price is locked or not.",
            "nullable":true
        },
        "PeriodicRevenueFlag":{
            "title":"Enable Periodic Revenue Recognition",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the periodic revenue recognition of one-time charges.",
            "nullable":true
        },
        "MilestoneRevenueFlag":{
            "type":"boolean",
            "description":"Indicates whether the revenue is impacted by milestone events or not.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "chargeTiers":{
            "title":"Charge Tiers",
            "type":"array",
            "description":"The charge tiers resource is used to view, create, update, and delete the subscription charge tier details, such as tier from, tier to, and list price.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-charges-chargeTiers-item-post-request"
            }
        },
        "MinimumAmount":{
            "title":"Minimum Amount",
            "type":"number",
            "description":"The minimum amount to be charged.",
            "nullable":true
        },
        "PriceType":{
            "maxLength":"30",
            "type":"string",
            "description":"The price type associated with the charge.",
            "nullable":false
        },
        "RollupFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the charge needs to be rolled up.",
            "nullable":true
        },
        "TierType":{
            "title":"Tier Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the charge tier.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "InvoicingRuleName":{
            "title":"Invoicing Rule",
            "type":"string",
            "description":"The name of the invoice rule.",
            "nullable":true,
            "x-queryable":false
        },
        "MeterId":{
            "type":"integer",
            "description":"The unique identifier of the meter associated with the charges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ChargeDefinitionName":{
            "type":"string",
            "description":"The name of the charge definition.",
            "nullable":true
        },
        "UsageUnitOfMeasure":{
            "maxLength":"3",
            "type":"string",
            "description":"The usage unit of measure of the charge.",
            "nullable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "EnableProration":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether proration is enabled or not.",
            "nullable":true
        },
        "TrueUpPeriodName":{
            "title":"True Up Period",
            "type":"string",
            "description":"The name of the trueup period.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ExternalKey":{
            "maxLength":"120",
            "type":"string",
            "description":"The external key used to measure the charge.",
            "nullable":true
        },
        "ChargePeriodCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code of the charge period associated with the charge.",
            "nullable":true
        },
        "Allowance":{
            "title":"Allowance",
            "type":"number",
            "description":"The allowance part of the charge.",
            "nullable":true
        },
        "InvoicingRuleId":{
            "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":{
            "type":"integer",
            "description":"The ID of the milestone event associated with a charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "CoveredLevelId":{
            "type":"integer",
            "description":"The unique identifier of the covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "BillingFreqName":{
            "title":"Billing Frequency",
            "maxLength":"255",
            "type":"string",
            "description":"Billing Frequency Name",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "MinimumQuantity":{
            "title":"Minimum Quantity",
            "type":"number",
            "description":"The minimum quantity that is allowed.",
            "nullable":true
        },
        "EstimatedMethodName":{
            "title":"Estimation Method",
            "type":"string",
            "description":"The method used to estimate the amount.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PricePeriodicity":{
            "title":"Periodicity",
            "maxLength":"30",
            "type":"string",
            "description":"The price periodicity for the charge. Indicates the frequency when the charge has to be applied.",
            "nullable":true
        },
        "TrueUpPeriod":{
            "title":"True Up Period",
            "maxLength":"30",
            "type":"string",
            "description":"The identifier of the trueup period.",
            "nullable":true,
            "default":"ORA_OSS_USAGE_BILLING_PERIOD"
        },
        "BillLineId":{
            "type":"integer",
            "description":"The unique identifier of the bill line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ChargeId":{
            "type":"integer",
            "description":"The unique identifier of the charge.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "BlockSize":{
            "title":"Block Size",
            "type":"number",
            "description":"The block size of the charge.",
            "nullable":true
        }
    }
}

Nested Schema : Adjustments

Type: array

Title: Adjustments

The adjustments resource is used to view, create, update, and delete the subscription charge adjustment details, such as adjustment name, adjustment type, adjustment value, adjustment reason, and effectivity.

Show Source

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

{
    "title":"Adjustments",
    "type":"array",
    "description":"The adjustments resource is used to view, create, update, and delete the subscription charge adjustment details, such as adjustment name, adjustment type, adjustment value, adjustment reason, and effectivity.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-charges-adjustments-item-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 subscriptionProducts-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/subscriptionProducts-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, such as tier from, tier to, and list price.

Show Source

• Array of: object subscriptionProducts-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, such as tier from, tier to, and list price.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-charges-chargeTiers-item-post-request"
    }
}

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

Type: object

Show Source

• AdjustmentBasis: string
  Title: Basis

  Maximum Length: 30

  The basis of the adjustment.
• AdjustmentName: string
  Title: Adjustment

  Maximum Length: 120

  The name of the adjustment.
• AdjustmentReasonCode: string
  Title: Reason

  Maximum Length: 30

  The code of the adjustment reason.
• AdjustmentReasonMeaning: string
  Title: Reason

  The translated adjustment reason.
• AdjustmentType: string
  Title: Type

  Maximum Length: 30

  The type of the adjustment.
• AdjustmentValue: number
  Title: Value

  The value of the adjustment.
• AutoAdjustmentFlag: boolean
  Maximum Length: 3

  Indicates whether the adjustment is automatic or not.
• ChargeAdjustmentId: integer (int64)
  The unique identifier of the charge adjustment.
• ChargeAdjustmentPuid: string
  Maximum Length: 120

  The public unique identifier of the charge adjustment.
• ChargeId: integer (int64)
  The unique identifier of the charge.
• Effectivity: string
  Title: Effectivity

  Maximum Length: 30

  The adjustment effectivity
• NumberOfPeriods: number
  The number of periods
• ObjectVersionNumber: integer (int32)
  The number used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
• PeriodFrom: number
  The period from which the adjustment was initiated.
• PeriodUntil: number
  The period until which the adjustment is initiated.
• Reason: string
  Title: Reason Description

  Maximum Length: 120

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

  The sequence number of the adjustment.
• SubscriptionId: integer (int64)
  The unique identifier of the subscription.
• SubscriptionProductId: integer (int64)
  The unique identifier of the subscription product.

{
    "type":"object",
    "properties":{
        "AutoAdjustmentFlag":{
            "maxLength":"3",
            "type":"boolean",
            "description":"Indicates whether the adjustment is automatic or not.",
            "nullable":true
        },
        "ChargeAdjustmentPuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The public unique identifier of the charge adjustment.",
            "nullable":true
        },
        "AdjustmentBasis":{
            "title":"Basis",
            "maxLength":"30",
            "type":"string",
            "description":"The basis of the adjustment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChargeAdjustmentId":{
            "type":"integer",
            "description":"The unique identifier of the charge adjustment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AdjustmentReasonCode":{
            "title":"Reason",
            "maxLength":"30",
            "type":"string",
            "description":"The code of the adjustment reason.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Effectivity":{
            "title":"Effectivity",
            "maxLength":"30",
            "type":"string",
            "description":"The adjustment effectivity",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Reason":{
            "title":"Reason Description",
            "maxLength":"120",
            "type":"string",
            "description":"The reason for the adjustment.",
            "nullable":true
        },
        "AdjustmentType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the adjustment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "AdjustmentValue":{
            "title":"Value",
            "type":"number",
            "description":"The value of the adjustment.",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The number used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"integer",
            "description":"The sequence number of the adjustment.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            }
        },
        "NumberOfPeriods":{
            "type":"number",
            "description":"The number of periods",
            "nullable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The unique identifier of the charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "PeriodUntil":{
            "type":"number",
            "description":"The period until which the adjustment is initiated.",
            "nullable":true
        },
        "AdjustmentReasonMeaning":{
            "title":"Reason",
            "type":"string",
            "description":"The translated adjustment reason.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "AdjustmentName":{
            "title":"Adjustment",
            "maxLength":"120",
            "type":"string",
            "description":"The name of the adjustment.",
            "nullable":true
        },
        "PeriodFrom":{
            "type":"number",
            "description":"The period from which the adjustment was initiated.",
            "nullable":true
        }
    }
}

Nested Schema : subscriptionProducts-coveredLevels-charges-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.
• 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"
            }
        },
        "CompletionDate":{
            "type":"string",
            "description":"The completion date of the milestone event.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BillingOffset"
                ]
            }
        }
    }
}

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

Type: object

Show Source

• AdditionalNumberFive: number
  Title: Additional Number Five

  Additional number, if any, for the charge tier.
• AdditionalNumberFour: number
  Title: Additional Number Four

  Additional number, if any, for the charge tier.
• AdditionalNumberOne: number
  Title: Additional Number One

  Additional number, if any, for the charge tier.
• AdditionalNumberSix: number
  Title: Additional Number Six

  Additional number, if any, for the charge tier.
• AdditionalNumberThree: number
  Title: Additional Number Three

  Additional number, if any, for the charge tier.
• AdditionalNumberTwo: number
  Title: Additional Number Two

  Additional number, if any, for the charge tier.
• AdditionalTextOne: string
  Title: Additional Text One

  Maximum Length: 4000

  Additional text, if any, for the charge tier.
• AdditionalTextTwo: string
  Title: Additional Text Two

  Maximum Length: 4000

  Additional text, if any, for the charge tier.
• AdditionalTimestampOne: string (date-time)
  Title: Additional Time-stamp One

  Additional timestamp, if any, for the charge tier.
• AdditionalTimestampThree: string (date-time)
  Title: Additional Time-stamp Three

  Additional timestamp, if any, for the charge tier.
• AdditionalTimestampTwo: string (date-time)
  Title: Additional Time-stamp Two

  Additional timestamp, if any, for the charge tier.
• AddtionalTextThree: string
  Title: Additional Text Three

  Maximum Length: 4000

  Additional text, if any, for the charge tier.
• BlockSize: number
  Title: Block Size

  The block size
• ChargeId: integer (int64)
  The unique identifier of the charge.
• ChargeTierId: integer (int64)
  The unique identifier of the charge tier.
• ChargeTierPuid: string
  Maximum Length: 120

  The public unique identifier of the charge tier.
• ListPrice: number
  Title: List Price

  The list price
• PriceFormat: string
  Title: Price Format

  Maximum Length: 30

  The display format of the price.
• SequenceNumber: number
  The sequence number
• SubscriptionId: integer (int64)
  The unique identifier of the subscription.
• SubscriptionProductId: integer (int64)
  The unique identifier of the subscription product.
• TierFrom: number
  Title: Tier From

  The tier from
• TierTo: number
  Title: Tier To

  The tier to

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

Nested Schema : schema

Type: object

Show Source

• OperationLinksPuid: string
  Maximum Length: 120

  The public unique identifier of the operation links.
• RelationshipTypeCode: string
  Maximum Length: 30

  The code indicating the type of the relationship.
• SourceAssetKey: string
  Maximum Length: 120

  The source asset key
• SourceProdAssociationId: integer (int64)
  The unique identifier of the source product association.
• SourceProdAssociationPuid: string
  Maximum Length: 120

  The public unique identifier of the source product association.
• SourceProductPuid: string
  Maximum Length: 120

  The public unique identifier of the source product.
• SourceRootAssetKey: string
  Maximum Length: 120

  The source root asset key
• TargetProdAssociationId: integer (int64)
  The unique identifier of the target product association.
• TargetProdAssociationPuid: string
  Maximum Length: 120

  The public unique identifier of the target product association.
• TargetProductPuid: string
  Maximum Length: 120

  The public unique identifier of the target product.

{
    "type":"object",
    "properties":{
        "RelationshipTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of the relationship.",
            "nullable":false
        },
        "OperationLinksPuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The public unique identifier of the operation links.",
            "nullable":true
        },
        "SourceProdAssociationId":{
            "type":"integer",
            "description":"The unique identifier of the source product association.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "TargetProdAssociationId":{
            "type":"integer",
            "description":"The unique identifier of the target product association.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "SourceAssetKey":{
            "maxLength":"120",
            "type":"string",
            "description":"The source asset key",
            "nullable":true
        },
        "SourceProductPuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The public unique identifier of the source product.",
            "nullable":true
        },
        "SourceRootAssetKey":{
            "maxLength":"120",
            "type":"string",
            "description":"The source root asset key",
            "nullable":true
        },
        "SourceProdAssociationPuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The public unique identifier of the source product association.",
            "nullable":true
        },
        "TargetProductPuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The public unique identifier of the target product.",
            "nullable":true
        },
        "TargetProdAssociationPuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The public unique identifier of the target product association.",
            "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 : subscriptionProducts-coveredLevels-item-response

Type: object

Show Source

• Address: string
  Title: Address

  The address of the party site.
• AssetGroupId: integer (int64)
  The unique identifier of the asset group.
• AssetGroupName: string
  Title: Asset Group Name

  The name of the asset group.
• AssetGroupNumber: string
  Title: Asset Group Number

  The alternate identifier of an asset group.
• AssetId: integer (int64)
  The unique identifier of the asset.
• AssetName: string
  Title: Covered Level Asset Name

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

  The serial number of the asset.
• billLines: array Bill Lines
  Title: Bill Lines

  The bill lines resource is used to view, create, update, and delete the subscription bill line details, such as charge period, date bill from, date billed to, amount, recurring flag, invoice text, usage quantity, and usage flags.
• CalculatedCreditAmount: number
  Title: Calculated Credit Amount

  The calculated credit amount of the covered level.
• CancelDescription: string
  Title: Cancellation Description

  Maximum Length: 2000

  The cancellation description associated with a covered level.
• CanceledAmount: number
  The amount that was canceled.
• CanceledDate: string (date)
  Title: Canceled Date

  The date when the covered level was canceled.
• CancelReason: string
  Title: Cancellation Reason

  Maximum Length: 30

  The reason for cancelling the covered level.
• charges: array Charges
  Title: Charges

  The charges resource is used to view, create, update, and delete the subscription charge details, such as charge name, charge definition, price type, price periodicity, and tiered flag.
• ClosedAmount: number
  The amount at which the covered level was closed.
• ClosedDate: string (date)
  Title: Covered Level Close Date

  The date when the covered level was closed.
• CloseDescription: string
  Title: Covered Level Close Description

  Maximum Length: 2000

  The close description associated with a covered level.
• CloseReason: string
  Title: Covered Level Close Reason

  Maximum Length: 30

  The reason why the covered level was closed.
• CorpCurrencyCode: string
  Maximum Length: 15

  The corporate currency code associated with the covered level. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.
• CoveredLevelId: integer (int64)
  The unique identifier of the covered level.
• CoveredLevelName: string
  Title: Covered Level Name

  Maximum Length: 300

  The name of the covered level.
• CoveredLevelParentPuid: string
  The alternate unique identifier of the covered level parent.
• CoveredLevelPuid: string
  Maximum Length: 120

  The public unique identifier of the covered level.
• CoveredLevlName: string
  Title: Covered Level Name

  The name of the covered level.
• CoveredLevlNumber: string
  Title: Covered Level Number

  The alternate identifier of the covered level.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date when the covered level was created.
• CreditedAmount: number
  The amount that was credited.
• CurcyConvRateType: string
  Maximum Length: 30

  The currency conversion rate type associated with the covered level. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE.
• CurrencyCode: string
  Maximum Length: 15

  The currency code associated with the covered level. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• CustomerAccountId: integer (int64)
  The unique identifier of the customer account.
• CustomerName: string
  Title: Customer Account

  The name of the customer.
• CustomerNumber: string
  Title: Customer Account Number

  The alternate unique identifier of the customer.
• Description: string
  Title: Covered Level Description

  A brief description of the covered level.
• Duration: integer
  The duration of the covered level.
• EndDate: string (date)
  Title: Covered Level End Date

  The date when the covered level ends.
• ExplodeAssetHierarchy: string
  Indicates if the assest hierarchy should be copied to other hierarchies.
• GenerateBillingSchedule: string
  Indicates whether the billing schedule is to be generated.
• HierarchyTotal: number
  The total covered level of the hierarchy.
• InventoryItemId: integer (int64)
  The unique identifier of the inventory item.
• InvoicedAmount: number
  The amount for which the invoice was created.
• InvoiceText: string
  Maximum Length: 2000

  The text included in the invoice.
• ItemUnitOfMeasure: string
  Maximum Length: 15

  The unit of measure used to measure the items in the covered level.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

  Maximum Length: 32

  The login details of the user who last updated the covered level.
• LineNumber: string
  Title: Number

  Maximum Length: 300

  The line number
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OverrideCreditAmount: number
  Title: Override Credit Amount

  The override credit amount of the covered level.
• ParentCoveredAssetId: integer (int64)
  The unique identifier of the parent covered asset.
• ParentCoveredLevelId: integer (int64)
  The unique identifier of the parent covered level.
• PartyId: integer (int64)
  The unique identifier of the party.
• PartyName: string
  Title: Party Name

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

  The alternate identifier of the party.
• PartySite: string
  Title: Party Site Number

  The name of the party site.
• PartySiteId: integer (int64)
  The unique identifier of the party site.
• Period: string
  Maximum Length: 80

  The period of the covered level.
• PriceAsOf: string (date)
  The price as of a certain date.
• PriceListId: integer (int64)
  The unique identifier of the price list.
• PriceUnitOfMeasure: string
  Maximum Length: 30

  The unit of measure used to indicate the price.
• PriceUnitOfMeasureName: string
  Title: Pricing UOM

  The display name of the unit of measure.
• PricingError: string
  Maximum Length: 1000

  The error in the pricing, if any.
• ProductGroupId: integer (int64)
  The unique identifier of the product group.
• ProductGroupName: string
  Title: Product Group Name

  The name of the product group.
• ProductGroupNumber: string
  Title: Product Group Number

  The alternate identifier of a product group.
• ProductName: string
  Title: Product Name

  The name of the product associated with the covered level.
• PutOnHoldFlag: boolean
  Indicates if the covered level has been put on hold.
• Quantity: number
  Title: Quantity

  Default Value: 1

  The quantity of the covered level.
• relationships: array Relationships
  Title: Relationships

  The relationships resource is used to view, create, update, and delete the subscription product relationships details, such as relationship type, source subscription product PUID, and target subscription product PUID.
• RemoveHoldFlag: boolean
  Indicates if the hold on the covered level has to be removed.
• RenewalType: string
  Title: Renewal Type

  Maximum Length: 30

  The type of the covered level renewal.
• RenewedDate: string (date)
  The date when the covered level was renewed.
• RepriceFlag: boolean
  Indicates whether the subscription covered level should be repriced or not. If passed as 'true', the subscription covered level and its child covered levels will be repriced.
• ReturnCreditMethod: string
  Title: Close Credit Method

  Maximum Length: 230

  The method used to return the credit.
• RevenueOption: string
  Title: Revenue Accounting Option

  Maximum Length: 30

  Revenue Option
• RollupTotal: number
  The rollup total of covered level.
• SerialNumber: string
  Title: Covered Asset Serial Number

  Read Only: true

  Maximum Length: 80

  The serial number of the covered level.
• SourceKey: string
  Maximum Length: 120

  The source key of the covered level.
• SourceLineKey: string
  Maximum Length: 120

  The source line key of the covered level.
• SourceLineNumber: string
  Maximum Length: 120

  The source line number of the covered level.
• SourceNumber: string
  Maximum Length: 120

  The source number of the covered level.
• SourceSystem: string
  Maximum Length: 30

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

  The date when the covered level starts.
• Status: string
  Title: Covered Level Status

  Maximum Length: 30

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

  The meaning of the status of the covered level.
• SubscriptionId: integer (int64)
  The unique identifier of the subscription.
• SubscriptionProductId: integer (int64)
  The unique identifier of the subscription product.
• SuppressedCreditAmount: number
  The credit amount that was suppressed.
• SuspendCreditMethod: string
  Maximum Length: 30

  Indicates if the credit method has to be suspended.
• SuspendedDate: string (date)
  Title: Covered Level Suspend Date

  The date when the covered level was suspended.
• SuspendReason: string
  Title: Covered Level Suspend Reason

  Maximum Length: 30

  The reason for suspending the credit method for the covered level.
• TaxAmount: number
  The tax amount levied on the transaction.
• TaxError: string
  Maximum Length: 4000

  The tax error, if any, in the calculated amount.
• TotalContractValue: number
  Title: Covered Level Contract Value

  The total contract value associated with the covered level.
• Type: string
  Title: Type

  Maximum Length: 30

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

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

  The unit price of the covered level.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the covered level was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CalculatedCreditAmount":{
            "title":"Calculated Credit Amount",
            "type":"number",
            "description":"The calculated credit amount of the covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "Address":{
            "title":"Address",
            "type":"string",
            "description":"The address of the party site.",
            "nullable":true,
            "x-queryable":false
        },
        "CancelDescription":{
            "title":"Cancellation Description",
            "maxLength":"2000",
            "type":"string",
            "description":"The cancellation description associated with a covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "maxLength":"30",
            "type":"string",
            "description":"The currency conversion rate type associated with the covered level. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductGroupName":{
            "title":"Product Group Name",
            "type":"string",
            "description":"The name of the product group.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "RollupTotal":{
            "type":"number",
            "description":"The rollup total of covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The currency code associated with the covered level. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentCoveredAssetId":{
            "type":"integer",
            "description":"The unique identifier of the parent covered asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "relationships":{
            "title":"Relationships",
            "type":"array",
            "description":"The relationships resource is used to view, create, update, and delete the subscription product relationships details, such as relationship type, source subscription product PUID, and target subscription product PUID.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-relationships-item-response"
            }
        },
        "TaxAmount":{
            "type":"number",
            "description":"The tax amount levied on the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceKey":{
            "maxLength":"120",
            "type":"string",
            "description":"The source key of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CloseReason":{
            "title":"Covered Level Close Reason",
            "maxLength":"30",
            "type":"string",
            "description":"The reason why the covered level was closed.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CoveredLevelParentPuid":{
            "type":"string",
            "description":"The alternate unique identifier of the covered level parent.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceNumber":{
            "maxLength":"120",
            "type":"string",
            "description":"The source number of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "PartySiteId":{
            "type":"integer",
            "description":"The unique identifier of the party site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CanceledDate":{
            "title":"Canceled Date",
            "type":"string",
            "description":"The date when the covered level was canceled.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ExplodeAssetHierarchy":{
            "type":"string",
            "description":"Indicates if the assest hierarchy should be copied to other hierarchies.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the covered level.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Covered Level Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the covered level.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetGroupNumber":{
            "title":"Asset Group Number",
            "type":"string",
            "description":"The alternate identifier of an asset group.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"The unique identifier of the inventory item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreditedAmount":{
            "type":"number",
            "description":"The amount that was credited.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusName":{
            "title":"Status",
            "type":"string",
            "description":"The meaning of the status of the covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "charges":{
            "title":"Charges",
            "type":"array",
            "description":"The charges resource is used to view, create, update, and delete the subscription charge details, such as charge name, charge definition, price type, price periodicity, and tiered flag.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-charges-item-response"
            }
        },
        "SuppressedCreditAmount":{
            "type":"number",
            "description":"The credit amount that was suppressed.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceListId":{
            "type":"integer",
            "description":"The unique identifier of the price list.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssetId":{
            "type":"integer",
            "description":"The unique identifier of the asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InvoicedAmount":{
            "type":"number",
            "description":"The amount for which the invoice was created.",
            "nullable":true,
            "x-queryable":true
        },
        "SuspendedDate":{
            "title":"Covered Level Suspend Date",
            "type":"string",
            "description":"The date when the covered level was suspended.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login details of the user who last updated the covered level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetGroupName":{
            "title":"Asset Group Name",
            "type":"string",
            "description":"The name of the asset group.",
            "nullable":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Covered Level Description",
            "type":"string",
            "description":"A brief description of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CanceledAmount":{
            "type":"number",
            "description":"The amount that was canceled.",
            "nullable":true,
            "x-queryable":true
        },
        "LineNumber":{
            "title":"Number",
            "maxLength":"300",
            "type":"string",
            "description":"The line number",
            "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
        },
        "CoveredLevelPuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The public unique identifier of the covered level.",
            "nullable":false,
            "x-queryable":true
        },
        "RevenueOption":{
            "title":"Revenue Accounting Option",
            "maxLength":"30",
            "type":"string",
            "description":"Revenue Option",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "billLines":{
            "title":"Bill Lines",
            "type":"array",
            "description":"The bill lines resource is used to view, create, update, and delete the subscription bill line details, such as charge period, date bill from, date billed to, amount, recurring flag, invoice text, usage quantity, and usage flags.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-billLines-item-response"
            }
        },
        "TotalContractValue":{
            "title":"Covered Level Contract Value",
            "type":"number",
            "description":"The total contract value associated with the covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "SuspendReason":{
            "title":"Covered Level Suspend Reason",
            "maxLength":"30",
            "type":"string",
            "description":"The reason for suspending the credit method for the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CoveredLevelId":{
            "type":"integer",
            "description":"The unique identifier of the covered level.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "HierarchyTotal":{
            "type":"number",
            "description":"The total covered level of the hierarchy.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"Covered Level End Date",
            "type":"string",
            "description":"The date when the covered level ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ClosedAmount":{
            "type":"number",
            "description":"The amount at which the covered level was closed.",
            "nullable":true,
            "x-queryable":true
        },
        "CoveredLevlName":{
            "title":"Covered Level Name",
            "type":"string",
            "description":"The name of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "OverrideCreditAmount":{
            "title":"Override Credit Amount",
            "type":"number",
            "description":"The override credit amount of the covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "Type":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the covered level.",
            "nullable":false,
            "x-queryable":true
        },
        "UnitPrice":{
            "title":"Unit Price",
            "type":"number",
            "description":"The unit price of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "GenerateBillingSchedule":{
            "type":"string",
            "description":"Indicates whether the billing schedule is to be generated.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ClosedDate":{
            "title":"Covered Level Close Date",
            "type":"string",
            "description":"The date when the covered level was closed.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "CloseDescription":{
            "title":"Covered Level Close Description",
            "maxLength":"2000",
            "type":"string",
            "description":"The close description associated with a covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystem":{
            "maxLength":"30",
            "type":"string",
            "description":"The source system of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the covered level was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TypeName":{
            "title":"Covered Level Type",
            "type":"string",
            "description":"The name of the type of the covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ProductName":{
            "title":"Product Name",
            "type":"string",
            "description":"The name of the product associated with the covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ParentCoveredLevelId":{
            "type":"integer",
            "description":"The unique identifier of the parent covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Party Name",
            "type":"string",
            "description":"The name of the party.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "SuspendCreditMethod":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates if the credit method has to be suspended.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Covered Level Start Date",
            "type":"string",
            "description":"The date when the covered level starts.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "CustomerNumber":{
            "title":"Customer Account Number",
            "type":"string",
            "description":"The alternate unique identifier of the customer.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "AssetGroupId":{
            "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":{
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code associated with the covered level. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemUnitOfMeasure":{
            "maxLength":"15",
            "type":"string",
            "description":"The unit of measure used to measure the items in the covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "CoveredLevelName":{
            "title":"Covered Level Name",
            "maxLength":"300",
            "type":"string",
            "description":"The name of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "Period":{
            "maxLength":"80",
            "type":"string",
            "description":"The period of the covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Duration":{
            "type":"integer",
            "description":"The duration of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "RenewalType":{
            "title":"Renewal Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the covered level renewal.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssetName":{
            "title":"Covered Level Asset Name",
            "type":"string",
            "description":"The name of the asset.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "AssetSerialNumber":{
            "title":"Covered Asset Serial Number",
            "type":"string",
            "description":"The serial number of the asset.",
            "nullable":true,
            "x-queryable":true
        },
        "CancelReason":{
            "title":"Cancellation Reason",
            "maxLength":"30",
            "type":"string",
            "description":"The reason for cancelling the covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SerialNumber":{
            "title":"Covered Asset Serial Number",
            "maxLength":"80",
            "type":"string",
            "description":"The serial number of the covered level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PriceUnitOfMeasureName":{
            "title":"Pricing UOM",
            "type":"string",
            "description":"The display name of the unit of measure.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ReturnCreditMethod":{
            "title":"Close Credit Method",
            "maxLength":"230",
            "type":"string",
            "description":"The method used to return the credit.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SourceLineNumber":{
            "maxLength":"120",
            "type":"string",
            "description":"The source line number of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CoveredLevlNumber":{
            "title":"Covered Level Number",
            "type":"string",
            "description":"The alternate identifier of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "ProductGroupNumber":{
            "title":"Product Group Number",
            "type":"string",
            "description":"The alternate identifier of a product group.",
            "nullable":true,
            "x-queryable":false
        },
        "PriceAsOf":{
            "type":"string",
            "description":"The price as of a certain date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PartySite":{
            "title":"Party Site Number",
            "type":"string",
            "description":"The name of the party site.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "InvoiceText":{
            "maxLength":"2000",
            "type":"string",
            "description":"The text included in the invoice.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerAccountId":{
            "type":"integer",
            "description":"The unique identifier of the customer account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TaxError":{
            "maxLength":"4000",
            "type":"string",
            "description":"The tax error, if any, in the calculated amount.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerName":{
            "title":"Customer Account",
            "type":"string",
            "description":"The name of the customer.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceLineKey":{
            "maxLength":"120",
            "type":"string",
            "description":"The source line key of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "ProductGroupId":{
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RepriceFlag":{
            "type":"boolean",
            "description":"Indicates whether the subscription covered level should be repriced or not. If passed as 'true', the subscription covered level and its child covered levels will be repriced.",
            "nullable":true,
            "x-queryable":false
        },
        "RenewedDate":{
            "type":"string",
            "description":"The date when the covered level was renewed.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity of the covered level.",
            "nullable":false,
            "default":"1",
            "x-queryable":true
        },
        "PriceUnitOfMeasure":{
            "maxLength":"30",
            "type":"string",
            "description":"The unit of measure used to indicate the price.",
            "nullable":true,
            "x-queryable":true
        },
        "PutOnHoldFlag":{
            "type":"boolean",
            "description":"Indicates if the covered level has been put on hold.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyNumber":{
            "title":"Party Number",
            "type":"string",
            "description":"The alternate identifier of the party.",
            "nullable":true,
            "x-queryable":false
        },
        "RemoveHoldFlag":{
            "type":"boolean",
            "description":"Indicates if the hold on the covered level has to be removed.",
            "nullable":true,
            "x-queryable":false
        },
        "PricingError":{
            "maxLength":"1000",
            "type":"string",
            "description":"The error in the pricing, if any.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Bill Lines

Type: array

Title: Bill Lines

The bill lines resource is used to view, create, update, and delete the subscription bill line details, such as charge period, date bill from, date billed to, amount, recurring flag, invoice text, usage quantity, and usage flags.

Show Source

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

{
    "title":"Bill Lines",
    "type":"array",
    "description":"The bill lines resource is used to view, create, update, and delete the subscription bill line details, such as charge period, date bill from, date billed to, amount, recurring flag, invoice text, usage quantity, and usage flags.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-billLines-item-response"
    }
}

Nested Schema : Charges

Type: array

Title: Charges

The charges resource is used to view, create, update, and delete the subscription charge details, such as charge name, charge definition, price type, price periodicity, and tiered flag.

Show Source

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

{
    "title":"Charges",
    "type":"array",
    "description":"The charges resource is used to view, create, update, and delete the subscription charge details, such as charge name, charge definition, price type, price periodicity, and tiered flag.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-charges-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : Relationships

Type: array

Title: Relationships

The relationships resource is used to view, create, update, and delete the subscription product relationships details, such as relationship type, source subscription product PUID, and target subscription product PUID.

Show Source

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

{
    "title":"Relationships",
    "type":"array",
    "description":"The relationships resource is used to view, create, update, and delete the subscription product relationships details, such as relationship type, source subscription product PUID, and target subscription product PUID.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-relationships-item-response"
    }
}

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

Type: object

Show Source

• Amount: number
  Title: Amount

  The amount for which the bill is generated.
• billAdjustments: array Bill Adjustments
  Title: Bill Adjustments

  The bill adjustments resource is used to view, create, update, and delete the subscription bill adjustment details, such as adjustment name, adjustment value, adjustment type, reason, and effectivity.
• BillingPeriod: number
  Title: Sequence

  The period for which the bill is generated.
• BillLineId: integer (int64)
  The unique identifier of the bill line.
• BillLinePuid: string
  Maximum Length: 120

  The public unique identifier of the bill line.
• BusinessUnitId: integer
  The ID of the business unit associated with the bill line.
• ChargeDefinition: string
  Maximum Length: 30

  The definition that indicates the purpose of the charge.
• ChargeId: integer (int64)
  The unique identifier of the charge.
• ChargeName: string
  Title: Charge Name

  Maximum Length: 120

  The name of the charge associated with the bill line.
• ChargePeriod: number
  Title: Period

  The usage period that was charged.
• ChargePeriodFactor: number
  The change period factor associated with the bill line.
• ChargePuid: string
  Read Only: true

  The public unique identifier of the charge.
• CoveredLevelId: integer (int64)
  The unique identifier of the covered level.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date when the billing line was created.
• CreditMemoAmount: number
  The amount for the credit memo.
• CreditMemoFlag: string
  Indicates if there is a credit memo associated with the bill line.
• CreditMemoReason: string
  The reason to raise the credit memo.
• CreditMemoReasonCode: string
  Maximum Length: 30

  The code of the credit memo reason code.
• CustomerTrxTypeSequenceId: integer (int64)
  Customer Transaction Type Sequence Id
• DateBilledFrom: string (date)
  Title: Bill-from Date

  The date from which the bill was generated.
• DateBilledTo: string (date)
  Title: Bill-to Date

  The date up to which the bill is generated.
• DateToInterface: string (date)
  Title: Interface Date

  The date to interface for the bill line.
• InterfacedFlag: boolean
  Title: Interfaced

  Maximum Length: 1

  Default Value: false

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

  Maximum Length: 240

  The text in the bill line invoice.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

  Maximum Length: 32

  The login details of the user who last updated the billing line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ListPrice: number
  The list price of the product associated with the bill line.
• MilestoneEventId: integer (int64)
  The ID of the milestone event associated with the bill line.
• MilestoneEventName: string
  The name of the milestone event associated with the bill line.
• NewCreditMemoPUID: string
  The unique public identifier of the new credit memo.
• PricedQuantity: number
  The quantity for which the bill line was charged.
• PricingError: string
  Maximum Length: 1000

  The error in pricing, if any.
• RecurringFlag: boolean
  Maximum Length: 1

  Indicates whether the line is recurring or not.
• RetrieveInvoiceFlag: boolean
  Title: Retrieve Invoice from Receivables

  Maximum Length: 1

  Retrieve Invoice Flag
• RevenueLineId: integer (int64)
  The unique identifier of the revenue line.
• RevenueOption: string
  Title: Revenue Accounting Option

  Maximum Length: 30

  Revenue Option
• RevenuePeriod: string
  Title: Revenue Effectivity Periods

  Maximum Length: 30

  Revenue Period
• SentDate: string (date)
  Title: Sent Date

  The date invoice information is sent to receivables.
• SubscriptionId: integer (int64)
  The unique identifier of the subscription.
• SubscriptionProductId: integer (int64)
  The unique identifier of the subscription product.
• SummarizedBillLineId: integer
  Title: Summarized Bill Line ID

  Summarized Bill Line ID
• TransactionAmount: number
  Title: Invoice Amount

  The amount for which the transaction occurred.
• TransactionClass: string
  Title: Transaction Class

  Maximum Length: 30

  The class of the transaction.
• TransactionClassMeaning: string
  Title: Class

  The meaning of transaction class lookup.
• TransactionDate: string (date)
  Title: Invoice Date

  The date when the transaction occurred.
• TransactionNumber: string
  Title: Invoice Number

  Maximum Length: 30

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

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

  Indicates if the bill line has a trueup period.
• TrxId: integer (int64)
  The AR transaction ID.
• TrxLineId: integer (int64)
  The AR transaction line ID.
• UsageAcquiredFlag: boolean
  Maximum Length: 1

  Indicates whether the usage has been acquired or not.
• UsageCaptureDate: string (date)
  The date when the usage was captured.
• UsageChargeType: string
  Title: Usage Charge Type

  Maximum Length: 30

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

  Indicates whether the line is a usage line or not.
• UsagePricedFlag: boolean
  Maximum Length: 1

  Indicates whether the usage line has been priced or not.
• UsageQuantity: number
  Title: Usage Quantity

  The quantity of the usage.

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

Nested Schema : Bill Adjustments

Type: array

Title: Bill Adjustments

The bill adjustments resource is used to view, create, update, and delete the subscription bill adjustment details, such as adjustment name, adjustment value, adjustment type, reason, and effectivity.

Show Source

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

{
    "title":"Bill Adjustments",
    "type":"array",
    "description":"The bill adjustments resource is used to view, create, update, and delete the subscription bill adjustment details, such as adjustment name, adjustment value, adjustment type, reason, and effectivity.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-billLines-billAdjustments-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

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

Type: object

Show Source

• AdjustmentBasis: string
  Title: Basis

  Maximum Length: 30

  The basis on which the bill is adjusted.
• AdjustmentName: string
  Title: Adjustment

  Maximum Length: 120

  The name of the bill adjustment.
• AdjustmentReasonCode: string
  Maximum Length: 30

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

  Maximum Length: 30

  The type of the bill adjustment.
• AdjustmentValue: number
  Title: Value

  The value by which the bill is adjusted.
• AutoAdjustmentFlag: boolean
  Maximum Length: 3

  Indicates whether the adjustment is automatic or not.
• BasisEnableFlag: boolean
  Indicates if the base has been enabled for the bill adjustment.
• BillAdjustmentId: integer (int64)
  The unique identifier of the bill adjustment.
• BillAdjustmentPuid: string
  Maximum Length: 120

  The public unique identifier of the bill adjustment.
• BillLineId: integer (int64)
  The unique identifier of the bill line.
• ChargeAdjustmentId: integer (int64)
  The unique identifier of the charge adjustment.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date when the bill adjustment was created.
• CurrencyCode: string
  The current code used for the bill adjustment.
• Effectivity: string
  Maximum Length: 30

  The effectivity of the bill adjustment.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

  Maximum Length: 32

  The login details of the user who last updated the bill adjustment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NumberOfPeriods: number
  The number of periods
• PeriodFrom: number
  The period from which the bill was adjusted.
• PeriodUntil: number
  The period until which the bill is adjusted.
• Reason: string
  Title: Reason Details

  Maximum Length: 120

  The reason why the bill is adjusted.
• RevenueAdjustmentFromDate: string (date)
  Title: Revenue Effective Start Date

  Revenue Adjustment From Date
• RevenueAdjustmentToDate: string (date)
  Title: Revenue Effective End Date

  Revenue Adjustment To Date
• RevenueOption: string
  Title: Revenue Accounting Option

  Maximum Length: 30

  Revenue Option
• RevenuePeriod: string
  Title: Revenue Effectivity Periods

  Maximum Length: 30

  Revenue Period
• SequenceNumber: number
  Title: Sequence

  The sequence number of the bill adjustment.
• SubscriptionId: integer (int64)
  The unique identifier of the subscription.
• SubscriptionProductId: integer (int64)
  The unique identifier of the subscription product.

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

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

Nested Schema : properties

Type: object

Show Source

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

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

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

Type: object

Show Source

• adjustments: array Adjustments
  Title: Adjustments

  The adjustments resource is used to view, create, update, and delete the subscription charge adjustment details, such as adjustment name, adjustment type, adjustment value, adjustment reason, and effectivity.
• AggregationMethod: string
  Maximum Length: 30

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

  The allowance part of the charge.
• AssetMeterYn: boolean
  Maximum Length: 1

  The flag whether it is an asset meter or not.
• BillingFreq: string
  Maximum Length: 30

  Billing Frequency
• BillingFreqName: string
  Title: Billing Frequency

  Maximum Length: 255

  Billing Frequency Name
• BillLineId: integer (int64)
  The unique identifier of the bill line.
• BlockSize: number
  Title: Block Size

  The block size of the charge.
• ChargeDefinition: string
  Title: Charge Name

  Maximum Length: 30

  The definition that indicates the purpose of the charge.
• ChargeDefinitionName: string
  The name of the charge definition.
• ChargeId: integer (int64)
  The unique identifier of the charge.
• chargeMilestoneEvents: array Charge Milestone Events
  Title: Charge Milestone Events

  The charge milestone events resource is used to view, create, update, and delete the milestone events associated with a charge of a subscription.
• ChargeName: string
  Title: Charge Name

  Maximum Length: 120

  The name of the charge.
• ChargePeriodCode: string
  Maximum Length: 30

  The code of the charge period associated with the charge.
• ChargePuid: string
  Maximum Length: 120

  The public unique identifier of the charge.
• chargeTiers: array Charge Tiers
  Title: Charge Tiers

  The charge tiers resource is used to view, create, update, and delete the subscription charge tier details, such as tier from, tier to, and list price.
• CoveredLevelId: integer (int64)
  The unique identifier of the covered level.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date when the charge was created.
• EnableProration: string
  Maximum Length: 1

  Indicates whether proration is enabled or not.
• EstimatedAmount: number
  Title: Estimated Amount

  The estimated amount of the charges.
• EstimatedMethodName: string
  Title: Estimation Method

  The method used to estimate the amount.
• EstimatedQuantity: number
  Title: Estimated Quantity

  The estimated quantity for the charge.
• EstimationMethod: string
  Title: Estimation Method

  Maximum Length: 30

  The method used to estimate the amount.
• ExternalKey: string
  Maximum Length: 120

  The external key used to measure the charge.
• ExternalParentKey: string
  Maximum Length: 120

  The external parent key.
• InitialMeterReadingId: integer (int64)
  The initial meter reading identifier value.
• InvoicingRuleId: integer (int64)
  The ID of the invoice rule.
• InvoicingRuleName: string
  Title: Invoicing Rule

  The name of the invoice rule.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• MeterDefinitionId: integer (int64)
  The unique identifier of the meter definition associated with the charges.
• MeterId: integer (int64)
  The unique identifier of the meter associated with the charges.
• MilestoneBillingFlag: boolean
  Indicates whether the billing is impacted by milestone events or not.
• MilestoneRevenueFlag: boolean
  Indicates whether the revenue is impacted by milestone events or not.
• MilestoneTemplateId: integer (int64)
  The ID of the milestone event associated with a charge.
• MilestoneTemplateName: string
  Maximum Length: 120

  The name of the milestone template associated with a charge.
• MinimumAmount: number
  Title: Minimum Amount

  The minimum amount to be charged.
• MinimumQuantity: number
  Title: Minimum Quantity

  The minimum quantity that is allowed.
• PeriodicBillingFlag: boolean
  Maximum Length: 1

  Indicates whether periodic billing is allowed or not.
• PeriodicRevenueFlag: boolean
  Title: Enable Periodic Revenue Recognition

  Maximum Length: 1

  Indicates the periodic revenue recognition of one-time charges.
• PrePaymentNumber: integer (int64)
  Title: Prepayment Number

  The prepayment number for the charge.
• PricePeriodicity: string
  Title: Periodicity

  Maximum Length: 30

  The price periodicity for the charge. Indicates the frequency when the charge has to be applied.
• PricePeriodicityName: string
  The name of the price periodicity.
• PriceType: string
  Maximum Length: 30

  The price type associated with the charge.
• QuotedTcv: number
  The quoted TCV of the charge.
• RecurringPricePeriodicityCode: string
  Maximum Length: 30

  The recurring price periodicity code of the charge.
• RollupFlag: boolean
  Maximum Length: 1

  Indicates if the charge needs to be rolled up.
• SequenceNumber: integer (int32)
  The sequence number for the charge.
• SubscriptionId: integer (int64)
  The unique identifier of the subscription.
• SubscriptionProductId: integer (int64)
  The unique identifier of the subscription product.
• TieredFlag: boolean
  Maximum Length: 3

  Indicates whether the charge has tiers.
• TierType: string
  Title: Tier Type

  Maximum Length: 30

  The type of the charge tier.
• TrueUpPeriod: string
  Title: True Up Period

  Maximum Length: 30

  Default Value: ORA_OSS_USAGE_BILLING_PERIOD

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

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

  The price of the unit list.
• UsagePriceLockFlag: boolean
  Maximum Length: 3

  Indicates whether the usage price is locked or not.
• UsageUnitOfMeasure: string
  Maximum Length: 3

  The usage unit of measure of the charge.

{
    "type":"object",
    "properties":{
        "AggregationMethod":{
            "maxLength":"30",
            "type":"string",
            "description":"The aggregation method used for the charges.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the charge was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargePuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The public unique identifier of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "chargeMilestoneEvents":{
            "title":"Charge Milestone Events",
            "type":"array",
            "description":"The charge milestone events resource is used to view, create, update, and delete the milestone events associated with a charge of a subscription.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-charges-chargeMilestoneEvents-item-response"
            }
        },
        "adjustments":{
            "title":"Adjustments",
            "type":"array",
            "description":"The adjustments resource is used to view, create, update, and delete the subscription charge adjustment details, such as adjustment name, adjustment type, adjustment value, adjustment reason, and effectivity.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-charges-adjustments-item-response"
            }
        },
        "ChargeDefinition":{
            "title":"Charge Name",
            "maxLength":"30",
            "type":"string",
            "description":"The definition that indicates the purpose of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "AssetMeterYn":{
            "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":{
            "type":"string",
            "description":"The name of the price periodicity.",
            "nullable":true,
            "x-queryable":true
        },
        "PrePaymentNumber":{
            "title":"Prepayment Number",
            "type":"integer",
            "description":"The prepayment number for the charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "BillingFreq":{
            "maxLength":"30",
            "type":"string",
            "description":"Billing Frequency",
            "nullable":true,
            "x-queryable":true
        },
        "MeterDefinitionId":{
            "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":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether periodic billing is allowed or not.",
            "nullable":true,
            "x-queryable":true
        },
        "MilestoneBillingFlag":{
            "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":{
            "maxLength":"120",
            "type":"string",
            "description":"The external parent key.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitListPrice":{
            "title":"List Price",
            "type":"number",
            "description":"The price of the unit list.",
            "nullable":true,
            "x-queryable":true
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"The sequence number for the charge.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "InitialMeterReadingId":{
            "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":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the charge.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EstimatedQuantity":{
            "title":"Estimated Quantity",
            "type":"number",
            "description":"The estimated quantity for the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the charge.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeName":{
            "title":"Charge Name",
            "maxLength":"120",
            "type":"string",
            "description":"The name of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "RecurringPricePeriodicityCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The recurring price periodicity code of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "QuotedTcv":{
            "type":"number",
            "description":"The quoted TCV of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "TieredFlag":{
            "maxLength":"3",
            "type":"boolean",
            "description":"Indicates whether the charge has tiers.",
            "nullable":true,
            "x-queryable":true
        },
        "UsagePriceLockFlag":{
            "maxLength":"3",
            "type":"boolean",
            "description":"Indicates whether the usage price is locked or not.",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodicRevenueFlag":{
            "title":"Enable Periodic Revenue Recognition",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the periodic revenue recognition of one-time charges.",
            "nullable":true,
            "x-queryable":true
        },
        "MilestoneRevenueFlag":{
            "type":"boolean",
            "description":"Indicates whether the revenue is impacted by milestone events or not.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "chargeTiers":{
            "title":"Charge Tiers",
            "type":"array",
            "description":"The charge tiers resource is used to view, create, update, and delete the subscription charge tier details, such as tier from, tier to, and list price.",
            "items":{
                "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-charges-chargeTiers-item-response"
            }
        },
        "MinimumAmount":{
            "title":"Minimum Amount",
            "type":"number",
            "description":"The minimum amount to be charged.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceType":{
            "maxLength":"30",
            "type":"string",
            "description":"The price type associated with the charge.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login details of the user who last updated the charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RollupFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the charge needs to be rolled up.",
            "nullable":true,
            "x-queryable":true
        },
        "TierType":{
            "title":"Tier Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the charge tier.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InvoicingRuleName":{
            "title":"Invoicing Rule",
            "type":"string",
            "description":"The name of the invoice rule.",
            "nullable":true,
            "x-queryable":false
        },
        "MeterId":{
            "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":{
            "type":"string",
            "description":"The name of the charge definition.",
            "nullable":true,
            "x-queryable":true
        },
        "UsageUnitOfMeasure":{
            "maxLength":"3",
            "type":"string",
            "description":"The usage unit of measure of the charge.",
            "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
        },
        "EnableProration":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether proration is enabled or not.",
            "nullable":true,
            "x-queryable":true
        },
        "TrueUpPeriodName":{
            "title":"True Up Period",
            "type":"string",
            "description":"The name of the trueup period.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ExternalKey":{
            "maxLength":"120",
            "type":"string",
            "description":"The external key used to measure the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargePeriodCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code of the charge period associated with the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "Allowance":{
            "title":"Allowance",
            "type":"number",
            "description":"The allowance part of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoicingRuleId":{
            "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":{
            "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":{
            "type":"integer",
            "description":"The unique identifier of the covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BillingFreqName":{
            "title":"Billing Frequency",
            "maxLength":"255",
            "type":"string",
            "description":"Billing Frequency Name",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MinimumQuantity":{
            "title":"Minimum Quantity",
            "type":"number",
            "description":"The minimum quantity that is allowed.",
            "nullable":true,
            "x-queryable":true
        },
        "EstimatedMethodName":{
            "title":"Estimation Method",
            "type":"string",
            "description":"The method used to estimate the amount.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PricePeriodicity":{
            "title":"Periodicity",
            "maxLength":"30",
            "type":"string",
            "description":"The price periodicity for the charge. Indicates the frequency when the charge has to be applied.",
            "nullable":true,
            "x-queryable":true
        },
        "TrueUpPeriod":{
            "title":"True Up Period",
            "maxLength":"30",
            "type":"string",
            "description":"The identifier of the trueup period.",
            "nullable":true,
            "default":"ORA_OSS_USAGE_BILLING_PERIOD",
            "x-queryable":true
        },
        "BillLineId":{
            "type":"integer",
            "description":"The unique identifier of the bill line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The unique identifier of the charge.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BlockSize":{
            "title":"Block Size",
            "type":"number",
            "description":"The block size of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the charge was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Adjustments

Type: array

Title: Adjustments

The adjustments resource is used to view, create, update, and delete the subscription charge adjustment details, such as adjustment name, adjustment type, adjustment value, adjustment reason, and effectivity.

Show Source

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

{
    "title":"Adjustments",
    "type":"array",
    "description":"The adjustments resource is used to view, create, update, and delete the subscription charge adjustment details, such as adjustment name, adjustment type, adjustment value, adjustment reason, and effectivity.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-charges-adjustments-item-response"
    }
}

Nested Schema : Charge Milestone Events

Type: array

Title: Charge Milestone Events

The charge milestone events resource is used to view, create, update, and delete the milestone events associated with a charge of a subscription.

Show Source

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

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

Nested Schema : Charge Tiers

Type: array

Title: Charge Tiers

The charge tiers resource is used to view, create, update, and delete the subscription charge tier details, such as tier from, tier to, and list price.

Show Source

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

{
    "title":"Charge Tiers",
    "type":"array",
    "description":"The charge tiers resource is used to view, create, update, and delete the subscription charge tier details, such as tier from, tier to, and list price.",
    "items":{
        "$ref":"#/components/schemas/subscriptionProducts-coveredLevels-charges-chargeTiers-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

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

Type: object

Show Source

• AdjustmentBasis: string
  Title: Basis

  Maximum Length: 30

  The basis of the adjustment.
• AdjustmentName: string
  Title: Adjustment

  Maximum Length: 120

  The name of the adjustment.
• AdjustmentReasonCode: string
  Title: Reason

  Maximum Length: 30

  The code of the adjustment reason.
• AdjustmentReasonMeaning: string
  Title: Reason

  The translated adjustment reason.
• AdjustmentType: string
  Title: Type

  Maximum Length: 30

  The type of the adjustment.
• AdjustmentValue: number
  Title: Value

  The value of the adjustment.
• AutoAdjustmentFlag: boolean
  Maximum Length: 3

  Indicates whether the adjustment is automatic or not.
• ChargeAdjustmentId: integer (int64)
  The unique identifier of the charge adjustment.
• ChargeAdjustmentPuid: string
  Maximum Length: 120

  The public unique identifier of the charge adjustment.
• ChargeId: integer (int64)
  The unique identifier of the charge.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date when the adjustment was created.
• Effectivity: string
  Title: Effectivity

  Maximum Length: 30

  The adjustment effectivity
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• NumberOfPeriods: number
  The number of periods
• ObjectVersionNumber: integer (int32)
  The number used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
• PeriodFrom: number
  The period from which the adjustment was initiated.
• PeriodUntil: number
  The period until which the adjustment is initiated.
• Reason: string
  Title: Reason Description

  Maximum Length: 120

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

  The sequence number of the adjustment.
• SubscriptionId: integer (int64)
  The unique identifier of the subscription.
• SubscriptionProductId: integer (int64)
  The unique identifier of the subscription product.

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : subscriptionProducts-coveredLevels-charges-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.
• ChargeId: integer (int64)
  The charge ID with which the milestone event is associated.
• ChargePuid: string
  Maximum Length: 120

  Default Value: Charges.ChargePuid

  The PUID of the charge to which the milestone event is associated.
• CompletionDate: string (date)
  The completion date of the milestone event.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The login of the user who created the milestone event.
• CreationDate: string (date-time)
  Read Only: true

  The date on which the milestone event was created.
• EventId: integer (int64)
  The ID of the milestone event.
• EventSource: string
  Maximum Length: 30

  The source of the milestone event.
• EventSourceReference: string
  Maximum Length: 120

  The source reference of the milestone event.
• EventType: string
  Maximum Length: 30

  The type of the milestone event.
• ExpectedCompletionDate: string (date)
  The expected completion date of a milestone event.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date of which the milestone event was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Maximum Length: 32

  The login which updated the milestone event the last.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MilestoneComment: string
  Maximum Length: 300

  The milestone event comment.
• MilestoneName: string
  Maximum Length: 30

  The name of the milestone event.
• MilestonePuid: string
  Maximum Length: 120

  The milestone event PUID.
• ObjectVersionNumber: integer (int32)
  The object version number of the milestone event.
• Percentage: number
  The percentage associated with a milestone event.

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

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

Type: object

Show Source

• AdditionalNumberFive: number
  Title: Additional Number Five

  Additional number, if any, for the charge tier.
• AdditionalNumberFour: number
  Title: Additional Number Four

  Additional number, if any, for the charge tier.
• AdditionalNumberOne: number
  Title: Additional Number One

  Additional number, if any, for the charge tier.
• AdditionalNumberSix: number
  Title: Additional Number Six

  Additional number, if any, for the charge tier.
• AdditionalNumberThree: number
  Title: Additional Number Three

  Additional number, if any, for the charge tier.
• AdditionalNumberTwo: number
  Title: Additional Number Two

  Additional number, if any, for the charge tier.
• AdditionalTextOne: string
  Title: Additional Text One

  Maximum Length: 4000

  Additional text, if any, for the charge tier.
• AdditionalTextTwo: string
  Title: Additional Text Two

  Maximum Length: 4000

  Additional text, if any, for the charge tier.
• AdditionalTimestampOne: string (date-time)
  Title: Additional Time-stamp One

  Additional timestamp, if any, for the charge tier.
• AdditionalTimestampThree: string (date-time)
  Title: Additional Time-stamp Three

  Additional timestamp, if any, for the charge tier.
• AdditionalTimestampTwo: string (date-time)
  Title: Additional Time-stamp Two

  Additional timestamp, if any, for the charge tier.
• AddtionalTextThree: string
  Title: Additional Text Three

  Maximum Length: 4000

  Additional text, if any, for the charge tier.
• BlockSize: number
  Title: Block Size

  The block size
• ChargeId: integer (int64)
  The unique identifier of the charge.
• ChargeTierId: integer (int64)
  The unique identifier of the charge tier.
• ChargeTierPuid: string
  Maximum Length: 120

  The public unique identifier of the charge tier.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date when the charge tier was created.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

  Maximum Length: 32

  The login details of the user who last updated the charge tier.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ListPrice: number
  Title: List Price

  The list price
• PriceFormat: string
  Title: Price Format

  Maximum Length: 30

  The display format of the price.
• SequenceNumber: number
  The sequence number
• SubscriptionId: integer (int64)
  The unique identifier of the subscription.
• SubscriptionProductId: integer (int64)
  The unique identifier of the subscription product.
• TierFrom: number
  Title: Tier From

  The tier from
• TierTo: number
  Title: Tier To

  The tier to

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : subscriptionProducts-coveredLevels-relationships-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date when the relationship was created.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  The number used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
• OperationLinksPuid: string
  Maximum Length: 120

  The public unique identifier of the operation links.
• RelationshipTypeCode: string
  Maximum Length: 30

  The code indicating the type of the relationship.
• SourceAssetKey: string
  Maximum Length: 120

  The source asset key
• SourceProdAssociationId: integer (int64)
  The unique identifier of the source product association.
• SourceProdAssociationPuid: string
  Maximum Length: 120

  The public unique identifier of the source product association.
• SourceProductPuid: string
  Maximum Length: 120

  The public unique identifier of the source product.
• SourceRootAssetKey: string
  Maximum Length: 120

  The source root asset key
• TargetProdAssociationId: integer (int64)
  The unique identifier of the target product association.
• TargetProdAssociationPuid: string
  Maximum Length: 120

  The public unique identifier of the target product association.
• TargetProductPuid: string
  Maximum Length: 120

  The public unique identifier of the target product.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the relationship.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the relationship was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the relationship.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceProdAssociationId":{
            "type":"integer",
            "description":"The unique identifier of the source product association.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TargetProdAssociationId":{
            "type":"integer",
            "description":"The unique identifier of the target product association.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceAssetKey":{
            "maxLength":"120",
            "type":"string",
            "description":"The source asset key",
            "nullable":true,
            "x-queryable":true
        },
        "SourceProductPuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The public unique identifier of the source product.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of the relationship.",
            "nullable":false,
            "x-queryable":true
        },
        "OperationLinksPuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The public unique identifier of the operation links.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The number used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SourceRootAssetKey":{
            "maxLength":"120",
            "type":"string",
            "description":"The source root asset key",
            "nullable":true,
            "x-queryable":true
        },
        "SourceProdAssociationPuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The public unique identifier of the source product association.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetProductPuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The public unique identifier of the target product.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetProdAssociationPuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The public unique identifier of the target product association.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the relationship was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login details of the user who last updated the relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Links

billLines

Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines

Parameters:

• CoveredLevelPuid: $request.path.CoveredLevelPuid
• SubscriptionProductPuid: $request.path.SubscriptionProductPuid

The bill lines resource is used to view, create, update, and delete the subscription bill line details, such as charge period, date bill from, date billed to, amount, recurring flag, invoice text, usage quantity, and usage flags.

charges

Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges

Parameters:

• CoveredLevelPuid: $request.path.CoveredLevelPuid
• SubscriptionProductPuid: $request.path.SubscriptionProductPuid

The charges resource is used to view, create, update, and delete the subscription charge details, such as charge name, charge definition, price type, price periodicity, and tiered flag.

relationships

Operation: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/relationships

Parameters:

• CoveredLevelPuid: $request.path.CoveredLevelPuid
• SubscriptionProductPuid: $request.path.SubscriptionProductPuid

The relationships resource is used to view, create, update, and delete the subscription product relationships details, such as relationship type, source subscription product PUID, and target subscription product PUID.

Back to Top

Examples

The following example shows how to create a covered level 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/subscriptionProducts/CDRM_4016-PRDT-2013/child/coveredLevels

Example of Request Body

The following example shows the contents of the request body in JSON format.

{
    "CoveredLevelPuid": "GP-5678-PRDT-7-PASS-1",
    "LineNumber": "1",
    "InventoryItemId": 300100118490672,
    "AssetId": 300100118585763,
    "AssetName": "zOKC_Auto_Asset1",
    "ProductName": "ZOKC_Item_001",
    "Description": "Item",
    "Type": "ORA_ASSET",
    "Quantity": 1,
    "ItemUnitOfMeasure": "Ea",
    "TotalContractValue": 12361.29,
    "EndDate": "2020-05-29",
    "StartDate": "2020-01-01",
    "PriceAsOf": "2020-01-01",
    "PriceUnitOfMeasure": "0zE"
}

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "CoveredLevelId": 300100192686410,
  "CoveredLevelPuid": "GP-5678-PRDT-7-PASS-1",
  "SubscriptionProductId": 300100181994505,
  "SubscriptionId": 300100181994494,
  "LineNumber": "1",
  "InventoryItemId": 300100118490672,
  "AssetId": 300100118585763,
  "AssetName": "zOKC_Auto_Asset1",
  "AssetSerialNumber": null,
  "ProductName": "ZOKC_Item_001",
  "Description": "Item",
  "Type": "ORA_ASSET",
  "TypeName": "Asset",
  "Quantity": 1,
  "ItemUnitOfMeasure": "Ea",
  "TotalContractValue": 12361.29,
  "GenerateBillingSchedule": null,
  "EndDate": "2020-05-29",
  "StartDate": "2020-01-01",
  "Duration": 150,
  "Period": "DY",
  "Status": "ORA_DRAFT",
  "StatusName": "Draft",
  "PriceAsOf": "2020-01-01",
  "PriceUnitOfMeasure": "0zE",
  "PriceUnitOfMeasureName": "YEAR",
  "PriceListId": null,
  "PricingError": null,
  "TaxAmount": null,
  "InvoiceText": "[$Product Name]: [$Charge Name] [$Bill from Date]-[$Bill to Date]",
  "CancelReason": null,
  "CanceledDate": null,
  "CanceledAmount": null,
  "ClosedDate": null,
  "CloseReason": null,
  "ClosedAmount": null,
  "ReturnCreditMethod": null,
  "SuppressedCreditAmount": null,
  "InvoicedAmount": null,
  "CreditedAmount": null,
  "RenewedDate": null,
  "RenewalType": null,
  "TaxError": null,
  "CreatedBy": "SALES_ADMIN",
  "CreationDate": "2019-08-20T06:55:15+00:00",
  "LastUpdatedBy": "SALES_ADMIN",
  "LastUpdateDate": "2019-08-20T06:55:15.130+00:00",
  "LastUpdateLogin": "9062D47DF31EDAF6E0533EFDF40A2696",
  "CurrencyCode": null,
  "CorpCurrencyCode": null,
  "CurcyConvRateType": null,
  "PutOnHoldFlag": null,
  "RemoveHoldFlag": null,
  "links": 
	...
}

Back to Top