Skip to main content
GET
O Therius cria uma fatura por ciclo de faturamento. Cada fatura registra a tentativa ou as tentativas de cobrança para aquele ciclo, o resultado e o valor final cobrado. Você pode recuperar todas as faturas de uma assinatura, ou buscar uma fatura específica diretamente pelo UUID dela.

​
Liste as faturas de uma assinatura

GET /subscription/{id}/invoice devolve todas as faturas de uma assinatura dada em ordem cronológica inversa, como um array simples — veja o painel de resposta acima para a forma completa de Invoice (status é open/paid/failed/void; o campo de novas tentativas é paymentAttemptCount). lines[] está presente apenas quando o plano precifica um ou mais medidores de uso: uma linha para a tarifa base do plano (sem meterId) mais uma linha por complemento medido. Ausente ou vazio em uma fatura de tarifa fixa — o amount de nível superior é então a cobrança inteira, e o amount de cada linha soma a ele.

​
Exemplo

​
Recupere uma fatura específica

GET /subscription/invoice/{id} recupera uma única fatura pelo UUID dela, independentemente de a qual assinatura ela pertence. Autentica da mesma forma que qualquer outro endpoint (Authorization: Bearer prv_production_xxx / prv_sandbox_xxx).

​
Parâmetros de caminho

​
string
obrigatório
O UUID da fatura a recuperar.

​
Parâmetros de consulta

​
string
obrigatório
O seu identificador de conta de lojista.

​
Resposta

Devolve um único objeto de fatura com os mesmos campos descritos acima.

​
Erros

​
Exemplo

Autorizações

​
Authorization
string
header
obrigatório

Your secret API key: Bearer prv_production_xxx (production) or Bearer prv_sandbox_xxx (sandbox).

Parâmetros de caminho

​
id
string
obrigatório

Subscription UUID.

Parâmetros de consulta

​
merchantCode
string
obrigatório

Your merchant account identifier.

Resposta

200 - application/json

List of invoices

​
id
string

Invoice UUID.

​
subscriptionId
string

The subscription this invoice belongs to.

​
merchantId
integer
​
status
enum<string>

open - awaiting payment; paid - settled; failed - all payment attempts failed; void - cancelled, no longer collectible.

Opções disponíveis:
open,
paid,
failed,
void
​
amount
integer

Invoice total in the currency minor units.

​
currency
string

ISO 4217 currency code.

​
exponent
integer

Decimal places for amount.

​
periodStart
string<date-time>

Start of the service period this invoice covers.

​
periodEnd
string<date-time>

End of the service period this invoice covers.

​
dueDate
string<date-time>
​
paymentAttemptCount
integer

Charge attempts made against this invoice, including dunning retries.

​
paidAt
string<date-time>
​
voidedAt
string<date-time>
​
createdAt
string<date-time>
​
updatedAt
string<date-time>
​
attempts
object[]

Per-attempt gateway results. Present on the single-invoice endpoint (GET /subscription/invoice/{id}).

​
lines
object[]

Itemisation - present only when the plan prices usage meters: one base-fee line (no meterId) plus one per metered add-on. Absent/empty for a flat-fee invoice.