Skip to navigation
API ReferencePayments

List Bill Payments

Retrieve all payment records for a bill.

Amounts are returned in dollars (internal storage uses cents).

Authentication

x-api-keystring
API Key authentication via header

Path parameters

bill_idintegerRequired
Bill identifier

Response

List of payments for the bill
idinteger
Payment record identifier
amountdouble
Payment amount in dollars
statusstring
Payment status
paymentMethodenum
Payment method
billNumberinteger or nullOptional

Payment display number (when present)

paymentDatestring or nullOptionalformat: "date-time"

When the payment was recorded (ISO 8601); null if absent from upstream

paymentReferencestring or nullOptional
notesstring or nullOptional
isExternalboolean or nullOptional

Whether the payment originated from an external processor (e.g. Stripe)

createdAtstring or nullOptionalformat: "date-time"
updatedAtstring or nullOptionalformat: "date-time"
createdByobject or nullOptional

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error