Sign in

v1

latestOpenAPI 3.0.02026-07-2636111249.2 KB
Subscription API

Update Subscription Item Price

Updates (or creates a preview of an update to) the price of an existing subscription. If <code>AlignToCurrentInterval</code> is set to <code>true</code>, 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.<br /> For XML examples and schemas, see the Additional Examples - Update Subscription Item Price.

post/subscription/updatesubscriptionitemprice

Headers

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

Expected response format.

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

Format of the HTTP post body.

Request body

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.

Quantityinteger

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

RunningNumberinteger required

Running number of the item in the subscription.

SubscriptionIdstring required

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

UpdateAction'Update' | 'Upgrade' | 'Downgrade' required

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

ForcePriceRecalculationboolean

Set to <code>true</code> 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.

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.