Subscription - Resume Subscription

Resume a paused subscription.

Example request

cURL

curl --request POST \
  --url https://sandbox.hyperswitch.io/subscriptions/{subscription_id}/resume \
  --header 'Content-Type: application/json' \
  --header 'X-Profile-Id: <x-profile-id>' \
  --header 'api-key: <api-key>' \
  --data '
{
  "resume_option": "immediately",
  "unpaid_invoices_handling": "schedule_payment_collection"
}
'

Example response (200)

{
  "id": "<string>",
  "status": "active",
  "profile_id": "<string>",
  "merchant_id": "<string>",
  "customer_id": "<string>",
  "merchant_reference_id": "<string>",
  "next_billing_at": "<string>"
}

---

HTTP

POST /subscriptions/{subscription_id}/resume

---

Authorizations

• api-key (header, string) — required Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.

---

Headers

• X-Profile-Id (string) — required Profile ID for authentication

---

Path parameters

• subscription_id (string) — required The unique identifier for the subscription

---

Body (application/json)

Request payload for resuming a subscription.

• resume_option (enum) Available options:

  • immediately

  • specific_date

• resume_date (string | null) Optional date when the subscription should be resumed (if not provided, resumes immediately)

• charges_handling (enum) Available options:

  • invoice_immediately

  • add_to_unbilled_charges

• unpaid_invoices_handling (enum) Available options:

  • no_action

  • schedule_payment_collection

---

Response (200 — application/json)

Subscription resumed successfully. Response payload returned after successfully resuming a subscription.

• id (string) — required Subscription identifier

• status (enum) — required Possible states of a subscription lifecycle:

  • active

  • created

  • in_active

  • pending

  • trial

  • paused

  • unpaid

  • onetime

  • cancelled

  • failed

• profile_id (string) — required Business profile identifier

• merchant_id (string) — required Merchant identifier

• customer_id (string) — required Customer identifier

• merchant_reference_id (string | null) Merchant specific unique identifier

• next_billing_at (string | null) Date when the subscription was resumed

---

Suggest edits: https://github.com/juspay/hyperswitch/edit/main/api-reference/v1/subscriptions/resume.mdx Raise issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/v1/subscriptions/resume

Related:

• Subscription — Pause Subscription: https://api-reference.hyperswitch.io/v1/subscriptions/pause

• Subscription — Cancel Subscription: https://api-reference.hyperswitch.io/v1/subscriptions/cancel

Responses are generated using AI and may contain mistakes.