---
title: "Freeze Subscription"
method: POST
path: "/api/v2/subscriptions/{subscription_id}/freeze"
tags: ["Subscriptions"]
---

# Freeze Subscription

`POST /api/v2/subscriptions/{subscription_id}/freeze`

Freeze a subscription to pause invoice generation for a specific period.

During the freeze period, no invoices will be generated for the subscription. The subscription
will automatically resume after the freeze period ends.

## Path parameters

- `subscription_id` string, uuid, required — Unique identifier (UUID) of the subscription to freeze

## Request body

- FreezeSubscriptionCreateRequest
  - `freeze_start_datetime` string, date-time, required — Start date and time when the subscription freeze period begins
  - `freeze_end_datetime` string, date-time, nullable — End date and time when the subscription freeze period ends. If not provided, the freeze will continue indefinitely until manually removed.
  - `notes` string, nullable — Optional notes explaining the reason for the freeze

## Response `200`

Successful Response

- FreezeSubscriptionBase
  - `created_at` string, date-time — Creation timestamp of the object.
  - `updated_at` string, date-time, nullable — Last modification timestamp of the object.
  - `id` string, uuid
  - `freeze_start_datetime` string, date-time
  - `freeze_end_datetime` string, date-time, nullable
  - `notes` string, nullable
  - `subscription_id` string, uuid
  - `invoice_id` string, uuid
  - `duration` integer, nullable

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/streampay/apis/stream-app.md) · [All operations](https://skmtc.dev/streampay/apis/stream-app/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/streampay/stream-app/revisions/515eeea7d260/schema)