Revenue Recovery

List the checkouts

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.

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

Path parameters

projectstring uuid required

The project, resolved by the route binder.

Query parameters

stalled'true' | 'false' | '1' | '0'

Keep only the checkouts the hourly sweep counted as stalled (true), or only the ones it never did (false). Omit for both.

recovered'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.

plan_idstring uuid nullable

Keep only the checkouts of one plan.

member_idstring uuid nullable

Keep only one member's checkouts, by their member id as the members endpoints list them.

pageinteger

The 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.

per_pageinteger

Rows per page, 1 to 100. A higher value clamps to the cap silently. Defaults to 25.

sort_bystring

The column to order by. Defaults to created_at; a column the endpoint does not offer falls back to the default rather than failing.

sort_direction'asc' | 'desc'

asc or desc. Defaults to desc.

limitinteger

Legacy alias of per_page, kept for clients that predate it. per_page wins when both are sent.

Response

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

Changes

No recorded changes to this operation across all 1 revision of this API.