query · Module: Billing · Requires billing:read
Arguments
Returns
PayoutList!
Errors
Errors are returned inerrors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
query Payouts($limit: Int) {
payouts(limit: $limit) {
data {
id
object
status
livemode
created
updated
account
amount {
amount
currency
}
settlement
connection
arrival_date
}
has_more
}
}
{
"limit": 10
}
{
"data": {
"payouts": {
"data": [
{
"id": "po_1a2B3c",
"object": "payout",
"status": "pending",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"account": "acct_ada",
"amount": {
"amount": 1299,
"currency": "usd"
},
"settlement": "example",
"connection": "conn_9f8e",
"arrival_date": "example"
}
],
"has_more": true
}
}
}
List payouts
query Payouts($limit: Int) {
payouts(limit: $limit) {
data {
id
object
status
livemode
created
updated
account
amount {
amount
currency
}
settlement
connection
arrival_date
}
has_more
}
}
{
"limit": 10
}
{
"data": {
"payouts": {
"data": [
{
"id": "po_1a2B3c",
"object": "payout",
"status": "pending",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"account": "acct_ada",
"amount": {
"amount": 1299,
"currency": "usd"
},
"settlement": "example",
"connection": "conn_9f8e",
"arrival_date": "example"
}
],
"has_more": true
}
}
}
query · Module: Billing · Requires billing:read
| Argument | Type | Description |
|---|---|---|
account | String | Filter by account. |
status | String | Filter by status. |
settlement | String | Filter by settlement. |
createdGte | Int | Filter by created gte. |
createdLte | Int | Filter by created lte. |
limit | Int | Page size, 1–100 (default 10). |
startingAfter | ID | Cursor: return objects after this ID. |
endingBefore | ID | Cursor: return objects before this ID. |
PayoutList!
| Field | Type |
|---|---|
data | [Payout!]! |
has_more | Boolean |
errors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
query Payouts($limit: Int) {
payouts(limit: $limit) {
data {
id
object
status
livemode
created
updated
account
amount {
amount
currency
}
settlement
connection
arrival_date
}
has_more
}
}
{
"limit": 10
}
{
"data": {
"payouts": {
"data": [
{
"id": "po_1a2B3c",
"object": "payout",
"status": "pending",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"account": "acct_ada",
"amount": {
"amount": 1299,
"currency": "usd"
},
"settlement": "example",
"connection": "conn_9f8e",
"arrival_date": "example"
}
],
"has_more": true
}
}
}