For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Guías (Español)Guides (English)Referencia API
  • Referencia API
      • GETListar productos
      • POSTCrear un producto
      • GETObtener un producto
      • PUTActualizar un producto
      • DELArchivar un producto
LogoLogo
Referencia APIProducts

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": "none",
11 "address_requirement": "none",
12 "billing_info_requirement": "none",
13 "has_dynamic_pricing": false,
14 "prices": [
15 {
16 "id": "price_rky4dog7",
17 "amount_in_cents": 500,
18 "currency": "GTQ",
19 "charge_type": "one_time",
20 "billing_interval": "month",
21 "billing_interval_count": 1,
22 "periods_before_automatic_cancellation": 1,
23 "free_trial_interval": "string",
24 "free_trial_interval_count": 1,
25 "proration_behavior": "none",
26 "billing_cycle_anchor_day": 1,
27 "defer_to_billing_day": true
28 }
29 ],
30 "storefront_link": "https://app.recurrente.com/s/surf-office/el-nombre-de-tu-producto",
31 "metadata": {},
32 "custom_fields": [
33 {
34 "id": "ccf_xxxxxxxxxxxx",
35 "key": "engraving",
36 "type": "text",
37 "label": {
38 "_original": "Mensaje de grabado",
39 "en": "Engraving message",
40 "es": "Mensaje de grabado"
41 },
42 "optional": false,
43 "minimum_length": 1,
44 "maximum_length": 1,
45 "default_value": "string",
46 "options": [
47 {
48 "label": "string",
49 "value": "string"
50 }
51 ]
52 }
53 ]
54 }
55]

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

Was this page helpful?
Previous

Crear un producto

Next
Built with

Authentication

X-SECRET-KEYstring
Tu llave 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_requirementstring

Requerimiento de teléfono

address_requirementstring

Requerimiento de dirección

billing_info_requirementstring

Requerimiento de información fiscal

has_dynamic_pricingboolean

Si usa precio dinámico

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.