GuidesAPI ReferenceNotificationsDiscussionsSupportStatus

Combine a Usage Data Upgrade with an Early Custom-Price Renewal

The following contains relevant information about this use case:

Preconditions and Considerations

  • The current billing interval has started and the next billing date has not been reached yet.
  • Any changes made, including the price and/or quantity, apply to all future billing events unless modified subsequently.
  • Using the Update Subscription Item API endpoint to change the billing interval of a subscription is only supported for single-item subscriptions (which is the most common type of subscription).
  • When replacing one subscription item with another, the original and the replacement items must have the same currency and billing interval.
  • Use of the CustomerPrice parameter in the API response is optional. Before doing so, see Understand Customer Price.
  • The renewal is not combined with an alignment of the subscription.
  • Use the AlignmentSettings parameter for the subscription in the API response is required. Before doing so, see Get Started with Subscription API > Alignment Settings.

Description

  1. On January 1st, 2020, a customer signs up for your proxy service for $80 monthly. The plan has a data limit of 5GB for the month. Another subscription would have been available for $220 and with a data limit of 20GB, but the customer is not ready to make that commitment.
  2. On January 15th, 2020, the customer used up the 5GB data limit and receives an email from your company. You tell the customer that they can regain access to the service by renewing immediately and upgrading to the 20GB package at a discounted price of $210. The message redirects the customer to a page that uses the Update Subscription Item API endpoint to obtain and display the discounted price of the upgrade, new expiration date (February 15th, 2020), and other details regarding the subscription.
  3. After reviewing this information, the customer confirms this purchase by clicking an Upgrade Now button on the page. The page uses the Update Subscription Item API endpoint to upgrade and renew the customer's subscription immediately.
  4. The Cleverbridge platform bills the customer the discounted price of $215 for the next billing interval, which starts immediately and ends on February 15th, 2020.
  5. The customer sees a confirmation page, which is either created by your company or provided by the Subscription API. If the transaction is not successful, the page provided by the API will inform the customer about the next steps, such as updating the payment details in case of a failed payment.

For more information on how to achieve this particular use case, see Integration Guide.

Options

Although not utilized in this use case, the following options are also available:

🚧

Important

Updated 5 months ago