---
title: "Pause Subscription"
method: PATCH
path: "/subscription/api/v1/subscriptions/{id}/pause"
tags: ["Subscription Lifecycle"]
---

# Pause Subscription

`PATCH /subscription/api/v1/subscriptions/{id}/pause`

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.

## Path parameters

- `id` string, required

## Request body

- PauseSubscriptionRequest
  - `resumeAt` string, date-time — Date and time when the subscription should automatically resume.

## Response `200`

Request Successful

- PauseSubscriptionResponse
  - `success` boolean — Indicates if the request was successful.
  - `message` string — Descriptive message confirming the pause operation.
  - `data` object — The payload containing the details of the paused subscription.
    - `id` integer — Unique internal identifier for the subscription.
    - `customerId` string — Unique reference identifier assigned to the customer layer.
    - `customerEmail` string, email — The email address of the customer whose subscription was paused.
    - `status` string — The updated lifecycle state of the subscription, which is now **PAUSED**.
    - `enrollmentReference` string — The global token signature identifying the authorized card reference.
    - `enrollmentTxnReference` string — Transaction baseline reference tracking the original enrollment event.
    - `pausedAt` string, date-time — Timestamp indicating exactly when the subscription engine was paused.
    - `pauseResumesAt` string, date-time — Projected timestamp indicating when the system will automatically lift the pause and resume billing collections.

## Other responses

- `400` — Invalid request

---

[API](https://skmtc.net/payaza/apis/payaza-documentation.md) · [All operations](https://skmtc.net/payaza/apis/payaza-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/payaza/payaza-documentation/versions/1ecd4b94ff07/schema)