mutation · Module: Network · Requires network:write
Arguments
Returns
Settlement!
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.
mutation CloseSettlement($id: ID!) {
closeSettlement(id: $id) {
id
object
status
livemode
created
updated
account
period {
from
to
}
currency
totals {
debits {
amount
currency
}
credits {
amount
currency
}
net {
amount
currency
}
}
statement
}
}
{
"id": "stl_1a2B3c"
}
{
"data": {
"closeSettlement": {
"id": "stl_1a2B3c",
"object": "settlement",
"status": "open",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"account": "acct_ada",
"period": {
"from": "2026-10-07",
"to": "2026-10-07"
},
"currency": "usd",
"totals": {
"debits": {
"amount": 1299,
"currency": "usd"
},
"credits": {
"amount": 1299,
"currency": "usd"
},
"net": {
"amount": 1299,
"currency": "usd"
}
},
"statement": "example"
}
}
}
Close a settlement
mutation CloseSettlement($id: ID!) {
closeSettlement(id: $id) {
id
object
status
livemode
created
updated
account
period {
from
to
}
currency
totals {
debits {
amount
currency
}
credits {
amount
currency
}
net {
amount
currency
}
}
statement
}
}
{
"id": "stl_1a2B3c"
}
{
"data": {
"closeSettlement": {
"id": "stl_1a2B3c",
"object": "settlement",
"status": "open",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"account": "acct_ada",
"period": {
"from": "2026-10-07",
"to": "2026-10-07"
},
"currency": "usd",
"totals": {
"debits": {
"amount": 1299,
"currency": "usd"
},
"credits": {
"amount": 1299,
"currency": "usd"
},
"net": {
"amount": 1299,
"currency": "usd"
}
},
"statement": "example"
}
}
}
mutation · Module: Network · Requires network:write
| Argument | Type | Description |
|---|---|---|
id | ID! | The object’s ID. |
Settlement!
| Field | Type |
|---|---|
id | String! |
object | SettlementObject! |
livemode | Boolean! |
created | Int! |
updated | Int |
account | String! |
period | SettlementPeriod! |
currency | String |
totals | SettlementTotals |
status | SettlementStatus! |
statement | 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.
mutation CloseSettlement($id: ID!) {
closeSettlement(id: $id) {
id
object
status
livemode
created
updated
account
period {
from
to
}
currency
totals {
debits {
amount
currency
}
credits {
amount
currency
}
net {
amount
currency
}
}
statement
}
}
{
"id": "stl_1a2B3c"
}
{
"data": {
"closeSettlement": {
"id": "stl_1a2B3c",
"object": "settlement",
"status": "open",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"account": "acct_ada",
"period": {
"from": "2026-10-07",
"to": "2026-10-07"
},
"currency": "usd",
"totals": {
"debits": {
"amount": 1299,
"currency": "usd"
},
"credits": {
"amount": 1299,
"currency": "usd"
},
"net": {
"amount": 1299,
"currency": "usd"
}
},
"statement": "example"
}
}
}