Offer Overview
Offers allow you to create price variations and payment method combinations for your products. Here are examples:
Product A (R$ 1,000.00)
- Offer 1: Price: R$ 1,000.00 (0% discount)
- Offer 2: Price: R$ 900.00 (10% discount)
Product B - Different Payment Methods
- Offer 1: Boleto, PIX, and Installment Boleto
- Offer 2: Installment Boleto and Smart Payment (financed credit card)
Each offer has its own payment options, determined by the payment_configurations associated with the offer. Certain fields in these configurations have restrictions, which can be found in the Payment Configurations section.
Offer Schema
| Field | Description | Type |
|---|---|---|
| id | Unique identifier (UUID) | String |
| name | The name of the offer | String |
| amount_cents | Offer price in cents | Integer |
| amount_currency | Currency code for the offer amount (e.g., BRL for Brazilian Real) | String |
| availability | Offer availability status. Can be enabled or disabled | String |
| url | Direct URL to access this offer’s checkout page | String |
| smart_payment_enabled | Whether smart payment (automatic payment method selection) is enabled for this offer | Boolean |
| checkout_type | Type of checkout flow. Can be default (standard checkout) or without_address (no address collection) | 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 |
| product | Product object containing product details | Object |
| payment_configurations | Array of payment configuration objects available for this offer | Array |
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 |