--- title: "List the cancellation screens" method: GET path: "/v1/projects/{project}/retention/cancellations" tags: ["Revenue Recovery"] --- # List the cancellation screens `GET /v1/projects/{project}/retention/cancellations` ## Request - Base URL: `https://api.subscriby.net` - URL: `https://api.subscriby.net/v1/projects/{project}/retention/cancellations` - Auth: HTTP bearer ```bash curl "https://api.subscriby.net/v1/projects/7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13/retention/cancellations?reason=too_expensive&per_page=25" \ -H "Authorization: Bearer sbt_..." ``` Every cancellation screen a member reached, newest first: the member, the plan, the reason they picked, their own words, the offer shown and whether they took it, where they answered, and the pause's dates where they took one. `reason` and `surface` narrow the page; `sort_by` takes `created_at`, `reason`, `surface` or `offer_taken`. ## Path parameters - `project` string, uuid, required ## Query parameters - `reason` 'too_expensive' | 'not_using_enough' | 'not_enough_content' | 'content_not_expected' | 'found_another_community' | 'not_the_right_fit' | 'taking_a_break' | 'got_what_i_needed' | 'technical_problems' | 'signed_up_by_mistake' | 'other': Why a member said they were cancelling. A fixed list rather than a free field, because a creator reads the breakdown on the dashboard and a free answer cannot be counted; the optional sentence a member adds travels beside the case. The same ten reasons and "Other" show on the portal and in a connector's bot, in the member's own language, and the backing values are what the webhook and the API carry; each stays short enough to ride in a bot's callback data beside the action that carries it. - `surface` 'portal' | 'bot': Where a member answered the cancellation screen. Recorded so the creator can tell whether members leave from the portal or from a connector's bot, and so a bot's answer, which has no free text, is read for what it is. - `page` integer - `per_page` integer - `sort_by` string - `sort_direction` 'asc' | 'desc' - `limit` integer ## Response `200` The page of cancellation screens, newest first, each with its member and plan. - object - `data` CancellationRecordResource[], required: The items on this page. - `id` string, required: The record's id. - `project_id` string, required: The project. - `subscription_id` string, nullable, required: The membership the member was cancelling. - `member` object, nullable: The member, present when the relation is loaded. - `id` string, required: The member's project-scoped id. - `name` string, required: The member's display name. - `plan` object, nullable: The plan the membership was on, present when the relation is loaded; `null` when the membership is gone. - `id` string, required: The plan's id. - `name` string, required: The plan's name. - `reason` string, nullable, required: The reason the member picked, or `null` when the project asked none. - `feedback` string, nullable, required: The sentence the member added, or `null`. - `offer_shown` string, nullable, required: The offer the screen made: `pause`, `discount` or `return_coupon`; `null` when it made none. - `offer_taken` string, nullable, required: The offer the member took, or `null`. - `surface` string, required: Where the member answered: `portal` or `bot`. - `offer_resumes_at` string, nullable, required: When a pause the member took ends, ISO 8601; `null` otherwise. - `offer_resumed_at` string, nullable, required: When that pause ended and the member was let back in, ISO 8601; `null` until then. - `created_at` string, nullable, required: When the record was made, ISO 8601. - `links` object, required: Links to the first, last, previous and next pages. - `first` string, nullable, required: The first page's URL. - `last` string, nullable, required: The last page's URL. - `prev` string, nullable, required: The previous page's URL; null on the first page. - `next` string, nullable, required: The next page's URL; null on the last page. - `meta` object, required: The paging counters for this page. - `current_page` integer, required: The page returned, 1-indexed. - `from` integer, nullable, required: The 1-indexed position of this page's first item across every page; null when the page is empty. - `last_page` integer, required: How many pages there are. - `links` object[], required: Generated paginator links. - `url` string, nullable, required: The page's URL; null for the ellipsis and the disabled arrows. - `label` string, required: The link's label: a page number, the previous or next arrow, or an ellipsis. - `active` boolean, required: Whether this link is the current page. - `path` string, nullable, required: Base path for paginator generated URLs. - `per_page` integer, required: Number of items shown per page. - `to` integer, nullable, required: Number of the last item in the slice. - `total` integer, required: Total number of items being paginated. ## Other responses - `401`: `AUTHENTICATION_REQUIRED`: the request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an `sbt_test_` token on production). - `403`: `TOKEN_MISSING_ABILITY`: the token is valid but does not carry the ability this endpoint requires; `error.context.required_ability` names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers `FORBIDDEN`, `TEAM_TIER_REQUIRED` or `CONNECTOR_TIER_REQUIRED` with the same status, and says so in its own description. - `404`: `RESOURCE_NOT_FOUND`: an id in the path names nothing the token can see. `TENANT_MISMATCH`: the project sits outside the token's `scope:project:` allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred. - `422`: `VALIDATION_FAILED`: the payload broke a rule, and `error.fields` maps each offending key to its messages. A refusal from the domain, such as a plan that cannot go on sale or a member who cannot be removed, uses the same code with `error.message` saying why and no `fields`. - `429`: `RATE_LIMITED`: the token has spent its 300 requests a minute or 10,000 an hour; `Retry-After` says when the next one is accepted. --- [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)