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

Cria um evento de billing baseado nos parametros do body.

Cria um evento de billing identificado pela idempotency_key.

A data de contabilização do evento é determinada pelo timestamp (em UTC) e pelo fuso horário configurado no workspace.
Exemplo: Um timestamp de 2025-02-02T00:00:00Z (meia-noite UTC):
Em um workspace com fuso "America/Sao_Paulo" (UTC-3), será contabilizado em 01/02/2025.
Em um workspace com fuso "Etc/UTC", será contabilizado em 02/02/2025.

Permissão necessária: billing:event.create

Esta permissão deve constar como uma das ações permitidas para o app que faz a chamada. Isto pode ser feito através do GIA, ou então na edição do aplicativo. Em caso de dúvidas, clique aqui.

Request

Headers

workspace_id

Required

Type: string

Identificador do workspace

Ex: 4fHECmQtLdROI4fDLWMiLd

Body Required

Content Type: 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 sem offset de fuso horário

Ex: 2024-01-01T01:23:45Z

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

custom_unit_quantity
Number

Quantidade que será contabilizada na cobrança (Caso a precificação seja do tipo customizada)

Ex: 10.23

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

Example
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:45Z",
      "idempotency_key": "2416b3e0-309d-4c3c-bc96-9b4b118454d5",
      "entity_name": "Transação",
      "entity_id": "09e8174e-0117-4382-90c4-32b25bbbc39f",
      "custom_unit_quantity": 10.23,
      "metadata": "{ transacao: 1, valor: 50}",
      "test": true
    }
  ]
}

Response

200

Se o app existir e o evento for registrado

created
Array of strings

Lista de idempotency keys dos eventos criados

Ex: ["3d02e0ea-fd3b-4998-a766-b48ce7110fb3", "777aee84-3314-4014-b020-254c3f6aacba"]

Example
1
2
3
4
5
6
{
  "created": [
    "3d02e0ea-fd3b-4998-a766-b48ce7110fb3",
    "777aee84-3314-4014-b020-254c3f6aacba"
  ]
}

401

Quando houver erro de autenticação

errors
String

Mensagem de erro

Ex: Authentication Error, check your token and try again

Example
1
2
3
{
  "errors": "Authentication Error, check your token and try again"
}

422

Se houver inconsistência nos dados informados

idempotency_key
Array of strings

Mensagens de erro ao tentar gerar o evento

Ex: ["The property ''#/0/timestamp'' Event cannot be scheduled more than 1 hour in the future."]

Example
1
2
3
4
5
{
  "idempotency_key": [
    "The property ''#/0/timestamp'' Event cannot be scheduled more than 1 hour in the future."
  ]
}

500

Em caso de erro de servidor ou externo.
Você deve tentar de novo dentro de alguns minutos.

errors
String

Mensagem de erro

Ex: Internal Server Error, please try again later.

Example
1
2
3
{
  "errors": "Internal Server Error, please try again later."
}