List all invoices

GET

/api/v1/invoices

Request

Query Params

Header Params

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request GET 'https://openapi1.uat.useepay.com/api/v1/invoices?page_num=0&page_size=3&from_created_at=2024-09-29T07:44:50.774Z&customer_id=cus_1JA7UDDQG3800&status=open' \
--header 'x-merchant-no: 500000000007245' \
--header 'x-api-key: FUYTIUvjhgfytfuytwiue' \
--header 'x-app-id: www.pay.com'

Responses

🟢200Success

application/json

Body

Example

{
    "items": [
        {
            "id": "inv_1JBQRUTEC0000",
            "code": null,
            "source": null,
            "message": null,
            "currency": "JPY",
            "description": "invoice desc",
            "metadata": {
                "youid": "your param"
            },
            "status": "open",
            "footer": "Footer to be displayed on the invoice",
            "number": "invoicenum000000001",
            "merchant_no": "500000000007264",
            "app_id": "www.pay.com",
            "create_at": "2024-10-28T07:17:43Z",
            "modify_at": "2024-10-28T07:17:43Z",
            "decline_code": null,
            "doc_url": null,
            "collection_method": "charge_automatically",
            "customer_id": "cus_1JA7UDDQG3800",
            "hosted_invoice_url": null,
            "payment_intent": null,
            "period_end": null,
            "period_start": null,
            "subscription_id": "sub_1JBQGL23O0000",
            "total_amount": 112
        },
        {
            "id": "inv_1JBQUCEC40000",
            "code": null,
            "source": null,
            "message": null,
            "currency": "JPY",
            "description": "invoice desc update1",
            "metadata": {
                "youid": "your param"
            },
            "status": "open",
            "footer": "Footer to be displayed on the invoice",
            "number": "invoicenum000000001",
            "merchant_no": "500000000007264",
            "app_id": "www.pay.com",
            "create_at": "2024-10-28T07:28:18Z",
            "modify_at": "2024-10-28T07:32:19Z",
            "decline_code": null,
            "doc_url": null,
            "collection_method": "charge_automatically",
            "customer_id": "cus_1JA7UDDQG3800",
            "hosted_invoice_url": null,
            "payment_intent": null,
            "period_end": null,
            "period_start": null,
            "subscription_id": "sub_1JBQUBE5K0000",
            "total_amount": 112
        }
    ],
    "has_more": false
}

Modified at 2025-01-14 05:33:06

Update a invoice

Pay a invoice