List the checkouts
/v1/projects/{project}/retention/checkouts in the Revenue Recovery API.
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.stalledor a second passage.
Requires ability
The token must hold this ability, or the call is refused with 403.
MCP tool
Runs the same action from an agent, behind the same ability.
Authorization
bearerToken A personal access token minted on the dashboard under Settings, then Tokens, sent as Authorization: Bearer sbt_live_…. The token carries the abilities each endpoint lists under Requires ability and is frozen to one team.
In: header
Path Parameters
The project, resolved by the route binder.
uuidQuery Parameters
Keep only the checkouts the hourly sweep counted as stalled (true), or only the ones it never did (false). Omit for both.
Value in
- "true"
- "false"
- "1"
- "0"
Keep only the stalled checkouts a charge finished after all (true), or only the stalled ones still open (false). Omit for both.
Value in
- "true"
- "false"
- "1"
- "0"
Keep only the checkouts of one plan.
uuidKeep only one member's checkouts, by their member id as the members endpoints list them.
uuidThe 1-based page to return. A page past the last answers an empty data array with meta.total still filled, so a loop can stop without guessing.
1 <= value1Rows per page, 1 to 100. A higher value clamps to the cap silently. Defaults to 25.
1 <= value <= 10025The column to order by. Defaults to created_at; a column the endpoint does not offer falls back to the default rather than failing.
"created_at"asc or desc. Defaults to desc.
"desc"Value in
- "asc"
- "desc"
Legacy alias of per_page, kept for clients that predate it. per_page wins when both are sent.
1 <= value <= 100Responses
200OKapplication/json
The page of checkouts, newest first, each with its member and plan.
401UnauthorizedAUTHENTICATION_REQUIREDapplication/json
The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an sbt_test_ token on production).
403ForbiddenTOKEN_MISSING_ABILITYapplication/json
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.
404Not foundRESOURCE_NOT_FOUNDapplication/json
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.
422Validation failedVALIDATION_FAILEDapplication/json
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.
429Too many requestsRATE_LIMITEDapplication/json
The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.
How is this guide?
Last updated on