Sign in

v1

latestOpenAPI 3.0.02026-07-2636111249.2 KB
Subscription API

Renew Subscription

Triggers an instant renewal of a subscription. If the renewal payment can be processed with the current payment details, then the subscription is renewed, and the customer receives an email confirmation with the delivery details. If the renewal payment cannot be processed with the current payment details, or if an offline payment is required, then the customer receives an email with payment instructions. You can use this API if a B2B customer has budget left at the end of the year, and they want to renew their auto-renewal subscription before the end of the year.<br />For XML examples and schemas, see the Additional Examples - Renew Subscription.

post/subscription/renewsubscription

Headers

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

Expected response format.

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

Format of the HTTP post body.

Request body

SubscriptionIdstring required

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

ResetBillingIntervalboolean

Set to <code>true</code> to immediately start the new billing interval. Can be used when the customer has reached their data limit. For more information, see Renew a Subscription Early at Full Price.

Response

OK

ContinueUrlstring

URL of web page with transaction details or payment instructions.

NextBillingDatestring date-time

Next billing date according to RFC3339. Specified in UTC.

TransactionStatusstring

Status of the renewal transaction. Possible values are <code>Success</code>, <code>Error</code>, <code>Rejected</code>, <code>Pending</code>, <code>Unknown</code>. See Transaction Status for explanations to those values.

ResultMessagestring

Optional result or error message.