Histórico de cobranças mensais do plano por conta

Este endpoint retorna o histórico completo de mensalidades cobradas para o plano vinculado a uma conta específica, permitindo acompanhar valores, datas e status das cobranças realizadas.

Requisição(Request)

Requisição HTTP

GET https://sandbox.hiperbanco.com.br/plans/accounts/invoices/{accountId}

--request GET 'https://sandbox.hiperbanco.com.br/plans/accounts/invoices/{accountId}' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}'

Cabeçalhos (Headers)

Nome	Propriedade	Descrição
`version`	`cutting-edge`	Essa propriedade garante que o response da API seja retornado no formato JSON
`Authorization`	`Bearer token`	Obrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path / Query)

Nome	Tipo	Descrição
`accountId`	`path`	Id da conta
`page`	`query`	Página do resultado da busca
`perPage`	`query`	Itens por página

Corpo da requisição (Body)

Não é necessário enviar parâmetros no body desta requisição.

Resposta (Response)

O status code 200 indicará que a requisição foi feita com sucesso e trará um objeto contendo as informações das contas que estão vinculados a aquele plano

Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

Campo	Tipo	Descrição
`data`	`array`	Lista de registros de pagamentos de planos.
`data[].id`	`string`	Identificador único do pagamento.
`data[].paid`	`boolean`	Indica se o pagamento foi realizado.
`data[].price`	`number`	Valor do pagamento.
`data[].createdAt`	`string`	Data de criação do registro.
`data[].paidAt`	`string`	Data em que o pagamento foi confirmado.
`data[].plan`	`object`	Dados do plano associado ao pagamento.
`data[].plan.id`	`string`	Identificador único do plano.
`data[].plan.name`	`string`	Nome do plano.
`data[].accounts`	`object`	Dados da conta vinculada ao pagamento.
`data[].accounts.id`	`string`	Identificador único da conta.
`data[].accounts.status`	`string`	Status da conta
`data[].accounts.number`	`string`	Número da conta.
`data[].accounts.onboarding`	`object`	Dados de onboarding da conta.
`data[].accounts.onboarding.registerName`	`string`	Nome de registro do cliente vinculado à conta.
`total`	`number`	Quantidade total de registros.
`totalPages`	`number`	Quantidade total de páginas disponíveis.

{
    "data": [
        {
            "id": "87d3ad70-9ae7-4572-9e4f-24b1dbf606f9",
            "paid": true,
            "price": 0,
            "createdAt": "20/04/2025 00:04",
            "paidAt": "20/04/2025 03:00",
            "plan": {
                "id": "0bb24fa1-b916-49e7-8911-84aa347936ad",
                "name": "Plano A"
            },
            "accounts": {
                "id": "0acaea79-dc8a-4a51-994e-81be2138d43c",
                "status": "ACTIVE",
                "number": "1101275194",
                "onboarding": {
                    "registerName": "Jairo Moraes"
                }
            }
        },
        {
            "id": "bde3c1bb-5f7a-42c4-9849-b6a60d9365e6",
            "paid": true,
            "price": 0,
            "createdAt": "20/03/2025 00:10",
            "paidAt": "02/04/2025 03:00",
            "plan": {
                "id": "0bb24fa1-b916-49e7-8911-84aa347936ad",
                "name": "Plano A"
            },
            "accounts": {
                "id": "0acaea79-dc8a-4a51-994e-81be2138d43c",
                "status": "ACTIVE",
                "number": "1101275194",
                "onboarding": {
                    "registerName": "Jairo Moraes"
                }
            }
        },
        {
            "id": "9e345aed-bd22-4ec7-a56d-ad3950f429ac",
            "paid": true,
            "price": 0,
            "createdAt": "20/02/2025 00:09",
            "paidAt": "02/04/2025 03:00",
            "plan": {
                "id": "0bb24fa1-b916-49e7-8911-84aa347936ad",
                "name": "Plano A"
            },
            "accounts": {
                "id": "0acaea79-dc8a-4a51-994e-81be2138d43c",
                "status": "ACTIVE",
                "number": "1101275194",
                "onboarding": {
                    "registerName": "Jairo Moraes"
                }
            }
        },
        {
            "id": "f33b56aa-525e-4864-bb74-fb0cf6c81f64",
            "paid": true,
            "price": 0,
            "createdAt": "20/01/2025 00:09",
            "paidAt": "02/04/2025 03:00",
            "plan": {
                "id": "0bb24fa1-b916-49e7-8911-84aa347936ad",
                "name": "Plano A"
            },
            "accounts": {
                "id": "0acaea79-dc8a-4a51-994e-81be2138d43c",
                "status": "ACTIVE",
                "number": "1101275194",
                "onboarding": {
                    "registerName": "Jairo Moraes"
                }
            }
        },
        {
            "id": "6c5a08a4-f3df-4563-a6bf-acabdbbe8618",
            "paid": true,
            "price": 0,
            "createdAt": "20/12/2024 00:06",
            "paidAt": "02/04/2025 03:00",
            "plan": {
                "id": "0bb24fa1-b916-49e7-8911-84aa347936ad",
                "name": "Plano A"
            },
            "accounts": {
                "id": "0acaea79-dc8a-4a51-994e-81be2138d43c",
                "status": "ACTIVE",
                "number": "1101275194",
                "onboarding": {
                    "registerName": "Jairo Moraes"
                }
            }
        }
    ],
    "total": 15,
    "totalPages": 3
}

Erros

Este endpoint não retorna erros específicos. Porém, ele poderá retornar alguns erros comuns entre todos os endpoints.

Eventos

Este endpoint não possui eventos relacionados a ele.