Skip to main content
GET
/
invoices
/
{id}
Obter fatura
curl --request GET \
  --url https://api.pagozz.com/v1/invoices/{id} \
  --header 'Pagozz-Token: <api-key>'
{
  "data": {
    "id": "i1a2b3c4-d5e6-7890-abcd-ef1234567890",
    "cycle_id": "c1a2b3c4-d5e6-7890-abcd-ef1234567890",
    "type": "recurring",
    "period_start": "2026-03-01T10:00:00Z",
    "period_end": "2026-04-01T10:00:00Z",
    "billing_number": 1,
    "amount": 4990,
    "setup_fee": 0,
    "credit_applied": 0,
    "total_amount": 4990,
    "currency": "BRL",
    "status": "open",
    "transaction_id": null,
    "payment_method": "pix",
    "paid_at": null,
    "due_at": "2026-03-04T10:00:00Z",
    "attempt_count": 0,
    "environment": "test",
    "created_at": "2026-03-01T10:00:00Z",
    "updated_at": "2026-03-01T10:00:00Z"
  }
}

Authorizations

Pagozz-Token
string
header
required

Chave de API no formato pgz_test_* (test mode) ou pgz_live_* (live mode). O ambiente é determinado automaticamente pelo prefixo da chave.

Path Parameters

id
string<uuid>
required

ID do recurso (UUID).

Response

Detalhes da fatura.

data
object

Representa uma fatura gerada por uma assinatura.