An Order represents a sale transaction, linking an offer to a customer. It contains all customer information, the purchased offer details, and tracks the order status from creation through completion or cancellation.
Order Schema
Field
Description
Type
id
Unique identifier (UUID)
String
amount_cents
Total order amount in cents
Integer
status
Order status. Can be in_progress, finished, or canceled
String
cancelation_reason
Reason why the order was canceled (only present when status is canceled)
String
translated_cancelation_reason
Human-readable translated cancelation reason in Portuguese
String
customer_name
Full name of the customer who purchased the offer
String
customer_birthdate
Birthdate of the customer in ISO8601 format
String
customer_document
Customer’s CPF (individual) or CNPJ (business) document number
String
customer_type
Type of customer. Can be person (individual) or company (business)
String
checkout_type
Type of checkout flow. Can be default (standard) or without_address (simplified)
String
metadata
Additional custom metadata stored as key-value pairs
Object
url
Direct URL to access the order’s checkout page
String
finished_at
Timestamp when the order transitioned to finished status 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
offer
Offer object containing the purchased offer details
Object
offers
Array of offer objects for any order bump offers the customer added to this order. Empty array if no order bumps were selected
Array
address
Address object containing the customer’s address information
Object
billings
Array of billing objects associated with this order
Array
root_billing
The order’s original billing: the contract created when the purchase was made, preserving the values agreed at that moment. A renegotiation creates a new active billing, but root_billing keeps the original contract. Same structure as a billings entry, or null when the order has no original billing
Object
analyses
Array of analysis objects for fraud prevention and credit checks
Array
email
Contact object containing the customer’s email address
Object
phone
Contact object containing the customer’s phone number
Object
Order Status Values
Status
Description
in_progress
The order has been created and is awaiting payment or completion
finished
The order has been completed successfully and all required payments have been processed
canceled
The order has been canceled. Check cancelation_reason for details
Checkout Type Values
Value
Description
default
Standard checkout flow that collects customer address information
without_address
Simplified checkout flow that does not collect customer address information
Cancelation reasons
Field
Description
expired
The order was created but no charge were executed
analysis_denied
One or more analysis were not approved
analysis_failed
We could not analyse the current CPF
down_payment_not_paid
The order was charged but the customer did not pay the first bill
refunded_by_company
The company requested a refund for that order
refunded_by_customer
The customer requested a chargeback
customer_renegotiation
The order was canceled due a renegotiation with the customer
customer_dropout_with_fine
The order was canceled due a dropout, but the customer still have to pay a fine
customer_dropout
The order was canceled due a dropout without any fine