Check out the new features, minor fixes, and updates we've made to our platform and APIsChangelog
Home >

Use Case: Change Subscription Quantity Immediately

Assumptions and Preconditions

  • The subscription has the status Active.


A client offers a DiamondCRM subscription product that contains a single item, Users, billed at $50 monthly, and multiplied by the number of users specified by the customer.

  1. On September 1st, a customer logs into the DiamondCRM administration console and navigates to the Edit Subscription page. This page uses the Get Subscription API endpoint to display the customer's subscription details, including the Users subscription itemA subscription item is component of a subscription with its own set of attributes including price, description and feature set., which displays the quantity ten.
  2. The customer changes the user quantity to 15 in the entry field provided. The customer must choose between two options before the change can be submitted:
    • Update immediately
    • Update at next billing date (September 27th)
  3. The customer selects to update the subscription immediately. The Edit Subscription page uses the Increase Subscription Item Quantity API endpoint to calculate the pro-rated price for the five additional users from September 1st through September 27th.The price displays with a message that the customer will be billed immediately for the pro-rated amount shown.
  4. After reviewing this message, the customer confirms the update. The Edit Subscription page uses the Increase Subscription Item Quantity API endpoint to update the quantity of users on the cleverbridge platform.
  5. The cleverbridge platform automatically bills the customer the pro-rated amount for the five additional users for the remainder of the current billing interval.
  6. On September 27th, the cleverbridge platform automatically bills the customer $750 for the next monthly billing interval. This is based on the user quantity of 15.


Although not utilized in this use case, the following option is also available:

  • Apply a discount coupon that was set up in the Commerce Assistant to reduce the price of the Users subscription item.


Obtain the customer's consent for changes to subscriptions. For more information, see Best Practices: Obtaining Customer Consent.


sub bill change props change qty immediately