Jump to

• Request
• Response

Get all subscription previews

get

/crmRestApi/resources/11.13.18.05/previewSubscriptions

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds the subscription preview with the specified primary key.
    Finder Variables
    • SubscriptionId; integer; The unique identifier of the subscription used to find the subscription preview.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • BillToAccountId; integer; The bill-to account ID.
  • BillToAccountNumber; string; The bill-to account number.
  • BillToSiteNumber; string; The bill-to site number.
  • BillToSiteUseId; integer; The bill-to site use ID.
  • BusinessUnitId; integer; The business unit ID.
  • Currency; string; The currency of the preview subscription.
  • DocumentFiscalClassification; string; The document fiscal classification.
  • EndDate; string; The end date of the subscription.
  • ExemptCertificateNumber; string; The exempt certificate number.
  • LegalEntityId; integer; The legal entity ID.
  • PricingStrategyId; integer; The pricing strategy ID.
  • PrimaryPartyId; integer; The unique primary party identifier of the preview subscription.
  • PrimaryPartyNumber; string; The primary party number.
  • ShipToParty; integer; The ship-to party.
  • ShipToPartyNumber; string; The ship-to party number.
  • StartDate; string; The start date of the subscription.
  • SubscriptionId; integer; The unique subscription identifier of the preview subscription.
  • SubscriptionNumber; string; The subscription number of the preview subscription.
  • SubscriptionProfileName; string; The subscription profile name.
  • TaxClassificationCode; string; The tax classification code.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

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

There's no request body for this operation.

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

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/previewSubscriptions-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object previewSubscriptions-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/previewSubscriptions-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 : previewSubscriptions-item-response

Type: object

Show Source

• BillToAccountId: integer
  The bill-to account ID.
• BillToAccountNumber: string
  Maximum Length: 255

  The bill-to account number.
• BillToSiteNumber: string
  Maximum Length: 255

  The bill-to site number.
• BillToSiteUseId: integer
  The bill-to site use ID.
• BusinessUnitId: integer
  The business unit ID.
• Currency: string
  Maximum Length: 255

  The currency of the preview subscription.
• DocumentFiscalClassification: string
  Maximum Length: 255

  The document fiscal classification.
• EndDate: string (date)
  The end date of the subscription.
• ExemptCertificateNumber: string
  Maximum Length: 255

  The exempt certificate number.
• LegalEntityId: integer
  The legal entity ID.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PricingStrategyId: integer
  The pricing strategy ID.
• PrimaryPartyId: integer
  The unique primary party identifier of the preview subscription.
• PrimaryPartyNumber: string
  Maximum Length: 255

  The primary party number.
• products: array Preview Subscription Products
  Title: Preview Subscription Products

  Preview subscriptions lets you view a subscription product before creating, updating, or deleting a subscription.
• ShipToParty: integer
  The ship-to party.
• ShipToPartyNumber: string
  Maximum Length: 255

  The ship-to party number.
• StartDate: string (date)
  The start date of the subscription.
• SubscriptionId: integer
  The unique subscription identifier of the preview subscription.
• SubscriptionNumber: string
  Maximum Length: 255

  The subscription number of the preview subscription.
• SubscriptionProfileName: string
  Maximum Length: 300

  The subscription profile name.
• TaxClassificationCode: string
  Maximum Length: 255

  The tax classification code.

{
    "type":"object",
    "properties":{
        "SubscriptionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The subscription number of the preview subscription.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionProfileName":{
            "maxLength":300,
            "type":"string",
            "description":"The subscription profile name.",
            "nullable":true,
            "x-queryable":true
        },
        "BillToSiteUseId":{
            "type":"integer",
            "description":"The bill-to site use ID.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipToPartyNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The ship-to party number.",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"The business unit ID.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryPartyId":{
            "type":"integer",
            "description":"The unique primary party identifier of the preview subscription.",
            "nullable":true,
            "x-queryable":true
        },
        "BillToAccountNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The bill-to account number.",
            "nullable":true,
            "x-queryable":true
        },
        "ExemptCertificateNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The exempt certificate number.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"The end date of the subscription.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "products":{
            "title":"Preview Subscription Products",
            "type":"array",
            "description":"Preview subscriptions lets you view a subscription product before creating, updating, or deleting a subscription.",
            "items":{
                "$ref":"#/components/schemas/previewSubscriptions-products-item-response"
            }
        },
        "BillToSiteNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The bill-to site number.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The start date of the subscription.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentFiscalClassification":{
            "maxLength":255,
            "type":"string",
            "description":"The document fiscal classification.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique subscription identifier of the preview subscription.",
            "nullable":false,
            "x-queryable":true
        },
        "ShipToParty":{
            "type":"integer",
            "description":"The ship-to party.",
            "nullable":true,
            "x-queryable":true
        },
        "BillToAccountId":{
            "type":"integer",
            "description":"The bill-to account ID.",
            "nullable":true,
            "x-queryable":true
        },
        "LegalEntityId":{
            "type":"integer",
            "description":"The legal entity ID.",
            "nullable":true,
            "x-queryable":true
        },
        "Currency":{
            "maxLength":255,
            "type":"string",
            "description":"The currency of the preview subscription.",
            "nullable":false,
            "x-queryable":true
        },
        "TaxClassificationCode":{
            "maxLength":255,
            "type":"string",
            "description":"The tax classification code.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PricingStrategyId":{
            "type":"integer",
            "description":"The pricing strategy ID.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryPartyNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The primary party number.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : Preview Subscription Products

Type: array

Title: Preview Subscription Products

Preview subscriptions lets you view a subscription product before creating, updating, or deleting a subscription.

Show Source

• Array of: object previewSubscriptions-products-item-response

{
    "title":"Preview Subscription Products",
    "type":"array",
    "description":"Preview subscriptions lets you view a subscription product before creating, updating, or deleting a subscription.",
    "items":{
        "$ref":"#/components/schemas/previewSubscriptions-products-item-response"
    }
}

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 : previewSubscriptions-products-item-response

Type: object

Show Source

• ActionCode: string
  Maximum Length: 255

  The action code for the preview.
• AlignBillingFrom: string (date)
  The align billing from for the preview.
• AmendCreditMethod: string
  Maximum Length: 255

  The amendment credit method.
• AmendDescription: string
  Maximum Length: 255

  The amendment description.
• amendedProduct: array Amended Product
  Title: Amended Product

  Preview subscriptions lets you view amended subscription product details before creating, updating or deleting a subscription.
• AmendEffectiveDate: string (date)
  The amendment effective date.
• AmendReason: string
  Maximum Length: 255

  The amendment reason.
• BillingFrequency: string
  The billing frequency of the subscription product.
• charges: array Preview Subscription Charges
  Title: Preview Subscription Charges

  Preview subscriptions lets you view amended subscription product charges before creating, updating, or deleting a subscription.
• CloseCreditMethod: string
  Maximum Length: 255

  The close credit method for the preview.
• ClosedAmount: number
  The closed amount.
• ClosedDate: string (date)
  The closed date.
• CloseReason: string
  Maximum Length: 255

  The close reason.
• CopyAdjustments: string
  Maximum Length: 255

  Indicates whether the adjustments should be copied for the product or not.
• CopyCharges: string
  Indicates whether the charges should be copied for the product or not.
• CopyOneTimeCharges: string
  Maximum Length: 255

  Indicates whether the one time charges should be copied for the product or not.
• CreditedAmount: number
  The credited amount.
• DefinitionOrganizationId: integer
  The definition organization ID.
• EndDate: string (date)
  The end date of the subscription product.
• EstimatedTax: number
  The estimated tax.
• ExemptCertificateNumber: string
  Maximum Length: 255

  The exempt certificate number.
• InventoryItemId: integer
  The inventory item ID.
• ItemUnitOfMeasure: string
  The item unit of measure of the subscription product.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• output: array Preview Subscription Bill Lines
  Title: Preview Subscription Bill Lines

  Preview subscriptions lets you view subscription product details before creating, updating, or deleting a subscription.
• OutputTaxClassification: string
  Maximum Length: 255

  The output tax classification.
• PriceListId: integer
  The price list ID.
• ProductFiscClassification: string
  Maximum Length: 255

  The product fiscal classification.
• ProductName: string
  The product name of the subscription product.
• Quantity: number
  The quantity of the subscription product.
• RequestedAlignBillingDate: string (date)
  The requested align billing date.
• RequestedRatePlanId: integer
  The request rate plan identifier of the subscription product.
• RequestedRatePlanNumber: string
  Maximum Length: 255

  The requested rate plan number.
• SalesProductType: string
  Maximum Length: 255

  The sales product type.
• StartDate: string (date)
  The start date of the subscription product.
• SubscriptionProductPuid: string
  Maximum Length: 255

  The subscription product PUID.
• SuppressedCreditAmount: number
  The suppressed credit amount.
• TotalContractValue: number
  The total contract value.

{
    "type":"object",
    "properties":{
        "SalesProductType":{
            "maxLength":255,
            "type":"string",
            "description":"The sales product type.",
            "nullable":true,
            "x-queryable":true
        },
        "AmendReason":{
            "maxLength":255,
            "type":"string",
            "description":"The amendment reason.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductName":{
            "type":"string",
            "description":"The product name of the subscription product.",
            "nullable":true,
            "x-queryable":true
        },
        "AmendCreditMethod":{
            "maxLength":255,
            "type":"string",
            "description":"The amendment credit method.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionCode":{
            "maxLength":255,
            "type":"string",
            "description":"The action code for the preview.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The start date of the subscription product.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "output":{
            "title":"Preview Subscription Bill Lines",
            "type":"array",
            "description":"Preview subscriptions lets you view subscription product details before creating, updating, or deleting a subscription.",
            "items":{
                "$ref":"#/components/schemas/previewSubscriptions-products-output-item-response"
            }
        },
        "RequestedRatePlanNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The requested rate plan number.",
            "nullable":true,
            "x-queryable":true
        },
        "CloseReason":{
            "maxLength":255,
            "type":"string",
            "description":"The close reason.",
            "nullable":true,
            "x-queryable":true
        },
        "AmendEffectiveDate":{
            "type":"string",
            "description":"The amendment effective date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "amendedProduct":{
            "title":"Amended Product",
            "type":"array",
            "description":"Preview subscriptions lets you view amended subscription product details before creating, updating or deleting a subscription.",
            "items":{
                "$ref":"#/components/schemas/previewSubscriptions-products-amendedProduct-item-response"
            }
        },
        "ItemUnitOfMeasure":{
            "type":"string",
            "description":"The item unit of measure of the subscription product.",
            "nullable":true,
            "x-queryable":true
        },
        "CopyAdjustments":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates whether the adjustments should be copied for the product or not.",
            "nullable":true,
            "x-queryable":true
        },
        "AlignBillingFrom":{
            "type":"string",
            "description":"The align billing from for the preview.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "BillingFrequency":{
            "type":"string",
            "description":"The billing frequency of the subscription product.",
            "nullable":true,
            "x-queryable":true
        },
        "TotalContractValue":{
            "type":"number",
            "description":"The total contract value.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionProductPuid":{
            "maxLength":255,
            "type":"string",
            "description":"The subscription product PUID.",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"The inventory item ID.",
            "nullable":true,
            "x-queryable":true
        },
        "CreditedAmount":{
            "type":"number",
            "description":"The credited amount.",
            "nullable":true,
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"The quantity of the subscription product.",
            "nullable":true,
            "x-queryable":true
        },
        "CloseCreditMethod":{
            "maxLength":255,
            "type":"string",
            "description":"The close credit method for the preview.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestedRatePlanId":{
            "type":"integer",
            "description":"The request rate plan identifier of the subscription product.",
            "nullable":true,
            "x-queryable":true
        },
        "AmendDescription":{
            "maxLength":255,
            "type":"string",
            "description":"The amendment description.",
            "nullable":true,
            "x-queryable":true
        },
        "EstimatedTax":{
            "type":"number",
            "description":"The estimated tax.",
            "nullable":true,
            "x-queryable":true
        },
        "ExemptCertificateNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The exempt certificate number.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"The end date of the subscription product.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ClosedAmount":{
            "type":"number",
            "description":"The closed amount.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestedAlignBillingDate":{
            "type":"string",
            "description":"The requested align billing date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "charges":{
            "title":"Preview Subscription Charges",
            "type":"array",
            "description":"Preview subscriptions lets you view amended subscription product charges before creating, updating, or deleting a subscription.",
            "items":{
                "$ref":"#/components/schemas/previewSubscriptions-products-charges-item-response"
            }
        },
        "SuppressedCreditAmount":{
            "type":"number",
            "description":"The suppressed credit amount.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductFiscClassification":{
            "maxLength":255,
            "type":"string",
            "description":"The product fiscal classification.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceListId":{
            "type":"integer",
            "description":"The price list ID.",
            "nullable":true,
            "x-queryable":true
        },
        "CopyOneTimeCharges":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates whether the one time charges should be copied for the product or not.",
            "nullable":true,
            "x-queryable":true
        },
        "ClosedDate":{
            "type":"string",
            "description":"The closed date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CopyCharges":{
            "type":"string",
            "description":"Indicates whether the charges should be copied for the product or not.",
            "nullable":true,
            "x-queryable":true
        },
        "DefinitionOrganizationId":{
            "type":"integer",
            "description":"The definition organization ID.",
            "nullable":true,
            "x-queryable":true
        },
        "OutputTaxClassification":{
            "maxLength":255,
            "type":"string",
            "description":"The output tax classification.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Amended Product

Type: array

Title: Amended Product

Preview subscriptions lets you view amended subscription product details before creating, updating or deleting a subscription.

Show Source

• Array of: object previewSubscriptions-products-amendedProduct-item-response

{
    "title":"Amended Product",
    "type":"array",
    "description":"Preview subscriptions lets you view amended subscription product details before creating, updating or deleting a subscription.",
    "items":{
        "$ref":"#/components/schemas/previewSubscriptions-products-amendedProduct-item-response"
    }
}

Nested Schema : Preview Subscription Charges

Type: array

Title: Preview Subscription Charges

Preview subscriptions lets you view amended subscription product charges before creating, updating, or deleting a subscription.

Show Source

• Array of: object previewSubscriptions-products-charges-item-response

{
    "title":"Preview Subscription Charges",
    "type":"array",
    "description":"Preview subscriptions lets you view amended subscription product charges before creating, updating, or deleting a subscription.",
    "items":{
        "$ref":"#/components/schemas/previewSubscriptions-products-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 : Preview Subscription Bill Lines

Type: array

Title: Preview Subscription Bill Lines

Preview subscriptions lets you view subscription product details before creating, updating, or deleting a subscription.

Show Source

• Array of: object previewSubscriptions-products-output-item-response

{
    "title":"Preview Subscription Bill Lines",
    "type":"array",
    "description":"Preview subscriptions lets you view subscription product details before creating, updating, or deleting a subscription.",
    "items":{
        "$ref":"#/components/schemas/previewSubscriptions-products-output-item-response"
    }
}

Nested Schema : previewSubscriptions-products-amendedProduct-item-response

Type: object

Show Source

• AlignBillingFrom: string (date)
  The align billing from of the amended product.
• BillingFrequency: string
  The billing frequency of the amended product.
• charges: array Preview Subscription Charges
  Title: Preview Subscription Charges

  Preview subscriptions lets you view amended subscription product charges before creating, updating, or deleting a subscription.
• EndDate: string (date)
  The end date of the amended product.
• EstimatedTax: number
  The estimated tax of the amended product.
• InventoryItemId: integer
  The inventory item ID of the amended product.
• ItemUnitOfMeasure: string
  The item unit of measure of the amended product.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• output: array Preview Subscription Bill Lines
  Title: Preview Subscription Bill Lines

  Preview subscriptions lets you view subscription product details before creating, updating, or deleting a subscription.
• PriceListId: integer
  The price list ID of the amended product.
• ProductName: string
  The name of the amended product.
• Quantity: number
  The quantity of the amended product.
• RequestedAlignBillingDate: string (date)
  The requested align billing date of the amended product.
• RequestedRatePlanId: integer
  The requested rate plan ID of the amended product.
• RequestedRatePlanNumber: string
  Maximum Length: 255

  The requested rate plan number of the amended product.
• StartDate: string (date)
  The start date of the amended product.
• TotalContractValue: number
  The total contract value of the amended product.

{
    "type":"object",
    "properties":{
        "AlignBillingFrom":{
            "type":"string",
            "description":"The align billing from of the amended product.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ProductName":{
            "type":"string",
            "description":"The name of the amended product.",
            "nullable":true,
            "x-queryable":true
        },
        "BillingFrequency":{
            "type":"string",
            "description":"The billing frequency of the amended product.",
            "nullable":true,
            "x-queryable":true
        },
        "TotalContractValue":{
            "type":"number",
            "description":"The total contract value of the amended product.",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"The inventory item ID of the amended product.",
            "nullable":true,
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"The quantity of the amended product.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestedRatePlanId":{
            "type":"integer",
            "description":"The requested rate plan ID of the amended product.",
            "nullable":true,
            "x-queryable":true
        },
        "EstimatedTax":{
            "type":"number",
            "description":"The estimated tax of the amended product.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"The end date of the amended product.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The start date of the amended product.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "output":{
            "title":"Preview Subscription Bill Lines",
            "type":"array",
            "description":"Preview subscriptions lets you view subscription product details before creating, updating, or deleting a subscription.",
            "items":{
                "$ref":"#/components/schemas/previewSubscriptions-products-amendedProduct-output-item-response"
            }
        },
        "RequestedAlignBillingDate":{
            "type":"string",
            "description":"The requested align billing date of the amended product.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "charges":{
            "title":"Preview Subscription Charges",
            "type":"array",
            "description":"Preview subscriptions lets you view amended subscription product charges before creating, updating, or deleting a subscription.",
            "items":{
                "$ref":"#/components/schemas/previewSubscriptions-products-amendedProduct-charges-item-response"
            }
        },
        "RequestedRatePlanNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The requested rate plan number of the amended product.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceListId":{
            "type":"integer",
            "description":"The price list ID of the amended product.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ItemUnitOfMeasure":{
            "type":"string",
            "description":"The item unit of measure of the amended product.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Preview Subscription Charges

Type: array

Title: Preview Subscription Charges

Preview subscriptions lets you view amended subscription product charges before creating, updating, or deleting a subscription.

Show Source

• Array of: object previewSubscriptions-products-amendedProduct-charges-item-response

{
    "title":"Preview Subscription Charges",
    "type":"array",
    "description":"Preview subscriptions lets you view amended subscription product charges before creating, updating, or deleting a subscription.",
    "items":{
        "$ref":"#/components/schemas/previewSubscriptions-products-amendedProduct-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 : Preview Subscription Bill Lines

Type: array

Title: Preview Subscription Bill Lines

Preview subscriptions lets you view subscription product details before creating, updating, or deleting a subscription.

Show Source

• Array of: object previewSubscriptions-products-amendedProduct-output-item-response

{
    "title":"Preview Subscription Bill Lines",
    "type":"array",
    "description":"Preview subscriptions lets you view subscription product details before creating, updating, or deleting a subscription.",
    "items":{
        "$ref":"#/components/schemas/previewSubscriptions-products-amendedProduct-output-item-response"
    }
}

Nested Schema : previewSubscriptions-products-amendedProduct-charges-item-response

Type: object

Show Source

• adjustments: array Subscription Charge Adjustment
  Title: Subscription Charge Adjustment
• BillingFreq: string
  Maximum Length: 255

  The billing frequency of the subscription product charge.
• ChargeDefinition: string
  The charge definition of the charge.
• ChargeName: string
  The charge name of the charge.
• EstimatedAmount: number
  The estimated amount of the charge.
• EstimatedQuantity: number
  The estimated quantity of a charge.
• EstimationMethod: string
  Maximum Length: 255

  The estimation method of the charge.
• InvoicingRuleId: integer
  The invoicing rule ID.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PeriodicBillingFlag: boolean
  Maximum Length: 255

  The period billing indicator.
• PricePeriodicity: string
  The price periodicity of the charge.
• PriceType: string
  The price type of the charge.
• QuotedTcv: number
  The quoted TCV of the charge.
• UnitListPrice: number
  The unit list price of the charge.

{
    "type":"object",
    "properties":{
        "EstimatedQuantity":{
            "type":"number",
            "description":"The estimated quantity of a charge.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoicingRuleId":{
            "type":"integer",
            "description":"The invoicing rule ID.",
            "nullable":true,
            "x-queryable":true
        },
        "adjustments":{
            "title":"Subscription Charge Adjustment",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/previewSubscriptions-products-amendedProduct-charges-adjustments-item-response"
            }
        },
        "ChargeDefinition":{
            "type":"string",
            "description":"The charge definition of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "EstimatedAmount":{
            "type":"number",
            "description":"The estimated amount of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeName":{
            "type":"string",
            "description":"The charge name of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "QuotedTcv":{
            "type":"number",
            "description":"The quoted TCV of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "BillingFreq":{
            "maxLength":255,
            "type":"string",
            "description":"The billing frequency of the subscription product charge.",
            "nullable":true,
            "x-queryable":true
        },
        "EstimationMethod":{
            "maxLength":255,
            "type":"string",
            "description":"The estimation method of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "PricePeriodicity":{
            "type":"string",
            "description":"The price periodicity of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodicBillingFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"The period billing indicator.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitListPrice":{
            "type":"number",
            "description":"The unit list price of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PriceType":{
            "type":"string",
            "description":"The price type of the charge.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Subscription Charge Adjustment

Type: array

Title: Subscription Charge Adjustment

Show Source

• Array of: object previewSubscriptions-products-amendedProduct-charges-adjustments-item-response

{
    "title":"Subscription Charge Adjustment",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/previewSubscriptions-products-amendedProduct-charges-adjustments-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 : previewSubscriptions-products-amendedProduct-charges-adjustments-item-response

Type: object

Show Source

• AdjustmentBasis: string
  Maximum Length: 255
• AdjustmentName: string
  Maximum Length: 255
• AdjustmentType: string
  Maximum Length: 255
• AdjustmentValue: number
• AutoAdjustmentFlag: boolean
  Maximum Length: 255
• Effectivity: string
  Maximum Length: 255
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NumberOfPeriods: number
• PeriodFrom: number
• PeriodUntil: number
• SequenceNumber: integer

{
    "type":"object",
    "properties":{
        "AutoAdjustmentFlag":{
            "maxLength":255,
            "type":"boolean",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentValue":{
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentBasis":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "SequenceNumber":{
            "type":"integer",
            "nullable":true,
            "x-queryable":true
        },
        "NumberOfPeriods":{
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Effectivity":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentName":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodUntil":{
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentType":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodFrom":{
            "type":"number",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : previewSubscriptions-products-amendedProduct-output-item-response

Type: object

Show Source

• BillLineHeader: string
  Maximum Length: 255

  The bill line header of the bill lines.
• BillLineValues: string
  The bill line values of the bill lines.
• ChargeAdjustmentHeader: string
  Maximum Length: 255

  The charge adjustment header of the preview.
• ChargeHeader: string
  Maximum Length: 255

  The charge header of the preview.
• ChargeValues: string
  The charge values of the preview.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NumberOfBillingCycles: integer
  The number of billing cycles for preview.

{
    "type":"object",
    "properties":{
        "BillLineHeader":{
            "maxLength":255,
            "type":"string",
            "description":"The bill line header of the bill lines.",
            "nullable":false,
            "x-queryable":true
        },
        "BillLineValues":{
            "type":"string",
            "description":"The bill line values of the bill lines.",
            "nullable":false,
            "x-queryable":true
        },
        "NumberOfBillingCycles":{
            "type":"integer",
            "description":"The number of billing cycles for preview.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ChargeValues":{
            "type":"string",
            "description":"The charge values of the preview.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeHeader":{
            "maxLength":255,
            "type":"string",
            "description":"The charge header of the preview.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeAdjustmentHeader":{
            "maxLength":255,
            "type":"string",
            "description":"The charge adjustment header of the preview.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : previewSubscriptions-products-charges-item-response

Type: object

Show Source

• adjustments: array Subscription Charge Adjustment
  Title: Subscription Charge Adjustment
• BillingFreq: string
  Maximum Length: 255

  The billing frequency of the subscription product charge.
• ChargeDefinition: string
  The charge definition of the charge.
• ChargeName: string
  The charge name of the charge.
• EstimatedAmount: number
  The estimated amount of the charge.
• EstimatedQuantity: number
  The estimated quantity of a charge.
• EstimationMethod: string
  Maximum Length: 255

  The estimation method of the charge.
• InvoicingRuleId: integer
  The invoicing rule ID.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PeriodicBillingFlag: boolean
  Maximum Length: 255

  The period billing indicator.
• PricePeriodicity: string
  The price periodicity of the charge.
• PriceType: string
  The price type of the charge.
• QuotedTcv: number
  The quoted TCV of the charge.
• UnitListPrice: number
  The unit list price of the charge.

{
    "type":"object",
    "properties":{
        "EstimatedQuantity":{
            "type":"number",
            "description":"The estimated quantity of a charge.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoicingRuleId":{
            "type":"integer",
            "description":"The invoicing rule ID.",
            "nullable":true,
            "x-queryable":true
        },
        "adjustments":{
            "title":"Subscription Charge Adjustment",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/previewSubscriptions-products-charges-adjustments-item-response"
            }
        },
        "ChargeDefinition":{
            "type":"string",
            "description":"The charge definition of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "EstimatedAmount":{
            "type":"number",
            "description":"The estimated amount of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeName":{
            "type":"string",
            "description":"The charge name of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "QuotedTcv":{
            "type":"number",
            "description":"The quoted TCV of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "BillingFreq":{
            "maxLength":255,
            "type":"string",
            "description":"The billing frequency of the subscription product charge.",
            "nullable":true,
            "x-queryable":true
        },
        "EstimationMethod":{
            "maxLength":255,
            "type":"string",
            "description":"The estimation method of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "PricePeriodicity":{
            "type":"string",
            "description":"The price periodicity of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodicBillingFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"The period billing indicator.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitListPrice":{
            "type":"number",
            "description":"The unit list price of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PriceType":{
            "type":"string",
            "description":"The price type of the charge.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Subscription Charge Adjustment

Type: array

Title: Subscription Charge Adjustment

Show Source

• Array of: object previewSubscriptions-products-charges-adjustments-item-response

{
    "title":"Subscription Charge Adjustment",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/previewSubscriptions-products-charges-adjustments-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 : previewSubscriptions-products-charges-adjustments-item-response

Type: object

Show Source

• AdjustmentBasis: string
  Maximum Length: 255
• AdjustmentName: string
  Maximum Length: 255
• AdjustmentType: string
  Maximum Length: 255
• AdjustmentValue: number
• AutoAdjustmentFlag: boolean
  Maximum Length: 255
• Effectivity: string
  Maximum Length: 255
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NumberOfPeriods: number
• PeriodFrom: number
• PeriodUntil: number
• SequenceNumber: integer

{
    "type":"object",
    "properties":{
        "AutoAdjustmentFlag":{
            "maxLength":255,
            "type":"boolean",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentValue":{
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentBasis":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "SequenceNumber":{
            "type":"integer",
            "nullable":true,
            "x-queryable":true
        },
        "NumberOfPeriods":{
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Effectivity":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentName":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodUntil":{
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentType":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodFrom":{
            "type":"number",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : previewSubscriptions-products-output-item-response

Type: object

Show Source

• BillLineHeader: string
  Maximum Length: 255

  The bill line header of the bill lines.
• BillLineValues: string
  The bill line values of the bill lines.
• ChargeAdjustmentHeader: string
  Maximum Length: 255

  The charge adjustment header of the preview.
• ChargeHeader: string
  Maximum Length: 255

  The charge header of the preview.
• ChargeValues: string
  The charge values of the preview.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NumberOfBillingCycles: integer
  The number of billing cycles for preview.

{
    "type":"object",
    "properties":{
        "BillLineHeader":{
            "maxLength":255,
            "type":"string",
            "description":"The bill line header of the bill lines.",
            "nullable":false,
            "x-queryable":true
        },
        "BillLineValues":{
            "type":"string",
            "description":"The bill line values of the bill lines.",
            "nullable":false,
            "x-queryable":true
        },
        "NumberOfBillingCycles":{
            "type":"integer",
            "description":"The number of billing cycles for preview.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ChargeValues":{
            "type":"string",
            "description":"The charge values of the preview.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeHeader":{
            "maxLength":255,
            "type":"string",
            "description":"The charge header of the preview.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeAdjustmentHeader":{
            "maxLength":255,
            "type":"string",
            "description":"The charge adjustment header of the preview.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Back to Top