query · Module: Billing · Requires billing:read
Arguments
Returns
Payout!
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 Payout($id: ID!) {
payout(id: $id) {
id
object
status
livemode
created
updated
account
amount {
amount
currency
}
settlement
connection
arrival_date
}
}
{
"id": "po_1a2B3c"
}
{
"data": {
"payout": {
"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"
}
}
}
Retrieve a Payout
query Payout($id: ID!) {
payout(id: $id) {
id
object
status
livemode
created
updated
account
amount {
amount
currency
}
settlement
connection
arrival_date
}
}
{
"id": "po_1a2B3c"
}
{
"data": {
"payout": {
"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"
}
}
}
query · Module: Billing · Requires billing:read
| Argument | Type | Description |
|---|---|---|
id | ID! | The object’s ID. |
Payout!
| Field | Type |
|---|---|
id | String! |
object | PayoutObject! |
livemode | Boolean! |
created | Int! |
updated | Int |
account | String! |
amount | Money! |
settlement | String |
connection | String |
status | PayoutStatus! |
arrival_date | String |
user_metadata | UserMetadata |
carrier_metadata | CarrierMetadata |
system_metadata | SystemMetadata |
errors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
query Payout($id: ID!) {
payout(id: $id) {
id
object
status
livemode
created
updated
account
amount {
amount
currency
}
settlement
connection
arrival_date
}
}
{
"id": "po_1a2B3c"
}
{
"data": {
"payout": {
"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"
}
}
}