v1
latestOpenAPI 3.1.02026-07-24170121.2 MBGet Invoices
Query parameters
A number that represents the number of records to be listed.
A number that represents the current page number.
In the specified number of days.
Invoice creation date. <br /><b>Format:</b> YYYY/MM/DD
Invoices created after or equal to date. <br /><b>Format:</b> YYYY/MM/DD
Invoices created before or equal to date. <br /><b>Format:</b> YYYY/MM/DD
Invoices created after date. <br /><b>Format:</b> YYYY/MM/DD
Invoice created before date. <br /><b>Format:</b> YYYY/MM/DD
Total is equal to
Total is greater than or equal to
Total is less than or equal to
Total is greater than
Total is less than
Invoice number contains
Invoice is a draft
Invoice is closed
An attempt was made to pay the invoice.
Invoice has been forgiven
Invoice is open for payment
Invoice is past due
Invoice has been paid
Search for invoices by name, email, description, invoice type, status amount, created date
Response
200
Example response
{
"data": [
{
"object": "Invoices",
"id": "B9ONZX995xBVY5E4",
"subscription_name": "test",
"subscription_id": "xlRP0jgPl0ljAXog",
"quantity": 1,
"customer_id": "jDPAnVxA4xPDVpKM",
"plan_id": "n2pv6j6p2pvj3Ygq",
"plan_amount": 99,
"billing": 1,
"invoice_number": "OQEC-0008",
"receipt_number": "OkJT-rMNW",
"paid": 1,
"period_end": 1726490836,
"period_start": 1726145236,
"statement_description": "dfghdfhg",
"currency": "usd",
"created_at": 1726145236,
"updated_at": 1726145236,
"created_by": "serviceuser0567051053675152@payarc.com",
"customer": {
"data": {
"object": "customer",
"customer_id": "jDPAnVxA4xPDVpKM",
"email": "eric.yulfo@payarc.com",
"source_id": "vmy905NNNNNM0M2L",
"created_at": 1724780945,
"updated_at": 1726145237,
"readable_created_at": "2 weeks ago",
"readable_updated_at": "2 hours ago",
"invoice_prefix": "OQEC",
"card": {
"data": [
{
"object": "Card",
"id": "5Pm20yPPPmv90Mv1",
"card_source": "PHONE",
"exp_month": "12",
"exp_year": "2025",
"is_verified": 1,
"fingerprint": "my905PmvmPNmNP0M",
"brand": "V",
"last4digit": "5439",
"first6digit": 401200,
"avs_status": "0",
"cvc_status": "M",
"customer_id": "jDPAnVxA4xPDVpKM",
"created_at": 1724780804,
"updated_at": 1724790052
}
]
}
}
}
}
],
"meta": {
"include": [
"subscriptions"
],
"pagination": {
"total": 7,
"count": 7,
"per_page": 10,
"current_page": 1,
"total_pages": 1
}
}
}