Deactivate Subscription Items

post

https://rest.cleverbridge.com/subscription/deactivatesubscriptionitems

Deactivates one or more subscription items in a subscription.
Important: 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.

Body Params

AllowReinstate

boolean

Defaults to true

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

GenerateMail

boolean

Defaults to true

Set to false if you want to suppress the automatically generated email that informs the customer about the subscription update. Important: If set to false, you must send the email yourself. For more information, see Best Practices: Obtaining Customer Consent.

Items

array of int32s

required

Running numbers of the subscription items you want to deactivate.

Items*

SubscriptionId

string

required

Defaults to S23179293

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

Headers

string

enum

Defaults to application/json

Expected response format.

Allowed:

Content-Type

string

enum

Defaults to application/json

Format of the HTTP post body.

Allowed:

Responses

Language

Credentials

Basic

base64

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Bad Request

404Not Found

500Internal Server Error