Subscription Quotes API

The Subscription Quotes API allows you to create individualized upgrade offers for subscription customers, based on custom terms negotiated with a sales representative. It extends the existing subscription management capabilities to support mid-term upgrades with custom pricing and scheduled activation dates.

API request is sent.
Customers receive an email with the Upgrade Quote as a PDF attachment and a call-to-action to approve the quote.
Alternatively, customers can review pending quotes in the self-service portal (Documents tab).
Upon approval, the upgrade becomes effective on the scheduled date, and the customer receives a purchase confirmation.

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.

API Access

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

Key Fields

When creating an Upgrade Quote, you provide the following fields:

Field	Required	Definition
`subscription_id`	Yes	The ID of the active subscription to be upgraded.
`subscription_alignment_type`	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`	No	The future date when the upgrade should take effect. It must be before the next billing date.
`items`	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 (JSON)

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
        }
      }
    ]
  }

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