Sign in

v1

latestOpenAPI 3.0.02026-07-2636111249.2 KB
Subscription API

Deactivate Subscription Items

Deactivates one or more subscription items in a subscription.<br /><b>Important:</b> We do not recommend using this endpoint to cancel the only item of a single-item subscription or the last active item of a multi-item subscription. Use the Update Subscription Renewal Type endpoint to turn off the automatic renewal for the entire subscription instead. For XML examples and schemas, see the Additional Examples - Deactivate Subscription Items. For more information about managing subscriptions, see Subscription Management 1.0 and 2.0.

post/subscription/deactivatesubscriptionitems

Headers

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

Expected response format.

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

Format of the HTTP post body.

Request body

AllowReinstateboolean

Set to <code>true</code> if you want to be able to reinstate items at a later date. If set to <code>false</code>, the item status changes to <code>Finished</code>. If set to <code>false</code>, <code>GenerateMail</code> must also be set to <code>false</code>.

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.

Itemsinteger[] required

Running numbers of the subscription items you want to deactivate.

SubscriptionIdstring required

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

Response

OK

ResultMessagestring

Optional result or error message.