---
title: "Pause or reactivate a recurring payment"
method: PUT
path: "/recurring-payments/{reference}/status"
tags: ["Recurring Payments"]
---

# Pause or reactivate a recurring payment

`PUT /recurring-payments/{reference}/status`

## Path parameters

- `reference` string, required

## Request body

- object
  - `status` 'Paused' | 'Active', required — Your desired state of the recurring payment. Provide `Paused` with `paused_until` to pause a recurring payment. Otherwise, provide `Active` to resume a recurring payment.
  - `paused_until` string — To pause a payment, provide a ISO8601 formatted date on which the payment should be reactivated.

## Response `200`

Successfully paused or reactivated a payment. The `RecurringPayment` is returned.

- RecurringPayment
  - `id` integer
  - `created_at` string, date-time
  - `updated_at` string, date-time
  - `paused_at` string, date-time, nullable
  - `paused_until` string, date-time, nullable
  - `next_payment_date` string
  - `reference` string
  - `account_id` integer
  - `interval` string
  - `cancelled_at` string, date-time, nullable
  - `cancellation_requested_at` string, date-time, nullable
  - `status` object
    - `id` integer
    - `class` string
    - `description` string
    - `active` integer
  - `amount` object
    - `amount` number, float
    - `tax` number, float
    - `period` string
  - `cancel_reason` string, nullable
  - `links` object
    - `initial_payment` string
    - `payment_history` string[]

## Other responses

- `404` — Recurring payment not found.
- `422` — Unprocessible Entity. An invalid status was provided or the recurring payment cannot be processed. See ErrorResponse.

---

[API](https://skmtc.net/tebex/apis/tebex-checkout-api.md) · [All operations](https://skmtc.net/tebex/apis/tebex-checkout-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tebex/tebex-checkout-api/revisions/a52c87b9a2b9/schema)