List billings

GET

GET https://platform-api.lia.com.br/external_api/v1/billings

Query params

NameDescriptionRequiredType
order_idFilter by order_idfalseString
statusFilter by billing statusfalseString
created_at_startFilter by billings created_at greater than or equal to (YYYY-MM-DD)falseString
created_at_endFilter by billings created_at lower than or equal to (YYYY-MM-DD)falseString
finished_at_startFilter by billings finished_at greater than or equal to (YYYY-MM-DD)falseString
finished_at_endFilter by billings finished_at lower than or equal to (YYYY-MM-DD)falseString
cancelation_reasonFilter by cancelation_reasonfalseString
pageNumber of the page you wantfalseInteger
per_pageTotal items per page, max 1000 itens per pagefalseInteger

Example request

curl --location 'https://platform-api-sandbox.lia.com.br/external_api/v1/billings?order_id=17b6ecb3-58a8-40e6-9722-2ee41e64ekL8&
status=canceled&created_at_start=2024-06-09&page=1&per_page=2
--header 'Authorization: Bearer sandbox_BtnsSPrTQcK2M1jyEJeckqtsNP3XtR7BXN6UTDfs'

Example response

{
    "results": [
        {
            "amount_cents": 310650,
            "amount_currency": "BRL",
            "bills": [
                {
                    "amount_cents": 50000,
                    "authentication_code": "b240dd72990c107b261ee306021477bv2p",
                    "bill_type": "down_payment",
                    "billing": {
                        "amount_cents": 310650,
                        "amount_currency": "BRL",
                        "cancelation_reason": "refunded_by_company",
                        "created_at": "2024-06-11T09:36:51.619-03:00",
                        "due_day": 10,
                        "finished_at": "2024-06-13T15:43:28.559-03:00",
                        "id": "d9fe02d3-6535-4691-b03c-7cc94ac1b1f4",
                        "installments": 6,
                        "order_id": "17b6ecb3-58a8-40e6-9722-2ee41e64ekL8",
                        "origin_billing_id": null,
                        "status": "canceled",
                        "updated_at": "2024-07-19T17:00:57.851-03:00"
                    },
                    "checkout_url": "https://pague-sandbox.lia.com.br/parcela/pagamento?bill_id=483ebcfd-00c6-4dd1-af5d-b5ee8b614af1",
                    "created_at": "2024-06-11T09:36:51.670-03:00",
                    "current_amount_cents": 50000,
                    "disable_penalties_until": null,
                    "due_date": "2024-06-12T23:59:59.999-03:00",
                    "effective_due_date": "2024-06-12T23:59:59.999-03:00",
                    "id": "483ebcfd-00c6-4dd1-af5d-b5ee8b614af1",
                    "original_amount_cents": 50000,
                    "paid_at": "2024-06-11T09:36:53.994-03:00",
                    "payments": [
                        {
                            "amount_cents": 50000,
                            "barcode": null,
                            "barcode_image_url": null,
                            "bill_id": "483ebcfd-00c6-4dd1-af5d-b5ee8b614af1",
                            "created_at": "2024-06-11T09:36:53.737-03:00",
                            "expires_at": "2024-06-12T23:59:59.999-03:00",
                            "id": "a1a610f3-d4e7-47cf-8aac-759e522d4fc2",
                            "installments": 1,
                            "paid_amount_cents": 0,
                            "paid_at": null,
                            "payment_method": "credit_card",
                            "refunded_amount_cents": 0,
                            "refunded_at": null,
                            "refused_reason": null,
                            "refused_reason_description": null,
                            "status": "failed",
                            "url": "https://pague-sandbox.lia.com.br/parcela/pagamento?bill_id=483ebcfd-00c6-4dd1-af5d-b5ee8b614af1"
                        },
                        {
                            "amount_cents": 50000,
                            "barcode": null,
                            "barcode_image_url": null,
                            "bill_id": "483ebcfd-00c6-4dd1-af5d-b5ee8b614af1",
                            "created_at": "2024-06-11T09:36:53.806-03:00",
                            "expires_at": "2024-06-12T23:59:59.999-03:00",
                            "id": "c064bf1c-91c9-4452-9612-e7c182281bab",
                            "installments": 1,
                            "paid_amount_cents": 50000,
                            "paid_at": "2024-06-11T09:36:53.852-03:00",
                            "payment_method": "credit_card",
                            "refunded_amount_cents": 50000,
                            "refunded_at": "2024-07-12T00:00:00.000-03:00",
                            "refused_reason": null,
                            "refused_reason_description": null,
                            "status": "refunded",
                            "url": "https://pague-sandbox.lia.com.br/parcela/pagamento?bill_id=483ebcfd-00c6-4dd1-af5d-b5ee8b614af1"
                        }
                    ],
                    "status": "canceled",
                    "updated_at": "2024-06-13T15:43:28.251-03:00"
                },
                {
                    "amount_cents": 52130,
                    "authentication_code": null,
                    "bill_type": "installment",
                    "billing": {
                        "amount_cents": 310650,
                        "amount_currency": "BRL",
                        "cancelation_reason": "refunded_by_company",
                        "created_at": "2024-06-11T09:36:51.619-03:00",
                        "due_day": 10,
                        "finished_at": "2024-06-13T15:43:28.559-03:00",
                        "id": "d9fe02d3-6535-4691-b03c-7cc94ac1b1f4",
                        "installments": 6,
                        "order_id": "17b6ecb3-58a8-40e6-9722-2ee41e64ekL8",
                        "origin_billing_id": null,
                        "status": "canceled",
                        "updated_at": "2024-07-19T17:00:57.851-03:00"
                    },
                    "checkout_url": "https://pague-sandbox.lia.com.br/parcela/pagamento?bill_id=27fd1d74-fc33-4a64-ac9f-745174d46de4",
                    "created_at": "2024-06-11T09:36:51.755-03:00",
                    "current_amount_cents": 58560,
                    "disable_penalties_until": "2024-07-10T23:59:59.999-03:00",
                    "due_date": "2024-07-10T23:59:59.999-03:00",
                    "effective_due_date": "2024-07-10T23:59:59.999-03:00",
                    "id": "27fd1d74-fc33-4a64-ac9f-745174d46de4",
                    "original_amount_cents": 52130,
                    "paid_at": null,
                    "payments": [],
                    "status": "canceled",
                    "updated_at": "2024-06-13T15:43:28.277-03:00"
                },
                {
                    "amount_cents": 52130,
                    "authentication_code": null,
                    "bill_type": "installment",
                    "billing": {
                        "amount_cents": 310650,
                        "amount_currency": "BRL",
                        "cancelation_reason": "refunded_by_company",
                        "created_at": "2024-06-11T09:36:51.619-03:00",
                        "due_day": 10,
                        "finished_at": "2024-06-13T15:43:28.559-03:00",
                        "id": "d9fe02d3-6535-4691-b03c-7cc94ac1b1f4",
                        "installments": 6,
                        "order_id": "17b6ecb3-58a8-40e6-9722-2ee41e64ekL8",
                        "origin_billing_id": null,
                        "status": "canceled",
                        "updated_at": "2024-07-19T17:00:57.851-03:00"
                    },
                    "checkout_url": "https://pague-sandbox.lia.com.br/parcela/pagamento?bill_id=4fd0af3a-19a9-4766-a75c-3e9f1a3f4fab",
                    "created_at": "2024-06-11T09:36:51.834-03:00",
                    "current_amount_cents": 57986,
                    "disable_penalties_until": "2024-08-10T23:59:59.999-03:00",
                    "due_date": "2024-08-10T23:59:59.999-03:00",
                    "effective_due_date": "2024-08-12T23:59:59.999-03:00",
                    "id": "4fd0af3a-19a9-4766-a75c-3e9f1a3f4fab",
                    "original_amount_cents": 52130,
                    "paid_at": null,
                    "payments": [],
                    "status": "canceled",
                    "updated_at": "2024-06-13T15:43:28.361-03:00"
                },
                {
                    "amount_cents": 52130,
                    "authentication_code": null,
                    "bill_type": "installment",
                    "billing": {
                        "amount_cents": 310650,
                        "amount_currency": "BRL",
                        "cancelation_reason": "refunded_by_company",
                        "created_at": "2024-06-11T09:36:51.619-03:00",
                        "due_day": 10,
                        "finished_at": "2024-06-13T15:43:28.559-03:00",
                        "id": "d9fe02d3-6535-4691-b03c-7cc94ac1b1f4",
                        "installments": 6,
                        "order_id": "17b6ecb3-58a8-40e6-9722-2ee41e64ekL8",
                        "origin_billing_id": null,
                        "status": "canceled",
                        "updated_at": "2024-07-19T17:00:57.851-03:00"
                    },
                    "checkout_url": "https://pague-sandbox.lia.com.br/parcela/pagamento?bill_id=b83cb58c-cc06-4abc-be57-a928cbf36ccc",
                    "created_at": "2024-06-11T09:36:51.905-03:00",
                    "current_amount_cents": 57482,
                    "disable_penalties_until": "2024-09-10T23:59:59.999-03:00",
                    "due_date": "2024-09-10T23:59:59.999-03:00",
                    "effective_due_date": "2024-09-10T23:59:59.999-03:00",
                    "id": "b83cb58c-cc06-4abc-be57-a928cbf36ccc",
                    "original_amount_cents": 52130,
                    "paid_at": null,
                    "payments": [],
                    "status": "canceled",
                    "updated_at": "2024-06-13T15:43:28.478-03:00"
                },
                {
                    "amount_cents": 52130,
                    "authentication_code": null,
                    "bill_type": "installment",
                    "billing": {
                        "amount_cents": 310650,
                        "amount_currency": "BRL",
                        "cancelation_reason": "refunded_by_company",
                        "created_at": "2024-06-11T09:36:51.619-03:00",
                        "due_day": 10,
                        "finished_at": "2024-06-13T15:43:28.559-03:00",
                        "id": "d9fe02d3-6535-4691-b03c-7cc94ac1b1f4",
                        "installments": 6,
                        "order_id": "17b6ecb3-58a8-40e6-9722-2ee41e64ekL8",
                        "origin_billing_id": null,
                        "status": "canceled",
                        "updated_at": "2024-07-19T17:00:57.851-03:00"
                    },
                    "checkout_url": "https://pague-sandbox.lia.com.br/parcela/pagamento?bill_id=9fd47f79-023f-46e9-af55-7220adef76d8",
                    "created_at": "2024-06-11T09:36:51.973-03:00",
                    "current_amount_cents": 56961,
                    "disable_penalties_until": "2024-10-10T23:59:59.999-03:00",
                    "due_date": "2024-10-10T23:59:59.999-03:00",
                    "effective_due_date": "2024-10-10T23:59:59.999-03:00",
                    "id": "9fd47f79-023f-46e9-af55-7220adef76d8",
                    "original_amount_cents": 52130,
                    "paid_at": null,
                    "payments": [],
                    "status": "canceled",
                    "updated_at": "2024-06-13T15:43:28.464-03:00"
                },
                {
                    "amount_cents": 52130,
                    "authentication_code": null,
                    "bill_type": "installment",
                    "billing": {
                        "amount_cents": 310650,
                        "amount_currency": "BRL",
                        "cancelation_reason": "refunded_by_company",
                        "created_at": "2024-06-11T09:36:51.619-03:00",
                        "due_day": 10,
                        "finished_at": "2024-06-13T15:43:28.559-03:00",
                        "id": "d9fe02d3-6535-4691-b03c-7cc94ac1b1f4",
                        "installments": 6,
                        "order_id": "17b6ecb3-58a8-40e6-9722-2ee41e64ekL8",
                        "origin_billing_id": null,
                        "status": "canceled",
                        "updated_at": "2024-07-19T17:00:57.851-03:00"
                    },
                    "checkout_url": "https://pague-sandbox.lia.com.br/parcela/pagamento?bill_id=8e94720e-c025-4152-a6a2-823a47079f35",
                    "created_at": "2024-06-11T09:36:52.055-03:00",
                    "current_amount_cents": 56405,
                    "disable_penalties_until": "2024-11-10T23:59:59.999-03:00",
                    "due_date": "2024-11-10T23:59:59.999-03:00",
                    "effective_due_date": "2024-11-11T23:59:59.999-03:00",
                    "id": "8e94720e-c025-4152-a6a2-823a47079f35",
                    "original_amount_cents": 52130,
                    "paid_at": null,
                    "payments": [],
                    "status": "canceled",
                    "updated_at": "2024-06-13T15:43:28.374-03:00"
                }
            ],
            "cancelation_reason": "refunded_by_company",
            "created_at": "2024-06-11T09:36:51.619-03:00",
            "due_day": 10,
            "finished_at": "2024-06-13T15:43:28.559-03:00",
            "id": "d9fe02d3-6535-4691-b03c-7cc94ac1b1f4",
            "installments": 6,
            "order_id": "17b6ecb3-58a8-40e6-9722-2ee41e64ekL8",
            "origin_billing_id": null,
            "payment_configuration": {
                "allowed_down_payment_methods": [
                    "credit_card"
                ],
                "availability": "archived",
                "down_payment_interest_rate": 0.0299,
                "down_payment_type": "absolute",
                "down_payment_value": 44287.0,
                "expires_in": 24,
                "financed_type": "card",
                "id": "ff8bc846-143a-45a1-b54c-e8c271393bfb",
                "installments": [
                    1,
                    2,
                    3,
                    4,
                    5,
                    6,
                    7,
                    8,
                    9,
                    10
                ],
                "interest_rate": 0.02,
                "max_down_payment_installments": 4,
                "max_installments": 10,
                "min_installment_amount_cents": 100,
                "payment_methods": [
                    "boleto",
                    "pix",
                    "credit_card"
                ],
                "payment_type": "financed",
                "registration_fee": 0.0197,
                "take_rate_type": "percentage",
                "take_rate_value": 1.0
            },
            "status": "canceled",
            "updated_at": "2024-07-19T17:00:57.851-03:00"
        },
        {
            "amount_cents": 290000,
            "amount_currency": "BRL",
            "bills": [
                {
                    "amount_cents": 290000,
                    "authentication_code": null,
                    "bill_type": "installment",
                    "billing": {
                        "amount_cents": 290000,
                        "amount_currency": "BRL",
                        "cancelation_reason": "down_payment_not_paid",
                        "created_at": "2024-06-11T09:35:48.890-03:00",
                        "due_day": 14,
                        "finished_at": "2024-06-11T09:36:54.061-03:00",
                        "id": "97b11cf4-ecaa-4419-b23d-fb30b5d3ffc2",
                        "installments": 1,
                        "order_id": "17b6ecb3-58a8-40e6-9722-2ee41e64ekL8",
                        "origin_billing_id": null,
                        "status": "canceled",
                        "updated_at": "2024-07-19T16:59:59.556-03:00"
                    },
                    "checkout_url": "https://pague-sandbox.lia.com.br/parcela/pagamento?bill_id=bd6ae3ef-2f95-4dd4-bc5c-8a1d69026173",
                    "created_at": "2024-06-11T09:35:48.964-03:00",
                    "current_amount_cents": 290000,
                    "disable_penalties_until": null,
                    "due_date": "2024-06-14T09:35:48.850-03:00",
                    "effective_due_date": "2024-06-14T09:35:48.850-03:00",
                    "id": "bd6ae3ef-2f95-4dd4-bc5c-8a1d69026173",
                    "original_amount_cents": 290000,
                    "paid_at": null,
                    "payments": [],
                    "status": "canceled",
                    "updated_at": "2024-06-11T09:36:54.046-03:00"
                }
            ],
            "cancelation_reason": "down_payment_not_paid",
            "created_at": "2024-06-11T09:35:48.890-03:00",
            "due_day": 14,
            "finished_at": "2024-06-11T09:36:54.061-03:00",
            "id": "97b11cf4-ecaa-4419-b23d-fb30b5d3ffc2",
            "installments": 1,
            "order_id": "17b6ecb3-58a8-40e6-9722-2ee41e64ekL8",
            "origin_billing_id": null,
            "payment_configuration": {
                "allowed_down_payment_methods": [],
                "availability": "archived",
                "down_payment_interest_rate": null,
                "down_payment_type": null,
                "down_payment_value": 0.0,
                "expires_in": 72,
                "financed_type": null,
                "id": "550498f2-8c3d-4ba4-9e62-1446ac834211",
                "installments": [
                    1
                ],
                "interest_rate": 0.0,
                "max_down_payment_installments": null,
                "max_installments": 1,
                "min_installment_amount_cents": 0,
                "payment_methods": [
                    "pix"
                ],
                "payment_type": "upfront",
                "registration_fee": 0.0,
                "take_rate_type": null,
                "take_rate_value": null
            },
            "status": "canceled",
            "updated_at": "2024-07-19T16:59:59.556-03:00"
        }
    ],
    "total_items": 2,
    "total_pages": 1
}