Create a invoice

POST

/api/v1/invoices/create

Request

Header Params

Body Params application/json

Example

{
    "collection_method":"send_invoice"
    ,"currency":"USD"
    ,"customer_id":"{{customer-id}}"
    ,"description":"invoice desc"
    ,"metadata":{
        "youid":"your param"
    }
    ,"subscription_id":"{{subscription-id}}"
    ,"days_until_due":1
    ,"footer":"Footer to be displayed on the invoice"
 
    ,"total_amount":112
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://openapi1.uat.useepay.com/api/v1/invoices/create' \
--header 'x-merchant-no: 500000000007245' \
--header 'x-api-key: FUYTIUvjhgfytfuytwiue' \
--header 'x-app-id: www.pay.com' \
--header 'Content-Type: application/json' \
--data-raw '{
    "collection_method":"send_invoice"
    ,"currency":"USD"
    ,"customer_id":"cus_1JA7UDDQG3800"
    ,"description":"invoice desc"
    ,"metadata":{
        "youid":"your param"
    }
    ,"subscription_id":"sub_1JBQUBE5K0000"
    ,"days_until_due":1
    ,"footer":"Footer to be displayed on the invoice"
 
    ,"total_amount":112
}'

Responses

🟢200Success

application/json

Body

Example

{
    "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": "send_invoice",
    "customer_id": "cus_1JA7UDDQG3800",
    "hosted_invoice_url": null,
    "payment_intent": null,
    "period_end": null,
    "period_start": null,
    "subscription_id": "sub_1JBQGL23O0000",
    "total_amount": 112
}

🟠400Bad Request

Modified at 2025-04-01 08:34:04

Cancel a subscription

Retrieves a invoice