Create a settlement
Creates the settlement for a completed billing period. The basis is
the metered usage cost for that period.
post
Body
application/json
Body
application/json
SettlementCreate
agent_idstringrequired
Example:agt_8f2c1a
usage_typestringrequired
Allowed values:standardburstreserved
Example:standard
billing_basis_usdnumber(float)required
Total metered usage cost for the billing period, before the chargeback rate is applied.
Example:6380
chargeback_rate_percentnumber(float)required
Example:12
period_end_datestring(date)required
Example:2026-08-31
cost_centerobject
Show Child Parameters
Response
application/json
Response
application/json
Created
Settlement
idstring
Example:stl_7c53
agent_idstring
Example:agt_8f2c1a
statusstring
Allowed values:draftopenpartially_paidpaidcanceled
Example:open
usage_typestring
Allowed values:standardburstreserved
Example:standard
billing_basis_usdnumber(float)
Example:6380
line_itemsarray[object]
Show Child Parameters
invoice_idstring
Example:inv_a920
due_datestring(date)
Example:2026-09-14
paid_usdnumber(float)
Example:0
created_atstring(date-time)
Example:2026-08-15T07:30:00Z
post/settlements
Authentication
Body
{
"agent_id": "agt_8f2c1a",
"usage_type": "standard",
"billing_basis_usd": 6380,
"chargeback_rate_percent": 12,
"period_end_date": "2026-08-31",
"cost_center": {
"name": "Customer Success",
"cost_center_id": "CC-4021",
"business_unit": "Support Engineering"
}
}
application/json
Retrieve a settlement
get
Path Parameters
settlementIdstringrequired
Example:stl_7c53
Response
application/json
Response
application/json
Settlement
Settlement
idstring
Example:stl_7c53
agent_idstring
Example:agt_8f2c1a
statusstring
Allowed values:draftopenpartially_paidpaidcanceled
Example:open
usage_typestring
Allowed values:standardburstreserved
Example:standard
billing_basis_usdnumber(float)
Example:6380
line_itemsarray[object]
Show Child Parameters
invoice_idstring
Example:inv_a920
due_datestring(date)
Example:2026-09-14
paid_usdnumber(float)
Example:0
created_atstring(date-time)
Example:2026-08-15T07:30:00Z
get/settlements/{settlementId}
Authentication
Path Parameters
application/json
Record a payment
Partial transfers are allowed; the status only moves to paid once the balance is settled in full.
post
Path Parameters
settlementIdstringrequired
Example:stl_7c53
Body
application/json
Body
application/json
amount_usdnumber(float)required
Example:826.85
value_datestring(date)required
Example:2026-09-10
referencestring
Example:XFER-2026-0418
Response
application/json
Response
application/json
Recorded
Settlement
idstring
Example:stl_7c53
agent_idstring
Example:agt_8f2c1a
statusstring
Allowed values:draftopenpartially_paidpaidcanceled
Example:open
usage_typestring
Allowed values:standardburstreserved
Example:standard
billing_basis_usdnumber(float)
Example:6380
line_itemsarray[object]
Show Child Parameters
invoice_idstring
Example:inv_a920
due_datestring(date)
Example:2026-09-14
paid_usdnumber(float)
Example:0
created_atstring(date-time)
Example:2026-08-15T07:30:00Z
post/settlements/{settlementId}/payments
Authentication
Path Parameters
Body
{
"amount_usd": 826.85,
"value_date": "2026-09-10"
}
application/json
Invoices
Download an invoice as PDF
get
Path Parameters
invoiceIdstringrequired
Example:inv_a920
Response
application/pdf
Response
application/pdf
PDF document
string
get/invoices/{invoiceId}/pdf
Authentication
Path Parameters
application/pdf