Subscription Cancellation Endpoint
Last updated
Was this helpful?
Last updated
Was this helpful?
The Subscription Cancellation API allows merchants to terminate an active subscription before its scheduled end date. Once cancelled, no further charges will be processed for that subscription.
DELETE https://api-stg.directa24.com/v3/subscriptions/
{subscription_id}
Where {subscription_id}
is the unique numeric identifier of the subscription you wish to cancel.
This endpoint uses only a path parameter to identify the subscription:
id
integer
Yes
Unique numeric identifier of the subscription to cancel.
The request body should be empty for this endpoint.
The API may return the following errors:
Returned when attempting to cancel a subscription that has already been cancelled:
Returned when the specified subscription ID does not exist:
Returned when attempting to cancel a subscription that has already been terminated (completed its lifecycle):
Returned when an unexpected error occurs:
When a subscription is cancelled:
The subscription status is immediately changed to CANCELLED
All scheduled future charges are removed
The cancellation is recorded in the subscription history
Cancellation vs. Refund: Cancelling a subscription only prevents future charges. It does not refund any previous charges. To process refunds for previous transactions, use the separate Refund API.
Reactivation: Once a subscription is cancelled, it cannot be reactivated. A new subscription must be created if the customer wishes to resume the service.
Timing: Cancellation takes effect immediately, regardless of the subscription's billing cycle.
A successful cancellation returns an HTTP 200 status code .
This endpoint allows cancellation of an existing subscription by ID.
Unique numeric identifier of the subscription to be cancelled. This is the subscription ID provided when the subscription was created.
123456789
Media type of the body sent to the API.
ISO8601 Datetime with Timezone (yyyy-MM-dd'T'HH:mm:ssZ)
Merchant X-Login API Key.
Authorization control hash.
Unique idempotency key for ensuring that the same request is not processed more than once.