Cancel Recurring Payment
POST/recurring/:recurringUuid/cancel
Cancels an active recurring payment profile. Once cancelled, no further charges will be scheduled or processed for this recurring payment.
Cancellation behavior:
- All charges with status 'scheduled' will be cancelled
- All charges with status 'retry_pending' will be cancelled
- All retry attempts with status 'scheduled' will be cancelled
- Any charges currently in progress will be allowed to complete
This operation is idempotent - repeated cancellation requests will not cause errors.
Request
Responses
- 204
- 400
- 401
- 403
- 404
- 412
- 500
- 502
- 503
Recurring payment cancelled successfully
Invalid request parameters.
Authentication failed. Verify that a valid Api-Access-Token is provided in the request headers.
Access denied. The API token does not have permission to cancel recurring payments for the specified shop.
Resource not found.
Precondition failed.
Internal server error. An unexpected error occurred on the server side.
Service unavailable. The upstream service is temporarily unreachable.
Service unavailable. The server is temporarily unable to handle the request.