Delete a subscription

Deletes an existing payment subscription (or pay plan) based on the specified id. Deleting a subscription or payment plan cancels it so that the system does not run any more transactions for it. For a payment plan, this may mean that there is still an unpaid balance.

The ID needed for the path parameter is returned in the response for the Create a subscription endpoint. Alternately, you can get the id for a subscription if you have a customerRef for the View customer subscriptions endpoint.


Try It

To use the Try It feature for this endpoint, you can use the credentials for your Sandbox API user.

You can also use the following test account. Copy the value and paste it into the appropriate space in the Try It section to the right.
username: [email protected]
password: JZdzoXpdDeH6VA

Include a subscription ID in the path parameter of the request for a subscription created by the test account.

Request parameters

  • id

Response parameters

  • message
Click Try It! to start a request and see the response here!