Skip to content

List invoice settlements

GET
/v1/invoices/{invoice_id}/settlements

List all settlements for an invoice.

invoice_id
required
Invoice Id
string format: uuid

Successful Response

Response List Invoice Settlements V1 Invoices Invoice Id Settlements Get
Array<object>
InvoiceSettlementResponse

Schema for invoice settlement response.

object
id
required
Id
string format: uuid
invoice_id
required
Invoice Id
string format: uuid
settlement_type
required
Settlement Type
string
source_id
required
Source Id
string format: uuid
amount_cents
required
Amount Cents
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
created_at
required
Created At
string format: date-time

Unauthorized – invalid or missing API key

Invoice not found

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object