Billing overview
Billing is a representation of the customer bills and payments related to that offer.
Billing schema
Field | Description | Type |
---|
id | Unique identifier (UUID) | String |
amount_cents | Full amount of that billing in cents | Integer |
due_day | Day that the customer will be charged monthly | Integer |
installments | Total of bills that will be created | Integer |
status | Billing status, waiting_payment , active , finished , canceled . A billing is active when the first bill is paid, finished when all bills are paid | String |
cancelation_reason | Description of why that billing is canceled | String |
finished_at | Timestamp of when that billing was finished | String |
payment_configuration | Payment Configuration associated with that billing | Object |
bills | Array of bills from that billing | Array |
created_at | Indicates when the record was created in iso8601 | String |
updated_at | Indicates when the record was last updated in iso8601 | String |
Cancelation reasons
Field | Description |
---|
down_payment_not_paid | The billing was charged but the customer did not pay the first bill |
refunded_by_company | The company requested a refund for that billing |
refunded_by_customer | The customer requested a chargeback |
customer_renegotiation | The billing was canceled due a renegotiation with the customer |
customer_dropout_with_fine | The billing was canceled due a dropout, but the customer still have to pay a fine |
customer_dropout | The billing was canceled due a dropout without any fine |