---
title: "List transactions"
method: GET
path: "/v1/analytics/transactions"
tags: ["Analytics"]
---

# List transactions

`GET /v1/analytics/transactions`

## Request

- Base URL: `https://api.subscriby.net`
- URL: `https://api.subscriby.net/v1/analytics/transactions`
- Auth: HTTP bearer

A keyset-paginated list of payments for one project. `project_id` is **required**.

```bash
curl "https://api.subscriby.net/v1/analytics/transactions?project_id=$PROJECT_ID&limit=100" \
  -H "Authorization: Bearer $SUBSCRIBY_TOKEN"
```

Every row carries its owning project, plan and subscriber, so a payment can be attributed without a follow-up lookup. Follow `meta.next_cursor` on the next call to paginate. A `null` or missing cursor means the end of the range has been reached.

## Query parameters

- `project_id` string, uuid, required
- `period` string
- `from` string, date
- `to` string, date
- `statuses[]` string[]
- `provider_ids[]` string[]
- `plan_ids[]` string[]
- `currency_ids[]` string[]
- `cursor` string
- `limit` integer

## Response `200`

One keyset page of transactions.

- object
  - `data` object[], required: The items.
    - `id` string, required: The payment's id.
    - `subscription_id` string, required: The subscription the payment belongs to.
    - `project_id` string, required: The owning project.
    - `project_name` string, required: The owning project's name.
    - `plan_id` string, required: The plan the subscription is on.
    - `plan_name` string, required: That plan's name.
    - `subscriber_id` string, nullable, required: The member; `null` while the subscription has not been claimed by a member yet.
    - `subscriber_name` string, nullable, required: The member's display name; `null` while the subscription has not been claimed.
    - `status` string, required: `successful`, `failed`, `pending` or `refunded`.
    - `amount` string, required: The charged amount as a decimal string, in `currency`.
    - `currency` string, required: The charge's ISO 4217 currency code.
    - `provider` string, nullable, required: The payment provider's key.
    - `provider_label` 'Stripe' | 'PayPal' | 'Skrill' | 'CoinPayments' | 'Paystack' | 'Razorpay' | 'CeyPay' | 'Platform Currency' | 'Access Codes' | 'null', nullable, required: The payment provider's display name.
    - `method_id` string, required: The project payment method the charge went through.
    - `calculated_fee` string, required: The provider fee attributed to the payment, as a decimal string.
    - `billing_reason` string, nullable, required: Why the charge happened, such as `subscription_cycle` for a renewal.
    - `external_payment_id` string, nullable, required: The provider's own id for the charge.
    - `occurred_at` string, required: When the payment settled, ISO 8601.
  - `meta` object, required: The page's cursor and the window and project it was cut from.
    - `count` integer, required: How many rows this page holds.
    - `limit` integer, required: The page size that was applied.
    - `next_cursor` string, required: The opaque cursor for the next page; `null` when this page is the last.
    - `range` object, required: The window the preset resolved to.
      - `from` string, required: The first day of the window, `YYYY-MM-DD`.
      - `to` string, required: The last day of the window, `YYYY-MM-DD`.
    - `project_id` string, required: The project the rows belong to, as requested.

## 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.
- `422`: `VALIDATION_FAILED`: when `project_id` is missing or not a UUID.
- `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)