v1

latestOpenAPI 3.0.12026-07-225791279.7 KB

Subscription Lifecycle

Pause Subscription

Pauses recurring billing for a subscription. Billing remains suspended until the subscription is resumed manually or automatically on the specified resume date.

Note:

If resumeAt is omitted, the subscription remains paused until it is resumed manually.

patch/subscription/api/v1/subscriptions/{id}/pause

Path parameters

idstring required

The ID of the subscription.

Request body

resumeAtstring date-time

Date and time when the subscription should automatically resume.

Example request

{
  "resumeAt": "2026-08-01T00:00:00"
}

Response

Request Successful

successboolean

Indicates if the request was successful.

messagestring

Descriptive message confirming the pause operation.

Example response

{
  "success": true,
  "message": "Subscription paused",
  "data": {
    "id": 22,
    "customerId": "test-trial-2",
    "customerEmail": "johndoe@gmail.com",
    "status": "PAUSED",
    "enrollmentReference": "SUBREF_EE9A8CD25F38423B87",
    "enrollmentTxnReference": "SUB_ENROLL_22_1783543549106",
    "pausedAt": "2026-07-08T22:05:03.791857158",
    "pauseResumesAt": "2026-07-08T22:05:52.596019689"
  }
}