A Bill represents an installment that the customer must pay. If an order was purchased in 12 installments, the customer will have 12 bills to pay. Each bill tracks the payment status, amounts, and relevant dates for a single installment.
Bill Schema
Field
Description
Type
id
Unique identifier (UUID)
String
status
Bill payment status. Can be pending, paid, or canceled
String
due_date
Original due date for this bill in ISO8601 format
String
amount_cents
Current bill amount in cents (may include interest and penalties if overdue)
Integer
current_amount_cents
Current amount due in cents, calculated including late fees and interest if applicable
Integer
original_amount_cents
Original bill amount in cents before any penalties or adjustments
Integer
metadata
Additional metadata associated with the bill
Object
bill_type
Type of bill. Can be down_payment (initial payment) or installment (recurring payment)
String
paid_at
Timestamp when the bill was paid in ISO8601 format
String
authentication_code
Unique authentication code generated when the bill is paid
String
checkout_url
URL to access the checkout page for paying this bill
String
effective_due_date
Effective due date for this bill, which may differ from the original due_date
String
disable_penalties_until
Date until which late payment penalties are disabled for this bill
String
created_at
Indicates when the record was created in ISO8601 format
String
updated_at
Indicates when the record was last updated in ISO8601 format
String
billing
Billing object containing the billing plan information
Object
payments
Array of payment objects associated with this bill
Array
bill_details
Array of bill detail objects containing itemized information about charges
Array
Bill Status Values
Status
Description
pending
The bill is awaiting payment and has not yet been paid or canceled
paid
The bill has been successfully paid. When paid, paid_at and authentication_code are set
canceled
The bill has been canceled and is no longer due for payment. When canceled, canceled_at is set
Bill Type Values
Type
Description
down_payment
The initial payment (first installment) in a financed purchase
installment
A recurring payment in a multi-installment purchase plan, excluding the down payment
Bill Details
The bill_details array contains the breakdown of the bill amount. Each detail has a detail_type that indicates what kind of charge or adjustment it represents.
Detail Types
Value
Description
amortization
The principal amount being paid in this installment