Pause a subscription

Pause support depends on the payment provider and the subscription's configured pause policy.

Authorization

bearerAuth

AuthorizationBearer <token>

Provide your SellApp API key as a bearer token.

In: header

Path Parameters

productSubscription*integer

The productSubscription path parameter.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

idempotency_key?|

Optional idempotency key. You may also send this as the Idempotency-Key header.

Lengthlength <= 128

resume_at?|

Formatdate-time

reason?|

Lengthlength <= 500

Response Body

`application/json`

curl -X POST "https://sell.app/api/v2/subscriptions/0/actions/pause" \  -H "Content-Type: application/json" \  -d '{    "resume_at": "2026-07-10T12:00:00Z",    "reason": "Customer request"  }'

{
  "data": {
    "id": 101,
    "product_subscription_id": 55,
    "subscription_id": "sub_1QwertyExample",
    "action": "pause",
    "status": "confirmed",
    "provider": "stripe",
    "customer_message": null,
    "confirmed_at": "2026-07-03T12:00:00.000000Z",
    "failed_at": null,
    "created_at": "2026-07-03T12:00:00.000000Z",
    "updated_at": "2026-07-03T12:00:00.000000Z"
  },
  "message": "Subscription pause requested."
}