Skip to content

Productos (API)

El catálogo de productos se crea y edita solo desde el dashboard (proyecto → Productos). Sobre la API de Integración el catálogo es de solo lectura: consume los productos existentes por su productCode para armar suscripciones y cargos.

Todos los endpoints requieren tu API key de proyecto en el header X-API-Key.

Catálogo de productos de un proyecto

Tipos de producto

Cada producto se define por paymentType (one_time o recurring) y, para los de pago único, requiresSubscription:

paymentTyperequiresSubscriptionEs un…
recurringPlan — item de suscripción facturado cada ciclo
one_timefalseProducto independiente — compra única (p. ej. créditos)
one_timetrueAddon — cobro único sobre una suscripción activa

Listar productos

http
GET /v1/products

Parámetros de consulta:

CampoTipoRequeridoDescripción
statusstringNoFiltra por estado del producto (p. ej. activos)
paymentTypestringNoFiltra por one_time o recurring
limintegerNoTamaño de página
offintegerNoOffset (paginación)
bash
curl "https://api-pay.zelta.dev/v1/products?paymentType=recurring" \
  -H "X-API-Key: tu-api-key-de-proyecto"

Obtener un producto

http
GET /v1/products/:productCode
bash
curl "https://api-pay.zelta.dev/v1/products/pos-base" \
  -H "X-API-Key: tu-api-key-de-proyecto"

Devuelve el producto identificado por su productCode, con su paymentType, requiresSubscription, precio, moneda y — para productos recurrentes — su billingPeriod / billingInterval.

Para crear o editar productos, usa el dashboard

La API no expone endpoints de escritura sobre el catálogo. Si necesitas un nuevo plan, addon o producto independiente, créalo en el dashboard del proyecto y luego consúmelo por su productCode.

Siguientes pasos

  • — usa los productCode recurrentes como items
  • — cobra productos one_time a un cliente
  • — visión general del modelo de proyectos

Documentación oficial de Zelta