Sign in

v1

latestOpenAPI 3.0.3Proprietaryraw.githubusercontent.com2026-03-067260437.0 KB
Payments

List payments

Retrieve a paginated list of payments with powerful filtering capabilities.

gigstack Connect: Access other teams' payments using the team parameter.

Filtering Options:

  • Filter by payment status, currency, amount
  • Filter by client ID, email, tax ID (RFC), or name
  • Filter by metadata fields using dot or underscore notation (e.g., metadata.order_id or metadata_order_id)
  • Filter by creation date using comparison operators
get/payments

Query parameters

teamstring

gigstack Connect: Target team ID for multi-team access.

Requires gigstack Connect enabled on your team and shared billing account.

Example: ?team=team_xyz789

limitinteger

Maximum number of items to return (default 50, max 100)

nextstring nullable

Pagination cursor for the next page of results

order_by'name' | 'timestamp'

Field name to order results by

sort'asc' | 'desc'

Sort direction for list queries

Sort direction for the results

integer
OR
string date

Filter results created on or after this timestamp. Accepts Unix timestamp in seconds (e.g., 1733011200), milliseconds (e.g., 1733011200000), or ISO 8601 date string (e.g., 2024-12-01).

integer
OR
string date

Filter results created on or before this timestamp. Accepts Unix timestamp in seconds (e.g., 1735689599), milliseconds (e.g., 1735689599000), or ISO 8601 date string (e.g., 2024-12-31).

status'requires_payment_method' | 'succeeded' | 'canceled'

Filter payments by status

currencystring

Filter payments by currency code (e.g., MXN, USD)

amountnumber

Filter payments by amount

client_idstring

Filter payments by client ID

emailstring

Filter payments by client email address

tax_idstring

Filter payments by client tax ID (RFC)

client_namestring

Filter payments by client name

metadata.{key}string

Filter by any metadata field using dot notation (e.g., metadata.order_id=ORD-123) or underscore notation (e.g., metadata_order_id=ORD-123). Both formats are supported and equivalent.

Response

Payments retrieved successfully

messagestring required
dataobject[] required
nextstring nullable

Cursor for next page

has_moreboolean required
total_resultsnumber required

Example response

{
  "message": "Items retrieved successfully",
  "next": "eyJjcmVhdGVkX2F0IjoxNjc3NjUxMjM0fQ==",
  "has_more": true,
  "total_results": 150
}