---
title: "List the checkouts"
method: GET
path: "/v1/projects/{project}/retention/checkouts"
tags: ["Revenue Recovery"]
---

# List the checkouts

`GET /v1/projects/{project}/retention/checkouts`

## Request

- Base URL: `https://api.subscriby.net`
- URL: `https://api.subscriby.net/v1/projects/{project}/retention/checkouts`
- Auth: HTTP bearer

```bash
curl "https://api.subscriby.net/v1/projects/7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13/retention/checkouts?stalled=true&recovered=false" \
  -H "Authorization: Bearer sbt_..."
```

Every checkout a member started, newest first: the member, the plan they were buying, the rail and where they started (`portal` or `bot`), the order reference the rail was given, when it started, when the hourly sweep counted it as stalled and when a charge finished it, summed up as `outcome`: `open` while nothing has settled and the sweep has not counted it, `stalled` once the project's checkout window passed with no settled charge, `recovered` when a charge settled after that, and `completed` when a charge settled before it could stall or the sweep closed it quietly for a member who already held a live membership. `enrollment_id` names the stalled-checkout sequence passage the stall opened. `stalled` and `recovered` (booleans; `recovered` reads among the stalled rows), `plan_id` and `member_id` narrow the page; `sort_by` takes `started_at`, `stalled_at` or `completed_at`.

> An access code redemption or a free trial start is not a checkout and never appears here. A member is counted as stalled at most once a day however many checkouts they started; the older open ones are stamped stalled without a second `checkout.stalled` or a second passage.

## Path parameters

- `project` string, uuid, required

## Query parameters

- `stalled` 'true' | 'false' | '1' | '0'
- `recovered` 'true' | 'false' | '1' | '0'
- `plan_id` string, uuid, nullable
- `member_id` string, uuid, nullable
- `page` integer
- `per_page` integer
- `sort_by` string
- `sort_direction` 'asc' | 'desc'
- `limit` integer

## Response `200`

The page of checkouts, newest first, each with its member and plan.

- object
  - `data` CheckoutAttemptResource[], required: The items on this page.
    - `id` string, required: The checkout's id.
    - `project_id` string, required: The project.
    - `member` object, nullable: The member who started the checkout, 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 they were buying, present when the relation is loaded; `null` when the plan is gone.
      - `id` string, required: The plan's id.
      - `name` string, required: The plan's name.
    - `provider` string, required: The rail the checkout opened on, as the payment methods list them; such as `stripe`.
    - `surface` string, required: Where the member started: `portal` or `bot`.
    - `reference` string, nullable, required: The order reference or session the rail was given, or `null` when the rail hands out none before the charge.
    - `method_id` string, nullable, required: The payment method the checkout opened on, or `null` for a rail with no row of its own.
    - `outcome` string, required: `open` while no charge has settled and the sweep has not counted it; `stalled` once the project's checkout window passed with no settled charge; `recovered` when a charge settled after it had stalled; `completed` when a charge settled before it could stall, or the sweep closed it quietly for a member who already held a live membership.
    - `started_at` string, required: When the member was handed the way to pay, ISO 8601.
    - `stalled_at` string, nullable, required: When the hourly sweep counted the checkout as stalled, ISO 8601; `null` until then.
    - `completed_at` string, nullable, required: When a charge finished the checkout, or the sweep closed it quietly, ISO 8601; `null` while it is open.
    - `payment_id` string, nullable, required: The payment that finished the checkout, or `null` while it is open or when it closed with no charge.
    - `enrollment_id` string, nullable, required: The stalled-checkout sequence passage the stall opened, or `null` when no sequence took the member.
  - `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)