update_product
Partially update a product's fields (name, price, payment methods, subscription settings) by sending only the values to change; unspecified fields remain unchanged.
Instructions
Update an existing product (partial PATCH — only the fields you provide are written; everything else keeps its persisted value). 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. At least one write field is required.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pix | No | Offer PIX at checkout. | |
| name | No | Product name. | |
| 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. | |
| productId | Yes | Product identifier — accepts the UUID (preferred — same id returned by list_products and webhook payloads) or the legacy positive integer id. UUID support added in Garu v0.10.0. | |
| 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. | |
| 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. |