v1

latestOpenAPI 3.0.02026-07-2636111249.2 KB

Subscription API

Update Subscription Renewal Type

Updates the renewal type of a subscription, independent of the product configuration. Automatic renewal is the default for subscription products set up in the Cleverbridge platform. Use this endpoint to implement a 'Turn Off Automatic Renewal' option in a My Account section.<br /><b>Note:</b> To activate this feature, contact your Client Experience Manager.<br />For XML examples and schemas, see the Additional Examples - Update Subscription Renewal Type.

post/subscription/updatesubscriptionrenewaltype

Headers

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

Expected response format.

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

Format of the HTTP post body.

Request body

RenewalType'Manual' | 'Automatic' required

New renewal type of the subscription. With <code>Automatic</code>, the subscription automatically renews at the end of the billing interval using the billing information provided by the customer. With <code>Manual</code>, the customer must initiate the renewal at the end of the billing interval.

SubscriptionIdstring required

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

Response

ResultMessagestring

Optional result or error message.