Sign in

v1

latestOpenAPI 3.0.02026-07-2636111249.2 KB
Subscription API

Add Subscription Item

Adds a new subscription item to an existing subscription or creates a preview of adding a new subscription item to an existing subscription. <br/> <p>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 <a href="https://dev.cleverbridge.com/reference/updatesubscriptionitem">Update Subscription Item</a> instead.<p> <p>For XML examples and schemas, see the Additional Examples - Add Subscription Item.</p>

post/subscription/addsubscriptionitem

Headers

Accept'application/json' | 'application/xml'

Expected response format.

Content-Type'application/json' | 'application/xml'

Format of the HTTP post body.

Request body

AffiliateIdinteger

ID of the affiliate that receives the commission.

CouponCodestring

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.

GenerateMailboolean

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

ProductIdinteger required

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

ProductNamestring

Product name used in customer communication.

ProductNameEnstring

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

ProductNameExtensionstring

Product description. Corresponds to the <b>Additional name information</b> in the Cleverbridge platform.

Quantityinteger required

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

RecommendationsetIdinteger

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

SubscriptionIdstring required

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

Response

OK

AlignmentCustomerGrossPricenumber double

Total gross price for alignment interval. Only for <code>CustomerPricePreview-Mode</code>.

AlignmentCustomerNetPricenumber double

Total net price for alignment interval. Only for <code>CustomerPricePreview-Mode</code>.

AlignmentCustomerVatPricenumber double

Total VAT amount for alignment interval. Only for <code>CustomerPricePreview-Mode</code>.

NextBillingCustomerGrossPricenumber double

Total gross price for next billing interval. Only for <code>CustomerPricePreview-Mode</code>.

NextBillingCustomerNetPricenumber double

Total net price next billing interval. Only for <code>CustomerPricePreview-Mode</code>.

NextBillingCustomerVatPricenumber double

Total VAT amount for next billing interval. Only for <code>CustomerPricePreview-Mode</code>.

NextRenewalCustomerGrossPricenumber double

Total gross price for next subscription interval. Only for <code>CustomerPricePreview-Mode</code>.

NextRenewalCustomerNetPricenumber double

Total net price next subscription interval. Only for <code>CustomerPricePreview-Mode</code>.

NextRenewalCustomerVatPricenumber double

Total VAT amount for next subscription interval. Only for <code>CustomerPricePreview-Mode</code>.

PriceCurrencyIdstring

Currency code in capital letters, see ISO 4217.

ResultMessagestring

Optional result or error message.