This endpoint allows fetching a customer by external ID.

Fetch customer by external ID

ApiKey

The request was successfully processed and the customer information is returned.

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 fetching a list of customers.

List customers

This endpoint allows creating a new customer.

Create customer

This endpoint allows fetching a customer by id.

Fetch customer

This endpoint allows updating a customer by id.

Update customer

This endpoint allows deleting a customer by id.

Delete customer

This endpoint allows updating a customer by external ID.

Update customer by external ID

This endpoint allows deleting a customer by external ID.

Delete customer by external ID

This endpoint allows 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

This endpoint allows fetching 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 fetching an invoice by id. It also returns, if available, a `pix` and `bank_slip` URL for each invoice, which expires after 15 minutes.

Fetch invoice

This endpoint allows creating 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

Customers

Events

Invoices

Contracts

Fetch customer by external ID

Authorizations

Path Parameters

Response