GET
/v1/paymentsList payments
Returns a paginated list of payments ordered newest first. Use `starting_after` with the last returned `id` to fetch the next page.
operationId: payments_listAuthentication and behavior
Bearer authentication
Path, query, and header parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
limit | query | number | No | Max items per page (1–100, default 20). |
starting_after | query | string | No | Payment `id` to start after (exclusive cursor). Use the last `id` from the previous page. |
JSON request body
No JSON request body is required.
Responses
200Successful response4XXErrorSchema preview
{}{
"path": "/v1/payments",
"method": "GET",
"tags": [
"Payments"
],
"summary": "List payments",
"description": "Returns a paginated list of payments ordered newest first. Use `starting_after` with the last returned `id` to fetch the next page.",
"operationId": "payments_list",
"responses": {
"200": {
"description": "Successful response"
},
"4XX": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "number"
},
"description": "Max items per page (1–100, default 20)."
},
{
"name": "starting_after",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"description": "Payment `id` to start after (exclusive cursor). Use the last `id` from the previous page."
}
]
}