Sign in

v1

latestOpenAPI 3.0.02026-07-2636111249.2 KB
Subscription API

Remove Subscription Item

Permanently deletes a subscription item for a discontinued product or special offer, making it impossible to reactivate the subscription item in the future. This endpoint should be used rarely and with caution.<br />For more information, see Remove Discontinued or Temporary Subscription Item. For XML examples and schemas, see the Additional Examples - Remove Subscription Item.

post/subscription/removesubscriptionitem

Headers

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

Expected response format.

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

Format of the HTTP post body.

Request body

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.

RunningNumberinteger required

Running number of the item in the subscription.

SubscriptionIdstring required

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

Response

OK

ResultMessagestring

Optional result or error message.