Skip to main content

¿Qué es un Producto?

Un producto representa qué vendes: un bien o servicio de tu catálogo (por ejemplo “OnePay Pro” o “Asientos adicionales”). El producto describe la oferta —su nombre, descripción y características de marketing— pero no incluye el monto. El monto vive en los precios asociados al producto. Esta separación te permite tener un mismo producto con varios precios (mensual, anual, por moneda o por región) sin duplicar la oferta.
Producto "OnePay Pro"
  ├── Precio $50.000 COP / mes
  ├── Precio $500.000 COP / año
  └── Precio $15 USD / mes

¿Cuándo usar Productos?

Usa productos cuando quieras organizar tu catálogo de cobros recurrentes de forma reutilizable. Por ejemplo:
  • Catálogos con varios niveles (básico, pro, empresarial)
  • Un mismo servicio cobrado en varias monedas o frecuencias
  • Productos con características de marketing que muestras en el checkout

Objeto producto

CampoTipoDescripción
idstringIdentificador único (UUID) del producto.
objectstringSiempre product.
namestringNombre del producto.
descriptionstring | nullDescripción del producto.
activebooleanfalse cuando el producto está archivado.
internal_idstring | nullTu identificador interno.
unit_labelstring | nullEtiqueta de la unidad (ej. asientos).
tax_ratenumber | nullPorcentaje de IVA (0-100).
default_pricestring | nullID del precio por defecto.
marketing_featuresarrayCaracterísticas de marketing (hasta 15), cada una {name}.
metadataobject | nullDatos adicionales de tu aplicación.
pricesarrayPrecios activos del producto (solo en el detalle).
created_atstringFecha de creación (ISO 8601).
updated_atstringFecha de última actualización (ISO 8601).

Endpoints

Listar productos

Obtén el listado paginado de tus productos activos.

Crear producto

Registra un nuevo producto en tu catálogo.

Detalle del producto

Consulta un producto con sus precios activos.

Actualizar producto

Modifica los datos de un producto existente.

Archivar producto

Archiva un producto y sus precios sin borrarlos.