Overview

The Subscription Quotes endpoint creates custom upgrade offers for subscription customers.

Use Case

An offer is sent to a customer during an existing subscription. The customer will receive an email with a PDF attachment and an option to accept the quote. Alternatively, the quote can be reviewed via the customer self-service portal. Upon acceptance, the subscription upgrade will be activated according to the scheduled terms.

📘
Note
This functionality is currently available only via API integration and is intended for B2B use cases where sales reps interact directly with customers.

Upgrade Quotes vs. Renewal Quotes

While Renewal Quotes allow customers to renew subscriptions under new terms, Subscription Quotes API enables upgrading an ongoing subscription (for example, higher product tier, increased quantity) based on a mid-term agreement.
Both types of quotes follow a similar process flow but address different business needs.

Implement Create Subscription Quotes endpoint

🚧
Warning
Before integrating the Upgrade Quotes API, notify Client Experience to coordinate the setup and activation of the functionality.

Before you start

Use of the API is restricted to authorized clients. Your technical department must request access by contacting the Cleverbridge Client Experience team.

Parameters

Parameter	Type	Required	Definition
`subscription_id`	integer	Yes	The ID of the active subscription to be upgraded.
`subscription_alignment_type`	string	No	Defines how the upgrade is aligned with the billing cycle. If not set, the upgrade will happen immediately, as soon as the quote is accepted.
`scheduled_alignment_date`	string	No	The future date when the upgrade should take effect. It must be before the next billing date.
`items`	array	Yes	Array of one or more product items that are part of the upgrade. Each item contains the fields below.
`product_id` (inside `items`)		Yes	ID of the product the subscription is being upgraded to.
`quantity` (inside `items`)		Yes	Number of units being added or upgraded for the specified product.
`custom_internal_product_id`		No	An optional internal identifier for the product, used for custom tracking purposes.
`custom_name`		No	Custom display name for the upgraded product.
`custom_name_extension`		No	Additional text to extend the custom name, for more detailed labeling.
`custom_alignment_price`		No	Defines the price the customer will pay at the time of the upgrade. Includes: `value`, `currency_id`, and `is_gross`.
`custom_price`		No	Defines the recurring renewal price the customer will pay after the upgrade. Includes: `value`, `currency_id`, and `is_gross`.
`value` (in `custom_alignment_price` and `custom_price`)		Yes	Numeric amount representing the price.
`currency_id` (in `custom_alignment_price` and `custom_price`)		Yes	Currency code (e.g., "USD", "EUR") used for the price.
`is_gross` (in `custom_alignment_price` and `custom_price`)		No	Boolean flag indicating whether the price includes taxes (`true`) or is net (`false`). Defaults to `false`.

Example request

curl --request POST \
     --url https://rest.cleverbridge.com/subscription-quotes \
     --header 'accept: application/json' \
     --header 'content-type: text/json' \
     --data '
{
  "coupon_codes": [
    "string"
  ],
  "items": [
    {
      "custom_alignment_price": {
        "currency_id": "string",
        "is_gross": true,
        "value": 0
      },
      "custom_internal_product_id": "string",
      "custom_name": "string",
      "custom_name_extension": "string",
      "custom_price": {
        "currency_id": "string",
        "is_gross": true,
        "value": 0
      },
      "product_id": 0,
      "quantity": 0
    }
  ],
  "scheduled_alignment_date": "2025-11-03T13:53:01.457Z",
  "subscription_alignment_type": "PRORATED",
  "subscription_id": 0
}
'

Example response

json
  CopyEdit
  {
    "subscription_id": 57436490,
    "subscription_alignment_type": "Prorated",
    "scheduled_alignment_date": "2025-03-30",
    "items": [
      {
        "product_id": 238621,
        "quantity": 5,
        "custom_name": "Loki Light Custom",
        "custom_internal_product_id": "238621 Custom",
        "custom_name_extension": "Custom Extension",
        "custom_alignment_price": {
          "value": 100.0,
          "currency_id": "USD",
          "is_gross": true
        },
        "custom_price": {
         "value": 120.0,
          "currency_id": "USD",
          "is_gross": true
        }
      }
    ]
  }