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

# Pause a subscription

`POST /subscriptions/{id}/pause`

Use when temporarily stopping a subscription (e.g. customer hold or seasonal pause). Billing and access pause; resume when ready.

## Path parameters

- `id` string, required

## Request body

- PauseSubscriptionRequest — Request object for pausing an active subscription with various pause modes and options
  - `dry_run` boolean — Whether to perform a dry run @Description If true, validates the request and shows impact without actually pausing the subscription @Example false
  - `metadata` object — Additional metadata as key-value pairs @Description Optional metadata for storing additional information about the pause @Example {"requested_by": "customer", "channel": "support_ticket"}
  - `pause_days` integer — Duration of the pause in days @Description Number of days to pause the subscription. Cannot be used together with pause_end. Must be greater than 0 @Example 30
  - `pause_end` string, date-time — End date for the subscription pause @Description ISO 8601 timestamp when the pause should end. Cannot be used together with pause_days. Must be after pause_start @Example "2024-02-15T00:00:00Z"
  - `pause_mode` 'immediate' | 'scheduled' | 'period_end', required
  - `pause_start` string, date-time — Start date for the subscription pause @Description ISO 8601 timestamp when the pause should begin. Required when pause_mode is "scheduled" @Example "2024-01-15T00:00:00Z"
  - `reason` string — Reason for pausing the subscription @Description Optional reason for the pause. Maximum 255 characters @Example "Customer requested temporary suspension"

## Response `200`

OK

- SubscriptionPauseResponse — Response object containing subscription pause information
  - `created_at` string, date-time
  - `created_by` string
  - `environment_id` string — EnvironmentID is the environment identifier for the pause
  - `id` string — ID is the unique identifier for the subscription pause
  - `metadata` TypesMetadata
  - `original_period_end` string, date-time — OriginalPeriodEnd is the end of the billing period when the pause was created
  - `original_period_start` string, date-time — OriginalPeriodStart is the start of the billing period when the pause was created
  - `pause_end` string, date-time — PauseEnd is when the pause will end (null for indefinite)
  - `pause_mode` 'immediate' | 'scheduled' | 'period_end'
  - `pause_start` string, date-time — PauseStart is when the pause actually started
  - `pause_status` 'none' | 'active' | 'scheduled' | 'completed' | 'cancelled'
  - `reason` string — Reason is the reason for pausing
  - `resume_mode` 'immediate' | 'scheduled' | 'auto'
  - `resumed_at` string, date-time — ResumedAt is when the pause was actually ended (if manually resumed)
  - `status` 'published' | 'deleted' | 'archived'
  - `subscription_id` string — SubscriptionID is the identifier for the subscription
  - `tenant_id` string
  - `updated_at` string, date-time
  - `updated_by` string

## Other responses

- `400` — Invalid request
- `404` — Resource not found
- `500` — Server error

## Changes

- **2026-04-06** `95af41a12111` — 6 warning, 12 info
  - removed the optional property `error` from the response with the `400` status
  - removed the optional property `error` from the response with the `404` status
  - removed the optional property `error` from the response with the `500` status
  - removed the optional property `success` from the response with the `400` status
  - …14 more
- **2026-04-04** `9013edc21339` — 2 breaking
  - the `pause_end` request property type/format changed from `string`/`` to `string`/`date-time`
  - the `pause_start` request property type/format changed from `string`/`` to `string`/`date-time`

[Change history](https://skmtc.dev/flexprice/apis/flexprice-api/changes/subscriptions/:id/pause/post.md)

---

[API](https://skmtc.dev/flexprice/apis/flexprice-api.md) · [All operations](https://skmtc.dev/flexprice/apis/flexprice-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/flexprice/flexprice-api/revisions/95af41a12111/schema)