Add Subscription Item

post

https://rest.cleverbridge.com/subscription/addsubscriptionitem

Adds a new subscription item to an existing subscription or creates a preview of adding a new subscription item to an existing subscription. Optionally, you can overwrite the price of the subscription item that was defined in the Cleverbridge platform. If you want to modify an existing subscription item, use /subscription/updatesubscriptionitem instead.
For XML examples and schemas, see the Additional Examples - Add Subscription Item.

Body Params

AffiliateId

int64

Defaults to 21599

ID of the affiliate that receives the commission.

AlignmentSettings

object

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

CouponCode

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.

GenerateMail

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.

ProductId

int64

required

Defaults to 97771

ID of the product you want to add to the subscription.

ProductName

string

Defaults to Internet Security Basic Extended

Product name used in customer communication.

ProductNameEn

string

Defaults to Internet Security Basic Extended

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

ProductNameExtension

string

Defaults to For your home

Product description. Corresponds to the Additional name information in the Cleverbridge platform.

Quantity

int32

required

Defaults to 1

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

RecommendationsetId

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.

SubscriptionId

string

required

Defaults to S18577447

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

Headers

string

enum

Defaults to application/json

Expected response format.

Allowed:

Content-Type

string

enum

Defaults to application/json

Format of the HTTP post body.

Allowed:

Responses

200OK

400Bad Request

404Not Found

500Internal Server Error