A Billing represents the complete payment plan for a customer’s order, including all bills and payments associated with that offer. It tracks the overall status of the payment plan from initiation through completion or cancellation.
Billing Schema
Field
Description
Type
id
Unique identifier (UUID)
String
order_id
Identifier of the order associated with this billing
String
amount_cents
Full amount of this billing in cents
Integer
amount_currency
Currency code for the billing amount (e.g., BRL for Brazilian Real)
String
due_day
Day of the month when the customer will be charged (1-31)
Integer
installments
Total number of bills that will be created for this billing
Integer
status
Billing status. Can be waiting_payment, active, finished, or canceled
String
origin_billing_id
Identifier of the original billing if this billing was created from a renegotiation or modification
String
cancelation_reason
Reason why the billing was canceled (only present when status is canceled)
String
finished_at
Timestamp when the billing was finished in ISO8601 format
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
payment_configuration
Payment configuration object associated with this billing
Object
bills
Array of bill objects representing each installment in this billing
Array
card
Card object if the billing is paid via credit card
Object
pix_subscription
PIX subscription object if the billing uses recurring PIX payments
Object
Billing Status Values
Status
Description
waiting_payment
The billing has been created and is waiting for the first bill to be paid
active
The billing is active - the first bill has been paid and recurring payments are in progress
finished
All bills in the billing have been paid successfully
canceled
The billing has been canceled and no further payments are expected
Cancelation Reason Values
Reason
Description
down_payment_not_paid
The billing was created but the customer did not pay the down payment (first bill)
refunded_by_company
The company initiated a refund for this billing
refunded_by_customer
The customer requested and received a chargeback or refund
customer_renegotiation
The billing was canceled due to a renegotiation with the customer
customer_dropout_with_fine
The billing was canceled due to customer dropout, but the customer still must pay a cancellation fee
customer_dropout
The billing was canceled due to customer dropout without any cancellation fee
company_ceasing_partnership
The billing was canceled because the company ceased partnership with the platform