The RemoveSubscriptionItem API endpoint is used to permanently delete a subscription itemA subscription item is component of a subscription with its own set of attributes including price, description and feature set. for a discontinued product or special offer, making it impossible to reactivate in the future.
This function should be used rarely and with caution. It deletes the subscription item, and all data associated with it, for every subscription that contains the item. For any future reports, such as reporting on which items customers purchased, the item wouldn't be included.
It is recommended to use the DeactivateSubscriptionItems API endpoint instead, because it retains the subscription information but prevents future billing for the item.
Required Parameter Settings by Use Case
Certain parameters for use cases that use this function require specific values. Set the values for the parameters as shown in the table below.
|Parameter||Set to Value|
||The unique identifier for the subscription.|
||2 (The second of two items being removed.)|
For more information, see Use Case: Remove Discontinued or Temporary Subscription Item.