---
title: "Pause subscription"
method: POST
path: "/subscriptions/{id}/pause/"
tags: ["Billing"]
---

# Pause subscription

`POST /subscriptions/{id}/pause/`

## Request body

- SubscriptionPause — Body for `POST /subscriptions/{id}/pause/`.
  - `paused_reason` 'not_specified' | 'non_compliant_customer' | 'custom', required
  - `pause_until` string, date, nullable

## Response `200`

Paused subscription.

- Subscription
  - `id` string
  - `customer` string, required — Customer ID.
  - `document` integer, required — Document type ID used to issue invoices.
  - `date_start` string, date, required
  - `next_billing` string, date, required
  - `previous_billing` string, date, nullable
  - `billing_cycles` integer, nullable — Total cycles or null for indefinite.
  - `next_billing_cycle` integer
  - `expiration_days` integer — Days until invoices generated by this subscription expire.
  - `collection_scheme` 'send_invoice' | 'charge_payment'
  - `default_source` string, nullable — Default payment source ID. Required when `collection_scheme=charge_payment`.
  - `custom_change` number, nullable — Custom currency conversion factor for issued invoices.
  - `coupon` string, nullable — Coupon ID applied at the subscription (invoice-level) scope.
  - `coupon_redemptions` integer
  - `require_reference` boolean
  - `note` string, nullable
  - `orgunit` integer, nullable
  - `status` 'active' | 'paused' | 'cancelled' | 'finalized' | 'needs_attention'
  - `status_description` string, nullable
  - `needs_attention` string, date-time, nullable
  - `needs_attention_reason` 'biller_issue' | 'gateway_issue' | 'reference_expired' | 'without_usage_records' | 'processing_issue' | 'without_reference', nullable
  - `cancel_reason` 'custom' | 'fraud_review_failed' | 'insolvency' | 'no_card' | 'non_compliant_customer' | 'not_paid' | 'not_specified' | 'shutdown_ops', nullable
  - `cancelled` string, date-time, nullable
  - `paused` string, date-time, nullable
  - `paused_reason` 'not_specified' | 'non_compliant_customer' | 'custom', nullable
  - `pause_until` string, date, nullable
  - `lines` SubscriptionLine[], required
    - `id` string
    - `plan` string, required — Plan ID. Read responses include the full plan inline.
    - `quantity` integer, required
    - `coupon` string, nullable — Coupon ID applied to this line.
    - `coupon_redemptions` integer
    - `created` string, date-time
    - `updated` string, date-time
  - `addons` SubscriptionAddon[]
    - `addon` string — Addon ID.
    - `quantity` integer
    - `addon_redemptions` integer
    - `rates` SubscriptionAddonRate[]
      - `billing_cycle` integer — Billing cycle this rate applies to.
      - `percentage` number — Discount/markup percentage applied to the addon for the cycle.
      - `description` string, nullable
  - `references` SubscriptionReference[]
    - `date` string, date, required
    - `date_end` string, date, nullable
    - `document` string, required — Document reference type.
    - `description` string, nullable
    - `serial` string, required
  - `test_mode` boolean
  - `created` string, date-time
  - `updated` string, date-time

---

[API](https://skmtc.net/piriod/apis/piriod-api.md) · [All operations](https://skmtc.net/piriod/apis/piriod-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/piriod/piriod-api/versions/70cbc827dc7b/schema)