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

# List the activity ledger

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

## Request

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

```bash
curl "https://api.subscriby.net/v1/projects/7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13/retention/activity?kind=payment_recovered" \
  -H "Authorization: Bearer sbt_..."
```

The ledger behind every figure: one row per notice, offer, feedback and win-back message, with the member, the kind, the channel that carried it, when it went out, and, once a charge settled after it, `converted_at` and the payment that counted it. `kind` keeps one kind of row; `sort_by` takes `created_at`, `sent_at` or `kind`.

> A row converts when the next charge settles for that member, which is how the figures count a recovery and a member won back; a notice that converts is not a notice that worked on its own, only one that preceded the payment.

## Path parameters

- `project` string, uuid, required

## Query parameters

- `kind` 'payment_failed_notice' | 'grace_reminder' | 'grace_final_warning' | 'access_suspended' | 'access_restored' | 'payment_recovered' | 'offer_shown' | 'offer_taken' | 'feedback' | 'sequence_step': What a row of the Revenue Recovery ledger records. The four ladder kinds are the notices a member receives about an unpaid renewal, in the order they can arrive; the ledger holds each at most once per failure, which is how a notice is never repeated. `AccessRestored` and `PaymentRecovered` close an episode: the first says the member was let back in, the second that money arrived, and a recovery during the grace window records only the second because nothing was taken away. The offer, feedback and sequence kinds are written by the cancellation screen and the win-back sequences; they are declared here from the first migration because the column's check constraint cannot be widened later.
- `page` integer
- `per_page` integer
- `sort_by` string
- `sort_direction` 'asc' | 'desc'
- `limit` integer

## Response `200`

The page of ledger rows, newest first, each with its member, coupon and step.

- object
  - `data` RetentionTouchResource[], required: The items on this page.
    - `id` string, required: The row's id.
    - `project_id` string, required: The project.
    - `subscription_id` string, nullable, required: The membership the row is about, or `null` for a win-back message to a member who holds none.
    - `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.
    - `kind` string, required: What happened: `payment_failed_notice`, `grace_reminder`, `grace_final_warning`, `access_suspended`, `access_restored`, `payment_recovered`, `offer_shown`, `offer_taken`, `feedback` or `sequence_step`.
    - `channel` string, nullable, required: What carried a notice: `chat` or `email`; `null` for a row that sent nothing.
    - `sent_at` string, required: When the row was written, ISO 8601.
    - `converted_at` string, nullable, required: When a charge settled after this row and counted it as converted, ISO 8601; `null` until then.
    - `payment_id` string, nullable, required: The payment that converted the row, or `null`.
    - `coupon` object, nullable: The coupon a win-back step carried, present when the relation is loaded; `null` without one.
      - `id` string, required: The coupon's id.
      - `code` string, required: The coupon's code.
    - `step` object, nullable: The sequence step behind a win-back message, present when the relation is loaded; `null` for every other kind.
      - `id` string, required: The step's id.
      - `sequence_id` string, required: The sequence it belongs to.
      - `position` integer, required: The step's place in the sequence.
    - `meta` unknown[], nullable, required: What else the row knows, by kind: the offer and the cancellation record for the cancellation rows, the sequence and the enrolment for a win-back message, the repair link for a notice; `null` when there is nothing more.
      - unknown
  - `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)