Skip to main content
GET
List Payments

Authorizations

Authorization
string
header
required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-09-02-1"

Query Parameters

account_id
string

Only payments charged by this account, prefixed biz_.

status
enum<string>

Only payments in this lifecycle state.

Available options:
open,
authorized,
paid,
pending,
uncollectible,
unresolved,
void
billing_reason
enum<string>

Only payments charged for this reason.

Available options:
subscription_create,
subscription_cycle,
subscription_update,
one_time,
manual,
subscription
currency
string

Only payments presented in this three-letter currency, such as usd.

user_id
string

Only payments made by this buyer, prefixed user_.

query
string

Search payments by user ID, membership ID, user email, name, or username. Email filtering requires the member:email:read permission.

member_id
string

Only payments made by this member, prefixed mber_.

membership_id
string

Only payments billed under this membership, prefixed mem_.

product_id
string

Only payments for this product, prefixed prod_.

plan_id
string

Only payments priced by this plan, prefixed plan_.

created_before
string<date-time>

Only payments created before this ISO 8601 timestamp.

created_after
string<date-time>

Only payments created after this ISO 8601 timestamp.

order
enum<string>

The field to sort by.

Available options:
created_at,
paid_at
direction
enum<string>

The sort direction.

Available options:
asc,
desc
first
integer

The number of payments to return.

after
string

A cursor; returns payments after this position.

last
integer

The number of payments to return from the end of the range.

before
string

A cursor; returns payments before this position.

Response

payments listed

data
object[]
required
page_info
object
required