Subscriptions

Cancel a subscription

curl -X POST https://api.subscriby.net/v1/subscriptions/$SUBSCRIPTION_ID/cancel \
  -H "Authorization: Bearer $SUBSCRIBY_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"

Cancel is asynchronous: the endpoint answers 202 Accepted once cancellation is queued. Provider-side cancellation (Stripe, PayPal, Razorpay, Paystack and the others) and the accompanying subscription.cancelled event happen on the background worker.

post/v1/subscriptions/{subscription}/cancel

Request

  • Base URL: https://api.subscriby.net
  • URL: https://api.subscriby.net/v1/subscriptions/{subscription}/cancel
  • Auth: HTTP bearer

Path parameters

subscriptionstring uuid required

The subscription, resolved by the route binder.

Headers

Idempotency-Keystring uuid required

A key unique to this operation, such as a fresh UUID. The same key replays the original 2xx response for 24 hours (with Idempotent-Replay: true), so a retry after a timeout never repeats the write; the same key with a different body is refused with 409.

Response

202 with cancellation_queued.

Example response

{
  "data": {
    "subscription_id": "5b7e2d40-1a86-4c39-97f2-e83d0b16c5a4",
    "status": "cancellation_queued"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.