Subscriptions

Pause a subscription

Suspends access: the member is removed from every linked resource, payment_status becomes paused and paused_at is stamped. Billing continues. Answers 202 with the outcome and emits subscription.paused.

Pause suspends access, not billing. The member's payment provider keeps charging on schedule. Subscriby settles through seven providers and only some can hold a recurring charge at all, so a pause meaning "stop billing" would work on some and silently not on others; access is what Subscriby controls directly, so it behaves identically everywhere. If billing must stop, cancel.

Only active and trialing subscriptions can be paused; only a paused one can be unpaused.

post/v1/subscriptions/{subscription}/pause

Request

  • Base URL: https://api.subscriby.net
  • URL: https://api.subscriby.net/v1/subscriptions/{subscription}/pause
  • 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 the outcome.

Example response

{
  "data": {
    "subscription_id": "5b7e2d40-1a86-4c39-97f2-e83d0b16c5a4",
    "plan_id": "c4e82f16-93a7-4d5b-b81c-6e0f27a94d3b",
    "payment_status": "paused",
    "outcome": "paused"
  }
}

Changes

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