v1

latestOpenAPI 3.1.02026-07-24170121.2 MB

Resume a Subscription

This API resumes a paused subscription. Canceled subscriptions cannot be resumed, and only subscriptions with status paused can be resumed. When the subscription is resumed, the status is changed to active, resumed_at is stored, paused_at and pause_end_at are cleared, and current_period_end is recalculated according to the subscription plan rules. For day and week plans, the remaining paused time is restored from the resume moment. For month and year plans, billing cadence is preserved.

post/v1/subscriptions/{id}/resume

Path parameters

idstring required

id here refers to a specific subscription that needs to be resumed.

Headers

Acceptstring required

Indicates which content types, expressed as MIME types, the client is able to understand.

Response

200

Example response

{
  "data": {
    "object": "Subscription",
    "id": "xlRP0jgPl0ljAXog",
    "customer_id": "jDPAnVxA4xPDVpKM",
    "billing_type": 1,
    "current_period_end": 1727095636,
    "current_period_start": 1726490836,
    "plan_ref": "n2pv6j6p2pvj3Ygq",
    "start_at": 1726145236,
    "status": "active",
    "tax_percent": 5,
    "created_at": 1726145236,
    "updated_at": 1726490836,
    "description": "testr",
    "payment_type": "card",
    "resumed_at": 1726490836,
    "pause_units_allowed": [
      "weeks"
    ],
    "plan": {
      "data": {
        "object": "Plan",
        "plan_id": "plan_d2b50d00",
        "amount": 99,
        "interval": "week",
        "interval_count": 1,
        "name": "test",
        "statement_descriptor": "dfghdfhg",
        "currency": "usd",
        "created_at": 1724503321,
        "updated_at": 1724505447
      }
    }
  },
  "meta": {
    "include": [
      "plan"
    ]
  }
}