Sign in

v1

latestOpenAPI 3.1.02026-07-24104338.0 KB
Payments

List payments

Returns payments across all your subscriptions, newest first. Use the filters to scope to a single subscription, restrict by status, or restrict to a createdAt window.

get/api/v3/subscriptions/payments

Query parameters

subscriptionIdstring uuid

Restrict to one subscription.

statusPaymentStatus[]

Repeatable. Limits the result to payments in any of the given statuses.

createdFrominteger

Inclusive lower bound on createdAt, Unix epoch seconds.

createdTointeger

Exclusive upper bound on createdAt, Unix epoch seconds.

pageSizeinteger

Maximum items per page. Defaults to 20, capped at 100.

cursorstring

Response

Payments matching the filter.

nextCursorstring

Opaque cursor for the next page. Present only when hasMore is true.

hasMoreboolean required

Example response

{
  "items": [
    {
      "billedAmount": {
        "amount": "29.00",
        "asset": "USD"
      },
      "paidAmount": {
        "amount": "29.00",
        "asset": "USD"
      },
      "paidAt": 1748513400,
      "createdAt": 1748513400
    }
  ]
}