Sign in

v1

latestOpenAPI 3.0.02026-07-2636111249.2 KB
Subscription API

Align Subscriptions

Consolidates the billing of two subscriptions that belong to one customer. If <code>AlignToCurrentInterval</code> is set to <code>true</code>, the resource performs a pro-rated calculation of the cost of one subscription so that it can be merged with another subscription, and this results in a single billing event for a given period. You can also use the resource to calculate and preview the pro-rated cost of aligning two subscriptions. <br />For more information, see Align Subscriptions. For XML examples and schemas, see the Additional Examples - Align Subscriptions.

post/subscription/alignsubscriptions

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>true</code> if you want to send a confirmation email to the customer.

PrimarySubscriptionIdstring required

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

SecondarySubscriptionIdstring required

Unique ID of the secondary 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.