Jump to

• Request
• Response

Create a charge preview

post

/crmRestApi/resources/11.13.18.05/previewSubscriptions/{SubscriptionId}/child/products/{productsUniqID}/child/amendedProduct/{amendedProductUniqID}/child/charges

Request

Path Parameters

• SubscriptionId(required): integer
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• amendedProductUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Amended Product resource and used to uniquely identify an instance of Amended Product. The client should not generate the hash key value. Instead, the client should query on the Amended Product collection resource in order to navigate to a specific instance of Amended Product to get the hash key.
• productsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Preview Subscription Products resource and used to uniquely identify an instance of Preview Subscription Products. The client should not generate the hash key value. Instead, the client should query on the Preview Subscription Products collection resource in order to navigate to a specific instance of Preview Subscription Products to get the hash key.

Header Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.
• 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
        },
        "InvoicingRuleId":{
            "type":"integer",
            "description":"The invoicing rule ID.",
            "nullable":true
        },
        "adjustments":{
            "title":"Subscription Charge Adjustment",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/previewSubscriptions-products-amendedProduct-charges-adjustments-item-post-request"
            }
        },
        "ChargeDefinition":{
            "type":"string",
            "description":"The charge definition of the charge.",
            "nullable":true
        },
        "EstimatedAmount":{
            "type":"number",
            "description":"The estimated amount of the charge.",
            "nullable":true
        },
        "ChargeName":{
            "type":"string",
            "description":"The charge name of the charge.",
            "nullable":true
        },
        "QuotedTcv":{
            "type":"number",
            "description":"The quoted TCV of the charge.",
            "nullable":true
        },
        "BillingFreq":{
            "maxLength":255,
            "type":"string",
            "description":"The billing frequency of the subscription product charge.",
            "nullable":true
        },
        "EstimationMethod":{
            "maxLength":255,
            "type":"string",
            "description":"The estimation method of the charge.",
            "nullable":true
        },
        "PricePeriodicity":{
            "type":"string",
            "description":"The price periodicity of the charge.",
            "nullable":true
        },
        "PeriodicBillingFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"The period billing indicator.",
            "nullable":true
        },
        "UnitListPrice":{
            "type":"number",
            "description":"The unit list price of the charge.",
            "nullable":true
        },
        "PriceType":{
            "type":"string",
            "description":"The price type of the charge.",
            "nullable":true
        }
    }
}

Nested Schema : Subscription Charge Adjustment

Type: array

Title: Subscription Charge Adjustment

Show Source

• Array of: object schema

{
    "title":"Subscription Charge Adjustment",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/previewSubscriptions-products-amendedProduct-charges-adjustments-item-post-request"
    }
}

Nested Schema : schema

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
• NumberOfPeriods: number
• PeriodFrom: number
• PeriodUntil: number
• SequenceNumber: integer

{
    "type":"object",
    "properties":{
        "AutoAdjustmentFlag":{
            "maxLength":255,
            "type":"boolean",
            "nullable":true
        },
        "AdjustmentValue":{
            "type":"number",
            "nullable":true
        },
        "AdjustmentBasis":{
            "maxLength":255,
            "type":"string",
            "nullable":true
        },
        "SequenceNumber":{
            "type":"integer",
            "nullable":true
        },
        "NumberOfPeriods":{
            "type":"number",
            "nullable":true
        },
        "Effectivity":{
            "maxLength":255,
            "type":"string",
            "nullable":true
        },
        "AdjustmentName":{
            "maxLength":255,
            "type":"string",
            "nullable":true
        },
        "PeriodUntil":{
            "type":"number",
            "nullable":true
        },
        "AdjustmentType":{
            "maxLength":255,
            "type":"string",
            "nullable":true
        },
        "PeriodFrom":{
            "type":"number",
            "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 : 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 : 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."
        }
    }
}

Links

adjustments

Operation: /crmRestApi/resources/11.13.18.05/previewSubscriptions/{SubscriptionId}/child/products/{productsUniqID}/child/amendedProduct/{amendedProductUniqID}/child/charges/{chargesUniqID}/child/adjustments

Parameters:

• SubscriptionId: $request.path.SubscriptionId
• amendedProductUniqID: $request.path.amendedProductUniqID
• chargesUniqID: $request.path.chargesUniqID
• productsUniqID: $request.path.productsUniqID

Back to Top