This endpoint allows for ingesting events related to customer interactions with resources. Each event captures interactions at a specific point in time, including the event name and customer, the nature of the interaction (value), related properties and when it occurred.

Ingest Events

An object containing an array of events to be ingested.

ApiKey

The request was successfully processed and the events were recorded. No content is returned.

Invalid request due to incorrect data or all events could not be processed successfully, so none have been recorded. This response includes details on which events failed and why, to aid in correcting and resubmitting the events.

Aira

Aira is the usage-based billing platform for software companies. We help you manage your recurring revenue and automate your billing process.

Overview

Webhooks

Error responses

This endpoint allows for the retrieval of a list of invoices based on customerId, customerExternalId, invoiceStartDateFrom, invoiceStartDateTo,  invoiceEndDateFrom, and invoiceEndDateTo. The response will include a list of invoices that match the provided filters. It also returns, if available, a `pix` and `bank_slip` URL for each invoice, which expires after 15 minutes. 

List Invoices

This endpoint allows for the retrieval of an invoice by id. It also returns, if available, a `pix` and `bank_slip` URL for each invoice, which expires after 15 minutes.

Get Invoice

This endpoint allows the creation of a new contract. If needed, it also permits the creation of a new customer and a new payment account or the provision of existing customer and payment account IDs to sync the new contract with them.

API Documentation

Events

Invoices

Contracts

Ingest Events

Authorizations

Body

Response