API Reference
GuidesAPI ReferenceNotificationsDiscussionsSupportStatus

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
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.

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*
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:
string
enum
Defaults to application/json

Format of the HTTP post body.

Allowed:
Responses

Updated 6 months ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago