Update Subscription Item

Modifies an existing subscription or creates a preview of a modified subscription. You can add a coupon code, adjust the quantity of a subscription item, bill a customer in arrears for usage, replace one product with another product, change the product name, and even change the billing interval of a subscription (by exchanging the product). This endpoint also allows you to update the price of an item.
For XML examples and schemas, see the Additional Examples - Update Subscription Item.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
AlignmentSettings
object

Define the behavior when adding or updating a subscription item. For more information, see Alignment Settings.

string
Defaults to BD3-1KK-UN3

Coupon code for a promotion. The customer will be given a discount on the next renewal or a future renewal, depending on the configuration of the coupon code.

CustomerPrice
object

Pricing information that the customer receives during the purchase process.

boolean
Defaults to true

Set to false if you want to suppress the automatically generated email that informs the customer about the subscription update. Important: If set to false, you must send the email yourself. For more information, see Best Practices: Obtaining Customer Consent.

int64
required
Defaults to 97771

ID of the new product you want to replace the existing product with.

string
Defaults to Internet Security Basic Extended

New product name to be used in customer communication.

string
Defaults to Internet Security Basic Extended

New English product name. Only used in internal communication and for reporting purposes.

string
Defaults to For your home

New product description. Corresponds to the Additional name information in the Cleverbridge platform.

int32
required
Defaults to 1

Total number of items after the update. If you want to only increase the item quantity, use /subscription/increasesubscriptionitemquantity instead.

int32
Defaults to 14665

ID of the 'recommendation set' to which the product belongs. Corresponds to the Recommendation ID in the Cleverbridge platform. Used for reporting purposes only.

int32
required
Defaults to 1

Running number of the item in the subscription.

string
required
Defaults to S24138411

Unique ID of the subscription, with or without an initial 'S'.

boolean
Defaults to false

Triggers a renewal immediately. As a result, it also extends the next billing cycle by remaining time of current cycle. You should use this with caution because it is not a standard action for subscription upgrades. Renewals are allowed between start of current billing interval and next billing date. For more information, see Renew a Manual-Renewal Subscription Ahead of Schedule.

boolean
Defaults to false

Set to true to immediately start the new billing interval. If you use this option, you must also set TriggerImmediateRenewal to true. Can be used when the customer has reached their data limit and you want to offer them to upgrade to a higher-value plan. For more information, see Combine an Upgrade with an Early Renewal at Full Price.

string
enum
required
Defaults to 0

Type of update. This is used for reporting only. It does not affect the subscription.

Allowed:
boolean
Defaults to false

Set to true if you want to update the price of the subscription item based on the current product price. You can use the parameter independent of any other price-relevant updates, such as a quantity or product change. For more information, see Use Case: Update Existing Subscription with New Product Pricing.

Headers
string
enum
Defaults to application/json

Expected response format.

Allowed:
string
enum
Defaults to application/json

Format of the HTTP post body.

Allowed:
Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json