Sign in

v1

latestOpenAPI 3.0.02026-07-2636111249.2 KB
Subscription API

Increase Subscription Item Quantity

Increases the quantity of a subscription item in a subscription.<br /> For XML examples and schemas, see the Additional Examples - Increase Subscription Item Quantity.

post/subscription/increasesubscriptionitemquantity

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 required

Number of additional items. For example <code>2</code>, if you want to increase the quantity from <code>1</code> to <code>3</code>.

RunningNumberinteger required

Running number of the item in the subscription.

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.