create_product
Create a product for the authenticated seller, specifying name, price in BRL, and payment options. Returns a product UUID for use in charge creation.
Instructions
Create a product for the authenticated seller. Returns the created product, whose UUID is the same identifier accepted by create_pix_charge / create_boleto_charge. value is in decimal BRL / reais (e.g. 29.90), NOT centavos. Setting pixAutomatic: true exposes Pix Automático (BACEN auto-debit recurring Pix) on the subscription checkout. Pass idempotencyKey to make a retry across process restarts safe — the backend returns the original product instead of creating a duplicate.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pix | No | Offer PIX at checkout. | |
| name | Yes | Product name (required). | |
| tags | No | Free-form tags. | |
| image | No | HTTPS URL of the product cover image. | |
| value | No | Price in decimal BRL / reais (e.g. R$29,90 → 29.90) — NOT centavos. Products store the price in reais, the same as the API and dashboard. | |
| boleto | No | Offer Boleto at checkout. | |
| returnUrl | No | URL the buyer returns to after a successful payment. | |
| unitLabel | No | Per-unit label shown on the checkout (e.g. 'seat'). | |
| creditCard | No | Offer credit card at checkout. | |
| description | No | Product description. | |
| installments | No | Max number of installments offered on credit card. | |
| pixAutomatic | No | When true, exposes Pix Automático (BACEN auto-debit recurring Pix) on the subscription checkout. Only the subscription checkout mode reads it. | |
| idempotencyKey | No | Idempotency key for safe retries. Defaults to a generated UUIDv4. | |
| isSubscription | No | Mark the product as a subscription (recurring). | |
| subscriptionType | No | Subscription cadence label (e.g. 'monthly'). | |
| returnUrlButtonText | No | Label for the return-URL button on the success page. |