Documentação da API

Aira

Login

Suporte

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

Record Events

An array of event objects. Each event includes a resourceExternalId, customerExternalId, value, and occurredAt timestamp, alongside an optional idempotencyKey for ensuring uniqueness. Requires at least one event object to proceed.

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 is the usage-based billing platform for software companies. We help you manage your recurring revenue and automate your billing process.

Documentation

Webhook Documentation

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.

Create a Contract

This endpoint allows the retrieval of a contract.

Get Contract

This endpoint allows the update of a contract.

Update a Contract

This endpoint allows the cancelation of a contract.

Cancel a Contract

This endpoint allows for the creation of a resource used in customer billing. Each resource is defined by a name and an external identifier. Upon successful creation, a unique UUID for the resource is returned.

Aira Docs

Events

Invoices

Contracts

Resources

Record Events

Body

Response