> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.recurrente.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.recurrente.com/_mcp/server. # Crear un producto POST https://app.recurrente.com/api/products Content-Type: application/json Crea un nuevo producto. Puede ser de pago único o de suscripción. Cada producto puede tener máximo 1 precio. Reference: https://docs.recurrente.com/referencia-api/api-reference/products/create-product ## Authentication - `X-SECRET-KEY` header (required) — Tu clave secreta de API. Una llave de cuenta (`sk_live_...`, `sk_test_...`) opera sobre su propia cuenta y, con `X-ACCOUNT-ID`, sobre sus cuentas conectadas. La llave también fija el ambiente: una `sk_test_` solo lista y resuelve objetos de prueba (`live_mode: false`) y una `sk_live_` solo objetos reales. Un ID del otro ambiente responde `404` (`401` en `/customers`). Una llave de organización (`sk_org_live_...`, `sk_org_test_...`) alcanza todas las cuentas de una organización y solo sirve para leer: saldos, movimientos y reportes. Para operar sobre una cuenta debe nombrarla con `X-ACCOUNT-ID`; omitirlo en una lectura devuelve todas las cuentas de la organización. Cualquier otro endpoint responde `403` con `code: organization_key_unsupported`. ## Request ### Body (application/json) This endpoint expects an object. - `product` (ProductsPostRequestBodyContentApplicationJsonSchemaProduct, required) ## Response ### 201 Producto creado exitosamente - `id` (string, optional) — ID único del producto - `status` (string, optional) — Estado del producto - `tax_category` (enum, optional, default: good) — Clasificación para FEL: good (bien) o service (servicio). Cada ítem conserva su clasificación en facturas mixtas. El comercio también puede elegirla en el panel, en Opciones avanzadas del producto. - Allowed values: `good`, `service` - `name` (string, optional) — Nombre del producto - `description` (string, optional, nullable) — Descripción del producto - `success_url` (string, optional, nullable) — URL de redirección después de un pago exitoso - `cancel_url` (string, optional, nullable) — URL de redirección cuando el comprador cancela - `custom_terms_and_conditions` (string, optional, nullable) — Términos y condiciones personalizados - `phone_requirement` (enum, optional, default: optional) — Requerimiento de teléfono - Allowed values: `none`, `optional`, `required` - `address_requirement` (enum, optional, default: none) — Requerimiento de dirección - Allowed values: `none`, `optional`, `required` - `billing_info_requirement` (enum, optional, default: optional) — Requerimiento de información fiscal - Allowed values: `none`, `optional`, `required` - `has_dynamic_pricing` (boolean, optional) — Si usa precio dinámico - `payment_method_types` (list of enum, optional) — Métodos de pago habilitados para este producto, ya resueltos (cuando el producto hereda la configuración de la cuenta, refleja los métodos de la cuenta): `card` (tarjeta, pago de contado), `bank_transfer` (transferencia bancaria), `stablecoins` (dólares digitales), `balance` (Balance Recurrente), `akisi` (efectivo en Akisí; solo cuentas habilitadas, cobros únicos en GTQ con precio fijo y cuentas fuera de Sandbox). Las cuotas se exponen por separado en `available_installments`. - Allowed values: `card`, `bank_transfer`, `stablecoins`, `balance`, `akisi` - `available_installments` (list of integer, optional) — Opciones de cuotas (en meses) que se mostrarán en el checkout, independientes de `payment_method_types`. Vacío si no se ofrecen cuotas. Solo aplica a GTQ. - `inventory_quantity` (integer, optional, nullable) — Unidades en existencia. `null` cuando el producto no lleva inventario (disponibilidad ilimitada). Baja con cada venta pagada y puede quedar en negativo si se vendió más de lo que había. Enviarlo en un `PUT` registra la diferencia como un ajuste en el historial del producto. Un producto con variantes no lleva conteo propio: cada variante lleva el suyo y el del producto queda en `null`. - `low_stock_threshold` (integer, optional, nullable) — Desde qué cantidad se considera bajo el inventario de este producto. `null` usa el valor por defecto de la cuenta. - `prices` (list of Price, optional) — Precios del producto - `storefront_link` (string, optional) — Link público del producto en la tienda - `metadata` (map from string to string, optional, nullable) — Metadata personalizada - `custom_fields` (list of CheckoutCustomFieldDefinition, optional) — Definiciones de campos personalizados activos en el checkout. - `options` (list of ProductOption, optional) — Las opciones en que viene el producto (talla, color…), en orden. Vacío si el producto no tiene variantes. - `variants` (list of ProductVariant, optional) — Las variantes activas del producto, una por combinación de valores. Cada una tiene su propio `price_id`: úsalo en `items[].price_id` al crear un checkout para vender esa variante. ## Errors ### 400 Bad Request Error Error de validación - `message` (string, optional) — Mensaje de error - `code` (string, optional) — Código estable legible por máquinas, cuando aplica - `refund_id` (string, optional) — ID del reembolso relacionado cuando aplica - `endpoint` (string, optional) — Acción de API rechazada, cuando aplica - `errors` (ErrorErrors, optional) — Detalles de errores por campo ## Types ### ProductsPostRequestBodyContentApplicationJsonSchemaProduct - `name` (string, required) — Nombre del producto - `prices_attributes` (list of ProductsPostRequestBodyContentApplicationJsonSchemaProductPricesAttributesItems, required) — Precios del producto (máximo 1) - `tax_category` (enum, optional, default: good) — Clasificación para FEL: good (bien) o service (servicio). Cada ítem conserva su clasificación en facturas mixtas. El comercio también puede elegirla en el panel, en Opciones avanzadas del producto. - Allowed values: `good`, `service` - `description` (string, optional) — (Opcional) Descripción del producto - `image_url` (string, optional) — (Opcional) URL de la imagen del producto - `success_url` (string, optional) — (Opcional) URL de redirección después de un pago exitoso - `cancel_url` (string, optional) — (Opcional) URL de redirección cuando el comprador cancela - `custom_terms_and_conditions` (string, optional) — (Opcional) Términos y condiciones personalizados - `phone_requirement` (enum, optional, default: optional) — (Opcional) Requerimiento de teléfono - Allowed values: `none`, `optional`, `required` - `address_requirement` (enum, optional, default: none) — (Opcional) Requerimiento de dirección - Allowed values: `none`, `optional`, `required` - `billing_info_requirement` (enum, optional, default: optional) — (Opcional) Requerimiento de información fiscal (NIT) - Allowed values: `none`, `optional`, `required` - `adjustable_quantity` (boolean, optional) — (Opcional) Permitir al comprador ajustar la cantidad - `inventory_quantity` (integer, optional, nullable) — (Opcional) Unidades en existencia. Cada venta pagada lo decrementa; `null` deja de llevar inventario. Al actualizarlo, la diferencia queda registrada como un ajuste en el historial del producto. Un producto con variantes no lleva conteo propio: cada variante lleva el suyo y el del producto queda en `null`. - `low_stock_threshold` (integer, optional, nullable) — (Opcional) Desde qué cantidad se considera bajo el inventario de este producto. `null` usa el valor por defecto de la cuenta. - `has_dynamic_pricing` (boolean, optional) — (Opcional) Precio dinámico. El precio se convierte en el 'monto a recibir' neto. - `payment_method_types` (list of enum, optional) — (Opcional) Métodos de pago habilitados para este producto: `card` (tarjeta, pago de contado), `bank_transfer` (transferencia bancaria), `stablecoins` (dólares digitales), `balance` (Balance Recurrente), `akisi` (efectivo en Akisí; solo cuentas habilitadas, cobros únicos en GTQ con precio fijo y cuentas fuera de Sandbox). Al enviarlo, el producto usa su propia configuración en vez de heredar la de la cuenta; los valores no reconocidos se ignoran. Omítelo para heredar la configuración de la cuenta. Las cuotas son un eje aparte (`available_installments`); `card` controla el pago de contado, no las cuotas. - Allowed values: `card`, `bank_transfer`, `stablecoins`, `balance`, `akisi` - `available_installments` (list of enum, optional) — (Opcional) Opciones de cuotas (en meses) disponibles para este producto, independientes de `payment_method_types`. Solo aplica a `GTQ` y requiere que la cuenta tenga pagos con tarjeta habilitados. En los checkouts de este producto, el comprador escoge entre estas opciones. Usa `[]` para ocultar cuotas, o una lista como `[3]` para mostrar solo esa opción. - Allowed values: `3`, `6`, `12`, `18` - `metadata` (map from string to string, optional) — (Opcional) Metadata personalizada - `custom_fields` (list of CheckoutCustomFieldRequest, optional) — (Opcional) Hasta 3 campos personalizados a recolectar del comprador al pagar. La etiqueta se traduce automáticamente a los idiomas soportados. - `options_attributes` (list of ProductOptionRequest, optional) — Las opciones en que viene el producto (talla, color…). La lista es completa: una opción que no venga se elimina, y con ella se archivan las combinaciones que la usaban. Cruzar las opciones crea las combinaciones solas, así que para un producto que solo necesita opciones y un precio único, esto es lo único que hay que enviar. - `variants_attributes` (list of ProductVariantRequest, optional) — Para darle a una combinación su precio, su SKU o su conteo. No hace falta enviarlas todas: las que resultan de cruzar `options_attributes` se crean solas. Identifica cada una con `key` o con su `id`. ### Price - `id` (string, optional) — ID único del precio - `status` (enum, optional) — Estado del precio. Un precio `archived` fue reemplazado y ya no acepta nuevas compras; las suscripciones existentes lo conservan. - Allowed values: `active`, `archived` - `amount_in_cents` (integer, optional) — Monto en centavos - `currency` (enum, optional) — Moneda - Allowed values: `GTQ`, `USD` - `charge_type` (enum, optional) — Tipo de cargo - Allowed values: `one_time`, `recurring` - `billing_interval` (string, optional, nullable) — Intervalo de facturación (para suscripciones) - `billing_interval_count` (integer, optional, nullable) — Cada cuántos intervalos se cobra - `periods_before_automatic_cancellation` (integer, optional, nullable) — Períodos antes de cancelar automáticamente - `free_trial_interval` (string, optional, nullable) — Intervalo del período de prueba - `free_trial_interval_count` (integer, optional, nullable) — Duración del período de prueba - `proration_behavior` (enum, optional) — Comportamiento de prorrateo del primer cobro de la suscripción. `create_prorations` cobra solo los días restantes hasta el día de cobro; `none` cobra el monto completo. - Allowed values: `none`, `create_prorations` - `billing_cycle_anchor_day` (integer, optional, nullable) — Día del mes (1–31) en que ocurrirán los cobros recurrentes. Si el mes tiene menos días, se cobra el último día. - `defer_to_billing_day` (boolean, optional) — Si es `true`, la suscripción difiere su primer cobro hasta la próxima ocurrencia de `billing_cycle_anchor_day` (solo se guarda el método de pago al crear). ### CheckoutCustomFieldDefinition Definición de un campo personalizado de checkout (modelado en Stripe `custom_fields[]`). - `id` (string, optional) - `key` (string, optional) — Identificador estable usado en webhooks y la API. - `type` (enum, optional) - Allowed values: `text`, `numeric`, `dropdown` - `label` (map from string to string, optional) — Hash con la etiqueta en cada idioma soportado. `_original` es lo que escribió el comerciante; el resto se genera automáticamente. - `optional` (boolean, optional, default: false) - `minimum_length` (integer, optional, nullable) - `maximum_length` (integer, optional, nullable) - `default_value` (string, optional, nullable) - `options` (list of CheckoutCustomFieldDefinitionOptionsItems, optional, nullable) — Solo para `type: dropdown`. ### ProductOption Un eje en el que varía el producto y los valores que un comprador puede elegir. - `name` (string, optional) - `values` (list of string, optional) ### ProductVariant Una combinación vendible de las opciones del producto (el modelo de variantes de Shopify). Su precio es un `Price` del producto; la línea del checkout apunta a ese `price_id` y el webhook trae la variante en `items[].variant`. - `id` (string, optional) - `product_id` (string, optional) — El producto al que pertenece esta combinación. El SKU es único por producto, no por cuenta, así que es lo que permite resolver una fila de la lista. - `status` (enum, optional) - Allowed values: `active`, `archived` - `title` (string, optional) — Los valores unidos por " / ". - `option_values` (list of string, optional) - `sku` (string, optional, nullable) - `price_id` (string, optional) — El precio de esta variante. - `amount_in_cents` (integer, optional) - `currency` (string, optional) - `inventory_quantity` (integer, optional, nullable) — Existencias de esta variante. `null` es ilimitado. Baja con cada venta pagada de esta variante y puede quedar en negativo si se vendió más de lo que había; un número escrito aquí es cero o más. - `low_stock_threshold` (integer, optional, nullable) — Desde qué cantidad se considera baja esta variante. `null` usa el valor por defecto de la cuenta. ### ErrorErrors Detalles de errores por campo ### ProductsPostRequestBodyContentApplicationJsonSchemaProductPricesAttributesItems - `amount_in_cents` (integer, required) — Amount in minor units. The minimum product price is 100 for GTQ (Q1) and USD ($1). In-person card payments accept Q1; online checkouts require a minimum total of Q5. - `currency` (enum, required) — Moneda - Allowed values: `GTQ`, `USD` - `charge_type` (enum, required) — Tipo de cargo - Allowed values: `one_time`, `recurring` - `billing_interval` (enum, optional) — (Para suscripciones) Intervalo de facturación - Allowed values: `week`, `month`, `year` - `billing_interval_count` (integer, optional) — (Para suscripciones) Cada cuántos intervalos se cobra - `periods_before_automatic_cancellation` (integer, optional) — (Opcional) Períodos antes de cancelar automáticamente - `periods_before_allowed_to_cancel` (integer, optional) — (Opcional) Períodos mínimos antes de que el cliente pueda cancelar - `free_trial_interval` (enum, optional) — (Opcional) Intervalo del período de prueba gratuito - Allowed values: `week`, `month`, `year` - `free_trial_interval_count` (integer, optional) — (Opcional) Duración del período de prueba gratuito - `proration_behavior` (enum, optional, default: none) — (Opcional, para suscripciones mensuales) Controla el primer cobro cuando la suscripción se crea un día distinto al `billing_cycle_anchor_day`. `create_prorations` cobra solo los días restantes hasta el día de cobro (como ítem de crédito en el checkout); `none` cobra el monto completo. Ignorado si hay período de prueba gratuito. - Allowed values: `none`, `create_prorations` - `billing_cycle_anchor_day` (integer, optional) — (Opcional, para suscripciones mensuales) Día del mes (1–31) en que ocurrirán los cobros recurrentes. Combínalo con `proration_behavior` o `defer_to_billing_day` para controlar la fecha del primer cobro. Si el mes tiene menos días, se cobra el último día. - `defer_to_billing_day` (boolean, optional, default: false) — (Opcional, para suscripciones mensuales) Si es `true`, difiere el primer cobro hasta la próxima ocurrencia de `billing_cycle_anchor_day` (solo se guarda el método de pago al crear). Alternativa a `proration_behavior: create_prorations` cuando no quieres cobrar nada hasta el día de cobro. ### CheckoutCustomFieldRequest Payload para crear/actualizar un campo personalizado. - `key` (string, required) — Identificador estable, alfanumérico con guión bajo. - `type` (enum, required) - Allowed values: `text`, `numeric`, `dropdown` - `label` (string, required) — Etiqueta visible para el cliente. Recurrente la traduce automáticamente. - `id` (string, optional) — ID del campo existente (para actualizar). Omítelo para crear. - `_destroy` (boolean, optional) — Si es `true`, archiva el campo. Solo aplica si incluyes `id`. - `optional` (boolean, optional, default: false) - `minimum_length` (integer, optional) - `maximum_length` (integer, optional) - `default_value` (string, optional) - `options` (list of CheckoutCustomFieldRequestOptionsItems, optional) — Requerido para `type: dropdown`. Hasta 200 opciones. ### ProductOptionRequest Una opción en que viene el producto. Se envía dentro de `options_attributes` al crear o actualizar un producto; la lista es completa: una opción que no venga se elimina, y con ella las variantes que la usaban. - `id` (string, optional) — El id de una opción existente, para renombrarla o cambiar sus valores. Omítelo para crear una nueva. - `name` (string, optional) - `values` (list of string, optional) - `position` (integer, optional) — En qué orden se pregunta esta opción en el checkout. ### ProductVariantRequest Una combinación vendible. Se envía dentro de `variants_attributes` al crear o actualizar un producto. No hace falta enviar la lista completa de combinaciones: las que resultan de cruzar `options_attributes` se crean solas, y esta lista es para darle a una de ellas su precio, su SKU o su conteo. Identifica la combinación con `key` (los valores unidos por `|`, en el orden de las opciones) o con el `id` que ya tenga. Una combinación que se vendió se archiva, nunca se borra: las líneas que apuntan a su precio siguen resolviendo. - `id` (string, optional) - `key` (string, optional) — Los valores de la combinación unidos por `|`, en el orden de las opciones. - `option_values` (list of string, optional) - `sku` (string, optional, nullable) - `amount_in_cents` (integer, optional) — El precio de esta combinación. Si se omite, hereda el del producto. - `inventory_quantity` (integer, optional, nullable) — Unidades de esta combinación. La diferencia con el conteo actual queda como un ajuste en el historial. `null` deja de llevar inventario. - `low_stock_threshold` (integer, optional, nullable) — Desde qué cantidad se considera baja esta combinación. `null` usa el valor por defecto de la cuenta. - `status` (enum, optional) — `archived` retira la combinación de la venta sin romper las líneas que ya apuntan a su precio. - Allowed values: `active`, `archived` ### CheckoutCustomFieldDefinitionOptionsItems - `label` (string, optional) - `value` (string, optional) ### CheckoutCustomFieldRequestOptionsItems - `label` (string, required) - `value` (string, required) ## Examples **Request** ```json { "product": { "name": "El nombre de tu producto", "prices_attributes": [ { "amount_in_cents": 1000, "currency": "GTQ", "charge_type": "one_time" } ] } } ``` **Response** ```json { "id": "prod_9lstwgbr", "status": "active", "tax_category": "good", "name": "El nombre de tu producto", "description": "string", "success_url": "string", "cancel_url": "string", "custom_terms_and_conditions": "string", "phone_requirement": "optional", "address_requirement": "none", "billing_info_requirement": "optional", "has_dynamic_pricing": false, "payment_method_types": [ "card", "bank_transfer" ], "available_installments": [ 3, 6 ], "inventory_quantity": 12, "low_stock_threshold": 3, "prices": [ { "id": "price_rky4dog7", "status": "active", "amount_in_cents": 500, "currency": "GTQ", "charge_type": "one_time", "billing_interval": "month", "billing_interval_count": 1, "periods_before_automatic_cancellation": 1, "free_trial_interval": "string", "free_trial_interval_count": 1, "proration_behavior": "none", "billing_cycle_anchor_day": 1, "defer_to_billing_day": true } ], "storefront_link": "https://app.recurrente.com/s/surf-office/el-nombre-de-tu-producto", "metadata": {}, "custom_fields": [ { "id": "ccf_xxxxxxxxxxxx", "key": "engraving", "type": "text", "label": { "_original": "Mensaje de grabado", "en": "Engraving message", "es": "Mensaje de grabado" }, "optional": false, "minimum_length": 1, "maximum_length": 1, "default_value": "string", "options": [ { "label": "string", "value": "string" } ] } ], "options": [ { "name": "Talla", "values": [ "S", "M", "L" ] } ], "variants": [ { "id": "var_9lstwgbr", "product_id": "prod_9lstwgbr", "status": "active", "title": "M / Rojo", "option_values": [ "M", "Rojo" ], "sku": "string", "price_id": "price_3kd9sla2", "amount_in_cents": 12500, "currency": "GTQ", "inventory_quantity": 1, "low_stock_threshold": 3 } ] } ``` **SDK Code** ```python import requests url = "https://app.recurrente.com/api/products" payload = { "product": { "name": "El nombre de tu producto", "prices_attributes": [ { "amount_in_cents": 1000, "currency": "GTQ", "charge_type": "one_time" } ] } } headers = { "X-SECRET-KEY": "", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://app.recurrente.com/api/products'; const options = { method: 'POST', headers: {'X-SECRET-KEY': '', 'Content-Type': 'application/json'}, body: '{"product":{"name":"El nombre de tu producto","prices_attributes":[{"amount_in_cents":1000,"currency":"GTQ","charge_type":"one_time"}]}}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://app.recurrente.com/api/products" payload := strings.NewReader("{\n \"product\": {\n \"name\": \"El nombre de tu producto\",\n \"prices_attributes\": [\n {\n \"amount_in_cents\": 1000,\n \"currency\": \"GTQ\",\n \"charge_type\": \"one_time\"\n }\n ]\n }\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("X-SECRET-KEY", "") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://app.recurrente.com/api/products") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["X-SECRET-KEY"] = '' request["Content-Type"] = 'application/json' request.body = "{\n \"product\": {\n \"name\": \"El nombre de tu producto\",\n \"prices_attributes\": [\n {\n \"amount_in_cents\": 1000,\n \"currency\": \"GTQ\",\n \"charge_type\": \"one_time\"\n }\n ]\n }\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://app.recurrente.com/api/products") .header("X-SECRET-KEY", "") .header("Content-Type", "application/json") .body("{\n \"product\": {\n \"name\": \"El nombre de tu producto\",\n \"prices_attributes\": [\n {\n \"amount_in_cents\": 1000,\n \"currency\": \"GTQ\",\n \"charge_type\": \"one_time\"\n }\n ]\n }\n}") .asString(); ``` ```php request('POST', 'https://app.recurrente.com/api/products', [ 'body' => '{ "product": { "name": "El nombre de tu producto", "prices_attributes": [ { "amount_in_cents": 1000, "currency": "GTQ", "charge_type": "one_time" } ] } }', 'headers' => [ 'Content-Type' => 'application/json', 'X-SECRET-KEY' => '', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://app.recurrente.com/api/products"); var request = new RestRequest(Method.POST); request.AddHeader("X-SECRET-KEY", ""); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"product\": {\n \"name\": \"El nombre de tu producto\",\n \"prices_attributes\": [\n {\n \"amount_in_cents\": 1000,\n \"currency\": \"GTQ\",\n \"charge_type\": \"one_time\"\n }\n ]\n }\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "X-SECRET-KEY": "", "Content-Type": "application/json" ] let parameters = ["product": [ "name": "El nombre de tu producto", "prices_attributes": [ [ "amount_in_cents": 1000, "currency": "GTQ", "charge_type": "one_time" ] ] ]] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://app.recurrente.com/api/products")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```