List all payments

Only payments with this status.

Only payments with this reference.

Search text. Matches the payment_id, the reference or the customer's email exactly, or part of the customer's name or company name.

How many items to return on one page, from 1 to 100. The default is 100. A value outside 1 to 100, or one that is not a whole number, is a 400.

For cursor-based lists, return the items after the item with this id. Use next_page_after_item (or follow next_page_url) from the page you have. You cannot send it together with before_item (400). An id that does not exist is a 404.

For cursor-based lists, return the items before the item with this id. Use previous_page_before_item (or follow previous_page_url) from the page you have. You cannot send it together with after_item (400). An id that does not exist is a 404.

Sort in descending order (newest, largest or last first) when true. The default is false. A value other than true or false is a 400.

Only items on or after this date. Send ISO 8601 (2026-11-01T00:00:00Z or 2026-11-01T00:00:00-05:00) or a shorthand: 2026 means the start of 2026, 2026-11 the start of November, 2026-11-01 the start of that day. A date with no offset is read in timezone, or in the account's time zone when you send none. It must not be after date_end (400).

Only items on or before this date. Same formats as date_start, but a shorthand means the end of the period: 2026-11 is the last instant of November, 2026-11-30 the last instant of that day. A date with no offset is read in timezone, or in the account's time zone when you send none.

Which date date_start and date_end filter on. The default is date_created. Each list names the values it supports. A value that is not one of the values below is a 400.

An IANA time zone name, such as America/New_York or UTC. It sets how date_start and date_end are read and the time zone of every date in the response. The default is the account's time zone (Settings, Technical), or UTC when it has none. A name that is not known is a 400.

Comma-separated child objects to return in full instead of as a URL, for example customer,payments. Use dot notation for nested objects (items.product), up to four levels deep. A single object takes up to 12 paths; a list takes up to 2, applied to every item. Extra paths are dropped without an error. See Expanding objects.

Comma-separated fields to return; all others are left out. Use dot notation for child fields (customer.email). You cannot send show and hide together (400). See Customizing output.

Comma-separated fields to leave out of the response. Use dot notation for child fields (customer.email). You cannot send show and hide together (400). See Customizing output.

When true, the object also has a formatted child with amounts and dates as display text in the shopper's language and currency (for example $19.99 or November 7, 2026). The default is false. See Localized formatting.