Docs

Começando

Primeiros passos

...

Nesta página

post https://billing.iugu.com/api/events

Cria um evento de billing baseado nos parametros do payload.

Cria um evento de billing baseado nos parametros do payload.

Autorizações
oauth2 Autenticação por Bearer
Flow type: clientCredentials
Token URL: https://identity.iugu.com/token
Scopes:
  • audience - Iugu.Platform.33qqIXOLGKohFVkWBN1Apf

Schema Obrigatório

Tipo de conteúdo: application/json
workspace_id
String

É o workspace para o qual o evento está sendo disparado, ou seja, o workspace que será cobrando pelo evento.

Ex: abc123
events
Array of objects

Lista de eventos a ser enviado
name
String

Nome do seu evento

Ex: meu.evento
timestamp
String

Hora do seu evento no formato ISO 8601 em UTC

Ex: 2024-01-01T01:23:45-03:00
idempotency_key
String

Chave única que impede o envio do evento em duplicidade. É de total responsabilidade do desenvolvedor garantir que as chaves sejam únicas

Ex: 2416b3e0-309d-4c3c-bc96-9b4b118454d5
entity_name
String

Nome da entidade mapeada pelo evento

Ex: Transação
entity_id
String

Id da entidade mapeada pelo evento

Ex: 09e8174e-0117-4382-90c4-32b25bbbc39f
metadata
Object

Map de chave/valor com informações adicionais do evento enviado

Ex: { transacao: 1, valor: 50}
test
Boolean

Indica que o evento é um teste e não será cobrado.

Ex: true
Exemplo 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

{
  "workspace_id": "abc123",
  "events": [
    {
      "name": "meu.evento",
      "timestamp": "2024-01-01T01:23:45-03:00",
      "idempotency_key": "2416b3e0-309d-4c3c-bc96-9b4b118454d5",
      "entity_name": "Transação",
      "entity_id": "09e8174e-0117-4382-90c4-32b25bbbc39f",
      "metadata": {
      },
      "test": true
    }
  ]
}

Respostas
200
Se o app existir e o evento for registrado
404
Se o app não existir
422
Se houver conflito de chaves idempotency