Skip to main content
GET
Consultar fatura
Retorna uma fatura da organizacao autenticada. status pode ser: open, paid, void, uncollectible. Erros comuns: 400 (UUID invalido), 401/403 (auth/produto), 404 (nao encontrada ou outra organizacao), 429 (20 req/min).

Authorizations

client-id
string
header
required
client-secret
string
header
required

Headers

client-id
string
required

ID público da credencial do merchant

client-secret
string
required

Secret da credencial do merchant

Path Parameters

invoiceId
string<uuid>
required

Response

Fatura

id
string<uuid>
subscription_id
string<uuid> | null
amount
integer
discount
integer | null
currency
string
Example:

"BRL"

cycle_start
string<date-time>
cycle_end
string<date-time> | null
due_at
string<date-time> | null
created_at
string<date-time>
status
enum<string>

Status da fatura

Available options:
open,
paid,
void,
uncollectible