> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.solvimon.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.solvimon.com/_mcp/server. # Pausing and resuming A paused subscription stops billing without ending, and picks up later on the same plan, price and payment method. --- ## Why this matters A customer who wants to stop paying for a while has two options without a pause: cancel and sign up again, or keep paying for something they are not using. Cancelling loses the contract with the customer; the plan version, the negotiated pricing, etc. A pause keeps all of it. The subscription stays on the customer, keeps its id, its terms and its history, and nothing is billed for as long as the pause runs. This is what seasonal businesses, parental leave, a project between phases and a retention offer in a cancellation flow all need. ## How it works Pausing is a change to the chain of [schedules](/platform-guides/customers-and-billing/subscriptions/subscription-schedules) the subscription is made of, plus a status. A pause request records a `PAUSE` **inactive period** on the subscription. Billing respects that period immediately, even when the pause itself starts months later: no fee is invoiced from the pause start. When the start arrives, the current schedule is ended there and a `PAUSE` **schedule** takes over, as a copy of the one it replaces. The subscription moves to status `PAUSED`. At the resume, the `PAUSE` schedule ends and another copy of the original schedule starts. Because a `PAUSE` schedule fills the gap, the chain is never interrupted. That is what makes a long or open-ended pause resumable on the same subscription, and what makes an invoice recalculated months later still skip the paused span. ![How schedules change through a pause](/_fern-files/_img/2687fc5abe7b1bd25c7b161edb6ece29a322e21d28eb10fb4740a871cfc9299b.webp) ### Status ```mermaid stateDiagram-v2 state "Active" as Active state "Active, pause scheduled" as Scheduled state "Paused" as Paused state "Cancelled" as Cancelled Active --> Scheduled : pause, starting later Scheduled --> Active : delete the scheduled pause Scheduled --> Paused : the pause start arrives Active --> Paused : pause, starting now Paused --> Active : resume, now or at the planned end Active --> Cancelled : cancel Paused --> Cancelled : cancel ``` A scheduled pause is not a status of its own. The subscription stays `ACTIVE` with a future `PAUSE` period in `inactive_periods` until the pause actually starts. | Status | What it means | | :------- | :---------------------------------------------------------------------------------------- | | `ACTIVE` | Billing as normal. A future `PAUSE` period means a pause is scheduled | | `PAUSED` | No invoices, no fees, no usage priced. Invoices from before the pause are still collected | ### When the pause starts and ends The start is `from`, the end is `until`. Both are objects with a `type`. | `from.type` | The pause starts | | :-------------------- | :-------------------------------------------------------------- | | `NOW` | At the exact second the call is made | | `NEXT_BILLING_PERIOD` | At the start of the next billing period | | `AFTER_INITIAL_TERM` | At the end of the initial term, resolved when you make the call | | `DATE` | At `from.date`, which cannot be in the past | | `until.type` | The pause ends | | :-------------------- | :--------------------------------------------------------------------------------------------- | | `DATE` | At `until.date` | | `PERIOD` | At the pause start plus `until.period`, for example one month | | `NEXT_BILLING_PERIOD` | At the first billing date of the original cycle after the pause start | | `INDEFINITE` | Not on its own. It runs until someone resumes it. This is the default when `until` is left out | The resolved dates land on the `PAUSE` period as `start_at` and `end_at`, while `pause.from` and `pause.until` keep what you submitted. An end you reach early by resuming overwrites `end_at` and leaves `pause.until` alone, so the record still says what was agreed. ## Implementation ### Via API Every call needs the `PRICING_PLAN_SUBSCRIPTION.PAUSE` permission. | Call | Does | | :------------------------------------------------- | :-------------------------------------------------------------------------- | | `POST /v1/pricing-plan-subscriptions/{id}/pause` | Pause now, or schedule a pause | | `PATCH /v1/pricing-plan-subscriptions/{id}/pause` | Change the end or the reason, and the start while the pause has not started | | `DELETE /v1/pricing-plan-subscriptions/{id}/pause` | Delete a scheduled pause that is not started yet | | `POST /v1/pricing-plan-subscriptions/{id}/resume` | Resume now | Pause a subscription on a date, for one month: **`Pause for one month from 1 November`** ```curl Pause for one month from 1 November curl -X POST https://test.api.solvimon.com/v1/pricing-plan-subscriptions/ppsu_awDeAl0tsKup9BBJNU1m/pause \ -H "X-API-KEY: " \ -H "Content-Type: application/json" \ -d '{ "from": { "type": "DATE", "date": "2026-11-01T00:00:00Z" }, "until": { "type": "PERIOD", "period": { "type": "MONTH", "value": 1 } }, "realign_billing_dates": false, "reason": "seasonal" }' ``` The response is the subscription. The pause sits in `inactive_periods`, with the resolved dates next to the request: **`Response`** ```json Response { "id": "ppsu_awDeAl0tsKup9BBJNU1m", "status": "ACTIVE", "inactive_periods": [ { "type": "PAUSE", "start_at": "2026-11-01T00:00:00Z", "end_at": "2026-12-01T00:00:00Z", "reason": "seasonal", "pause": { "from": { "type": "DATE", "date": "2026-11-01T00:00:00Z" }, "until": { "type": "PERIOD", "period": { "type": "MONTH", "value": 1 } }, "realign_billing_dates": false } } ], "pricing_plan_schedule_infos": [ { "type": "DEFAULT", "start_at": "2026-04-01T00:00:00Z", "end_at": "2026-11-01T00:00:00Z" } ] } ``` The status is still `ACTIVE` and there is no `PAUSE` schedule yet: the subscription is paused on 1 November, and until then it keeps running. What does change straight away is the billing: the existing schedule now ends at 1 November, so no fee is invoiced beyond it. Pause immediately and leave the end open: **`Pause now, until further notice`** ```curl Pause now, until further notice curl -X POST https://test.api.solvimon.com/v1/pricing-plan-subscriptions/ppsu_awDeAl0tsKup9BBJNU1m/pause \ -H "X-API-KEY: " \ -H "Content-Type: application/json" \ -d '{ "from": { "type": "NOW" }, "until": { "type": "INDEFINITE" } }' ``` Change the end of a pause that is scheduled or already running. Fields you leave out keep their stored value, and `reason: null` clears the reason: **`Extend the pause to 15 December`** ```curl Extend the pause to 15 December curl -X PATCH https://test.api.solvimon.com/v1/pricing-plan-subscriptions/ppsu_awDeAl0tsKup9BBJNU1m/pause \ -H "X-API-KEY: " \ -H "Content-Type: application/json" \ -d '{ "until": { "type": "DATE", "date": "2026-12-15T00:00:00Z" } }' ``` Resume a `PAUSED` subscription before its planned end: **`Resume now`** ```curl Resume now curl -X POST https://test.api.solvimon.com/v1/pricing-plan-subscriptions/ppsu_awDeAl0tsKup9BBJNU1m/resume \ -H "X-API-KEY: " \ -H "Content-Type: application/json" \ -d '{ "realign_billing_dates": false }' ``` Deleting a scheduled pause takes no body, and only works before the pause has started: **`Delete a scheduled pause`** ```curl Delete a scheduled pause curl -X DELETE https://test.api.solvimon.com/v1/pricing-plan-subscriptions/ppsu_awDeAl0tsKup9BBJNU1m/pause \ -H "X-API-KEY: " ``` > **Note** > > Pauses and cancellations are kept apart: deleting a scheduled cancellation never removes a pause, and deleting a pause never removes a cancellation. See [Cancelling subscriptions](/platform-guides/customers-and-billing/subscriptions/subscription-lifecycle#cancelling-subscriptions). ### Via Desk Open the subscription and use its menu: **Pause**, then **Change pause**, **Delete scheduled pause** or **Resume** once a pause exists. The pause end is chosen as a date, as a period, or left open until someone resumes it. A paused subscription carries a **Paused** chip, and a scheduled pause shows as an alert on the subscription with the date it starts. The schedules of a paused subscription are read-only: no schedule can be added or edited while a pause is open. The subscription lists filter on the `PAUSED` status like any other. ## What the customer is billed | Moment | What happens | | :-------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------- | | Pause starting now, billed in advance | The part of the period already paid for is credited, from the pause start to the end of that period. Usage up to the pause start is still invoiced | | Pause starting at the next billing date | The current period is served and billed in full. Nothing needs crediting. The invoice on the pause date carries last period's usage only | | While paused | No invoices, no fees, no minimum-commitment top-ups, and usage is not priced. Invoices raised before the pause are collected as normal | | Resume | An in-advance invoice from the resume date to the next normal billing date, prorated. The credit given at the pause is never given back a second time | `realign_billing_dates` changes the last row. Left `false`, billing stays on its original calendar: a subscription billed on the 1st and resumed on 10 December is invoiced 10 December to 1 January, then on 1 January as usual. Set it to `true` and the billing date moves to the resume date, so the invoice runs 10 December to 10 January and every month on the 10th. It can be set when pausing, changed with a `PATCH`, or given on the resume call, and it only applies to `EXACT` billing: on `CALENDAR` billing it is refused. ## Webhooks A `PRICING_PLAN_SUBSCRIPTION` webhook fires on every step, so an external system can follow the whole sequence without polling: `PAUSE_SCHEDULED`, `PAUSE_UPDATED`, `PAUSED`, `RESUMED` and `PAUSE_DELETED`. Cancellation gained the matching set in the same release: `CANCEL_SCHEDULED`, `CANCEL_DELETED` and `CANCELLED`, where `CANCELLED` fires when the status actually becomes `CANCELLED`. Scheduled upgrades report `UPGRADE_SCHEDULED` and `UPGRADE_DELETED`. See [Webhooks](/platform-guides/for-developers/webhooks). Every pause action is written to the audit log with the user who made it. The transitions that run on a date are recorded as system actions. ## Edge cases * **Not during the initial term.** A pause cannot start before the initial term ends, so a pause never stretches a committed term. A subscription without an initial term has no such restriction. * **One at a time.** A subscription cannot be paused while a cancellation, an upgrade or another pause is open, and it cannot be cancelled while a pause is scheduled but has not started. Delete the scheduled pause first. * **Cancelling a paused subscription** is allowed, with cancel type `NOW` or `DATE`. * **No schedule may start after the pause.** A pause is refused when an active or draft schedule already starts at or after the pause start, and no schedule can be added after a pause has been scheduled. [Plan changes](/platform-guides/customers-and-billing/subscriptions/plan-changes) and upgrade quotes are blocked for the same reason. * **Trial schedules.** A pause cannot start inside a `TRIAL` schedule, because the resume would copy trial pricing into a normal schedule. * **Usage sent during a pause is ignored.** Events still arrive and are stored, but nothing is priced for the paused span. * **Coupons and discounts keep their dates.** A coupon that runs out during the pause is spent; it is not extended by the time the subscription stood still. * **Fees that grant wallet credits** are not prorated or refunded at the pause, and the full fee is charged again at the resume. * **Minimum commitments** apply in full to the shortened period before the pause, exactly as they do on a cancellation. * **Renewal.** A renewal that falls inside the pause does not run. On resume, the new schedule keeps the original end date when it is still in the future; otherwise it starts a fresh renewal term, or stays open-ended when auto-renewal is off. * **Copying a subscription** turns its `PAUSE` schedules into ordinary ones, so the copy is not born paused. * **Voiding** stays blocked while a subscription is paused. Cancel it first.