v1

latestOpenAPI 3.0.0ISC2026-07-249501.1 MB
Subscriptions

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.

<!-- theme: warning -->

⚠️ Try It

To use the Try It feature for this endpoint, you can use the credentials for your Sandbox API user.<br/><br/>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: docs@nexiopay.com password: JZdzoXpdDeH6VA<br/><br/>Include a subscription ID in the path parameter of the request for a subscription created by the test account.

<div style="display:none;">

Request parameters

  • id

Response parameters

  • message
</div>
delete/subscription/v3/{id}

Path parameters

idstring required
Example:e80d63dd-a77b-407a-9124-42acf00740dd

The subscription ID.

Response

Success

messagestring

Message indicates success or failure for deleting the subscription.

Example response

{
  "message": "success"
}