API Reference
GuidesAPI ReferenceNotificationsDiscussionsSupportStatus

Update Subscription Item Price

post
https://rest.cleverbridge.com/subscription/updatesubscriptionitemprice

Updates (or creates a preview of an update to) the price of an existing subscription. If AlignToCurrentInterval is set to true, the response returns a prorated price that will be applied to the subscription item immediately. Optionally, it also allows you adjust the quantity of a subscription item.
For XML examples and schemas, see the Additional Examples - Update Subscription Item Price.

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.

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.

int32
Defaults to 1

Number of items. If you want to only increase the quantity of an existing subscription item, use /subscription/increasesubscriptionitemquantity instead.

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'.

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

Updated 5 months ago

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

Updated 5 months ago