Introducción
Los metadatos te permiten almacenar tus propios datos de clave-valor en objetos de Dodo Payments, como un ID de pedido de tu sistema o una referencia de CRM. Puedes adjuntar metadatos a la mayoría de los objetos, incluidos pagos, suscripciones, clientes y productos. Consulta Objetos compatibles para ver la lista completa.Descripción General
Los metadatos siguen estas reglas:- Las claves de metadatos pueden tener hasta 40 caracteres (hasta 100 caracteres para los eventos de uso ingeridos mediante
POST /events/ingest). - Los valores de metadatos pueden ser una cadena, un entero, un número o un booleano. Las cadenas pueden tener hasta 500 caracteres.
- No se aceptan objetos, matrices ni
nullcomo valores de metadatos. - Puedes añadir hasta 50 pares clave-valor de metadatos por objeto. Una solicitud con más devuelve el
MAXIMUM_KEYS_REACHEDcódigo de error. - La API no puede buscar ni filtrar por metadatos, pero devuelve los metadatos en las respuestas de la API y en los webhooks.
Casos de uso
Usa metadatos para:- Almacenar IDs o referencias externos.
- Añadir notas internas.
- Vincular objetos de Dodo Payments con registros de tu sistema.
- Categorizar transacciones.
- Añadir atributos personalizados para informes.
Añadir metadatos
Añade metadatos cuando crees o actualices un objeto mediante la API. Para los productos, también puedes añadir metadatos en el panel de control.Mediante la API
Pasa un objetometadata en el cuerpo de la solicitud. Los ejemplos siguientes usan el SDK de TypeScript y asumen un client inicializado:
Mediante la interfaz del panel de control (solo productos)
Para añadir metadatos a un producto sin escribir código, abre el producto en Productos y añade pares clave-valor en la sección de metadatos. Puedes hacerlo al crear o editar el producto.
Recuperar metadatos
Las respuestas de la API incluyen metadatos cuando recuperas un objeto:Al recuperar una sesión de checkout (
GET /checkouts/{id}) no se devuelve metadata. La respuesta de estado de la sesión solo contiene id, created_at, payment_id, payment_status, customer_email y customer_name. Para leer los metadatos que adjuntaste al crear la sesión, recupera el pago resultante mediante el payment_id devuelto.Buscar y filtrar
La API no puede buscar por metadatos. Para encontrar un objeto mediante un valor de metadatos:- Almacena tus identificadores importantes en los metadatos.
- Enumera o recupera objetos mediante la API.
- Filtra los resultados en el código de tu aplicación.
Prácticas recomendadas
Sigue estas pautas para mantener los metadatos útiles.Recomendaciones:
- Usa convenciones de nomenclatura coherentes para las claves de metadatos.
- Documenta internamente tu esquema de metadatos.
- Mantén los valores breves y significativos.
- Usa metadatos únicamente para datos estáticos.
- Considera usar prefijos que indiquen el sistema de origen, por ejemplo
crm_idoinventory_sku.
Evita:
- Almacenar datos confidenciales en los metadatos.
- Usar metadatos para valores que cambian con frecuencia.
- Depender de los metadatos para la lógica empresarial crítica.
- Duplicar información que el objeto ya contiene.
- Usar caracteres especiales en las claves de metadatos.