Listar productos

GET

https://app.recurrente.com/api/products

GET

/api/products

$ curl https://app.recurrente.com/api/products \
>      -H "X-SECRET-KEY: <apiKey>"

200Retrieved

1 [
2   {
3     "id": "prod_9lstwgbr",
4     "status": "active",
5     "name": "El nombre de tu producto",
6     "description": "string",
7     "success_url": "string",
8     "cancel_url": "string",
9     "custom_terms_and_conditions": "string",
10     "phone_requirement": "optional",
11     "address_requirement": "none",
12     "billing_info_requirement": "optional",
13     "has_dynamic_pricing": false,
14     "payment_method_types": [
15       "card",
16       "bank_transfer"
17     ],
18     "available_installments": [
19       3,
20       6
21     ],
22     "prices": [
23       {
24         "id": "price_rky4dog7",
25         "status": "active",
26         "amount_in_cents": 500,
27         "currency": "GTQ",
28         "charge_type": "one_time",
29         "billing_interval": "month",
30         "billing_interval_count": 1,
31         "periods_before_automatic_cancellation": 1,
32         "free_trial_interval": "string",
33         "free_trial_interval_count": 1,
34         "proration_behavior": "none",
35         "billing_cycle_anchor_day": 1,
36         "defer_to_billing_day": true
37       }
38     ],
39     "storefront_link": "https://app.recurrente.com/s/surf-office/el-nombre-de-tu-producto",
40     "metadata": {},
41     "custom_fields": [
42       {
43         "id": "ccf_xxxxxxxxxxxx",
44         "key": "engraving",
45         "type": "text",
46         "label": {
47           "_original": "Mensaje de grabado",
48           "en": "Engraving message",
49           "es": "Mensaje de grabado"
50         },
51         "optional": false,
52         "minimum_length": 1,
53         "maximum_length": 1,
54         "default_value": "string",
55         "options": [
56           {
57             "label": "string",
58             "value": "string"
59           }
60         ]
61       }
62     ]
63   }
64 ]

Lista todos los productos activos de tu cuenta con paginación.

Authentication

X-SECRET-KEYstring

Tu clave secreta de API

Query parameters

pageintegerOptional>=1Defaults to 1

Número de página (empezando en 1)

itemsintegerOptional1-100Defaults to 10

Elementos por página

Response

Lista de productos

idstring

ID único del producto

statusstring

Estado del producto

namestring

Nombre del producto

descriptionstring or null

Descripción del producto

success_urlstring or null

URL de redirección después de un pago exitoso

cancel_urlstring or null

URL de redirección cuando el comprador cancela

custom_terms_and_conditionsstring or null

Términos y condiciones personalizados

phone_requirementenumDefaults to optional

Requerimiento de teléfono

address_requirementenumDefaults to none

Requerimiento de dirección

billing_info_requirementenumDefaults to optional

Requerimiento de información fiscal

has_dynamic_pricingboolean

Si usa precio dinámico

payment_method_typeslist of enums

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). Las cuotas se exponen por separado en available_installments.

available_installmentslist of integers

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.

priceslist of objects

Precios del producto

storefront_linkstring

Link público del producto en la tienda

metadatamap from strings to strings or null

Metadata personalizada

custom_fieldslist of objects

Definiciones de campos personalizados activos en el checkout.