---
title: "Pause the subscription"
method: POST
path: "/api/v1/subscription/pause"
tags: ["Subscription"]
---

# Pause the subscription

`POST /api/v1/subscription/pause`

## Request

- Base URL: `https://www.poster.ly`
- URL: `https://www.poster.ly/api/v1/subscription/pause`
- Auth: HTTP bearer

Pause the authenticated user posterly subscription for 30 days. Only one pause is allowed per 90-day cooldown. Requires the `billing:write` scope. Bypasses the API add-on paywall.

## Response `200`

Subscription paused.

- PauseSubscriptionResponse
  - `success` true, required
  - `pause_resumes_at` string, date-time, required

## Other responses

- `400`: Validation error
- `401`: Invalid or missing API key
- `403`: Request is authenticated but not allowed
- `404`: Resource not found
- `429`: Too many requests

---

[API](https://skmtc.dev/poster/apis/posterly-api.md) · [All operations](https://skmtc.dev/poster/apis/posterly-api/llms.txt) · [OpenAPI document](https://skmtc.dev/poster/apis/posterly-api/revisions/60be02a61f95?raw)