Obtener un producto

GET

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

GET

/api/products/:id

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

200Retrieved

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

Obtén los detalles de un producto específico.

Authentication

X-SECRET-KEYstring

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.

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.

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. 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`.

Path parameters

idstringRequired

ID del producto

Response

Detalles del producto

idstringOptional

ID único del producto

statusstringOptional

Estado del producto

namestringOptional

Nombre del producto

descriptionstring or nullOptional

Descripción del producto

success_urlstring or nullOptional

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

cancel_urlstring or nullOptional

URL de redirección cuando el comprador cancela

custom_terms_and_conditionsstring or nullOptional

Términos y condiciones personalizados

phone_requirementenumOptionalDefaults to optional

Requerimiento de teléfono

address_requirementenumOptionalDefaults to none

Requerimiento de dirección

billing_info_requirementenumOptionalDefaults to optional

Requerimiento de información fiscal

has_dynamic_pricingbooleanOptional

Si usa precio dinámico

payment_method_typeslist of enumsOptional

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 integersOptional

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 objectsOptional

Precios del producto

storefront_linkstringOptional

Link público del producto en la tienda

metadatamap from strings to strings or nullOptional

Metadata personalizada

custom_fieldslist of objectsOptional

Definiciones de campos personalizados activos en el checkout.