v1

latestOpenAPI 3.1.02026-07-24750514.9 KB

Consultar fatura

get/invoices/{invoice_id}

Path parameters

invoice_idstring required

Identificador único da fatura que deseja consultar. Formato INVO_XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX.

Headers

Authorizationstring required

Token de autenticação. Deve ser enviado no formato Bearer <token>.

Response

200

idstring

statusstring

occurrenceinteger

created_atstring

updated_atstring

Example response

{
  "id": "INVO_F933C729-F68A-44E3-82ED-9CE380D3C4ED",
  "amount": {
    "value": 1000,
    "currency": "BRL"
  },
  "status": "OVERDUE",
  "plan": {
    "id": "PLAN_BF8032C9-518B-4336-92D0-73810C37ED8C",
    "name": "NOVO Nome do Plano"
  },
  "items": [
    {
      "amount": {
        "value": 99900,
        "currency": "BRL"
      },
      "type": "SUBSCRIPTION_AMOUNT"
    }
  ],
  "subscription": {
    "id": "SUBS_B3AFF3D0-4812-4DB8-9BBE-4D69AA111430"
  },
  "occurrence": 1,
  "customer": {
    "id": "CUST_2E9290E4-8149-4AEE-8A6B-F04055EFCEA1",
    "name": "Novo Nome do seu cliente",
    "email": "novo.email.do.cliente@empresa.com.br"
  },
  "created_at": "2022-06-09T10:28:14.545201-03:00",
  "updated_at": "2022-06-09T10:28:20.571091-03:00",
  "links": [
    {
      "rel": "SELF",
      "href": "http://sandbox.api.assinaturas.pagseguro.com/invoices/INVO_F933C729-F68A-44E3-82ED-9CE380D3C4ED",
      "media": "application/json",
      "type": "GET"
    }
  ]
}