v1
latestOpenAPI 3.1.02026-07-261420929.5 KBListar carnês
Lista os carnês criados em uma conta
get/payment_booklets
Query parameters
limitstring
Limita o número de registros retornados em até 100, que é o padrão de retorno desta chamada. Também utilizado em <a href="https://dev.iugu.com/v1.0/reference#paginação">paginação</a>.
created_at_fromstring date
Registros criados a partir dessa data passada no parâmetro. Formato (AAAA-MM-DDThh:mm:ss-03:00)
paid_at_fromstring date
Registros pagos a partir dessa data passada no parâmetro. Formato (AAAA-MM-DDThh:mm:ss-03:00)
statusstring
Usado para filtrar as carnês pelo status (pending, paid ou canceled)
querystring
Neste parâmetro pode ser passado um texto para pesquisa como e-mail, nome, descrição. Necessário usar a paginação (limit, start, etc)
customer_idstring
ID do Cliente.
updated_sincestring date
Registros atualizados desde o momento passado no parâmetro. Formato (AAAA-MM-DDThh:mm:ss-03:00)
Response
200
Example response
{
"payment_booklets": [
{
"id": "6F10E0ACB4F3471CAE1356093E3999BB",
"description": "Descrição da Capa do Carnê",
"price_cents": 1000,
"started_at": "2025-04-02T00:00:00-03:00",
"finish_at": "2025-05-02T00:00:00-03:00",
"status": "canceled",
"customer": {
"id": "796B9E7392444DAA971D3F1E0BE83F89",
"datasource_id": "EA29CC4EFA5B4150BCF2C13857246168",
"email": "jose_silva@teste.com",
"created_at": "2024-01-02T10:28:13-03:00",
"updated_at": "2024-04-29T12:03:42-03:00",
"name": "José",
"cc_emails": "jose_2@teste.com",
"cpf_cnpj": "113.436.750-30",
"zip_code": "01310100",
"number": "1048",
"complement": "55b",
"street": "Avenida Paulista",
"district": "Bela Vista",
"phone": "999999999",
"phone_prefix": "011"
},
"payment_booklet_installments": 2,
"secure_url": "https://faturas.iugu.com/payment_booklet/6f10e0ac-b4f3-471c-ae13-56093e3999bb-d989"
}
],
"totalItems": 18
}