---
title: "A plan hit its sales cap, or a pass series filled its last seat, and Subscriby paused it automatically."
method: POST
path: "plan.sold_out"
tags: ["plan.* events"]
---

# A plan hit its sales cap, or a pass series filled its last seat, and Subscriby paused it automatically.

`POST plan.sold_out` (webhook)

### When this fires

A plan carrying a **sales cap** records its last allowed successful purchase, or a `pass_series` plan with a **seat cap** seats its last holder. Subscriby switches the plan off on the spot, records the reason, and fires this event once. The plan disappears from the portal and the bot until the creator switches it back on; existing subscribers are untouched.

A `plan.deactivated` event fires alongside it, carrying the same `reason`, so automations that only watch availability still see the change. Subscribe to this event when you care specifically about "sold out": a waitlist, a restock reminder, a celebratory post.

> Switching the plan back on from the dashboard, the API (publish) or the `publish_plan` tool clears the reason and, for a sales cap, restarts the counter at zero, so the same cap sells another batch. Raising or clearing the cap while the plan is on sale also restarts the counter. A seat-capped series keeps its seats taken; raise the seat cap before publishing it again.

### Related events

- `plan.deactivated`: fires at the same moment with the same `reason`.
- `plan.activated`: the creator switching the plan back on.
- `pass_series.seats_exhausted`: the season-level view of a filled seat cap.

## Headers

- `SB-Signature` string, required
- `SB-Event-Id` string, required
- `SB-Event-Name` string, required
- `Content-Type` string, required
- `User-Agent` string, required

## Payload

- object: The envelope every event is delivered in.
  - `id` string, required: A ULID unique to the event, prefixed `evt_`. Every retry carries the same id, so it is the key to deduplicate on.
  - `type` 'plan.sold_out', required: The event name, always `plan.sold_out` here.
  - `created_at` string, date-time, required: When the event was emitted, server time, ISO 8601.
  - `api_version` string, required: The contract version of the payload shape, `2026-05-01` today. A breaking change to a shape ships under a new version.
  - `project_id` string, uuid, nullable, required: The project the event belongs to; null for team-scoped and billing events.
  - `data` object, required: The event-specific payload. Keys that do not apply to a given emission are omitted rather than sent as null, so check for presence.
    - `plan` object, required: Snapshot of the plan after the pause.
      - `id` string, uuid, required: Plan identifier.
      - `name` string, required: Display name.
      - `price` string, decimal, required: Decimal amount as a string, e.g. `"49.00"`.
      - `active` boolean, required: Always `false` for this event.
    - `plan_id` string, uuid, required: The plan, flat, for consumers that never read the snapshot.
    - `plan_name` string, required: The plan's name at the time of the pause.
    - `reason` 'sales_cap_reached' | 'seat_cap_reached', required: `sales_cap_reached` for a capped plan, `seat_cap_reached` for a season whose seats filled.
    - `sales_cap` integer, required: The cap that was hit: the plan's sales cap, or the series' seat cap.
    - `sales_cap_sold` integer, required: Purchases counted against that cap when it was hit.

## Acknowledgement `2XX`

Your endpoint acknowledged the delivery. Any 2xx status within 30 seconds marks it delivered; the response body is ignored.

## Other responses

- `default`: Any other status, a connection failure, or no answer within 30 seconds counts as a failed attempt. The delivery is retried 8 times, after 10 seconds, 30 seconds, 2 minutes, 10 minutes, 1 hour, 6 hours, 1 day, 3 days; the last failure dead-letters it, and it can be retried from the dashboard or `POST /v1/webhook-deliveries/{delivery}/retry`. After 20 consecutive failures the endpoint is paused until it is resumed.

---

[API](https://skmtc.dev/memberpass/apis/subscriby-rest-api.md) · [All operations](https://skmtc.dev/memberpass/apis/subscriby-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/memberpass/apis/subscriby-rest-api/revisions/59c4df91d764?raw)