GET /v1/invoices
List user invoices
Request
GET /v1/invoices
Parameters
[
{
"schema": {
"type": "string",
"enum": [
"pending",
"paid",
"overdue",
"cancelled"
]
},
"required": false,
"name": "status",
"in": "query"
},
{
"schema": {
"type": "string",
"default": "1"
},
"required": false,
"name": "page",
"in": "query"
},
{
"schema": {
"type": "string",
"default": "20"
},
"required": false,
"name": "limit",
"in": "query"
}
]
Response
{
"200": {
"description": "Invoices retrieved",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"invoices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"invoice_number": {
"type": "string"
},
"amount": {
"type": "number"
},
"currency": {
"type": "string"
},
"status": {
"type": "string"
},
"due_date": {
"type": "string"
},
"paid_at": {
"type": [
"string",
"null"
]
},
"subscription": {
"type": "object",
"properties": {
"package_name": {
"type": "string"
},
"billing_cycle": {
"type": "string"
}
},
"required": [
"package_name",
"billing_cycle"
]
},
"created_at": {
"type": "string"
}
},
"required": [
"id",
"invoice_number",
"amount",
"currency",
"status",
"due_date",
"paid_at",
"subscription",
"created_at"
]
}
},
"pagination": {
"type": "object",
"properties": {
"page": {
"type": "number"
},
"limit": {
"type": "number"
},
"total": {
"type": "number"
}
},
"required": [
"page",
"limit",
"total"
]
}
},
"required": [
"invoices",
"pagination"
]
}
},
"required": [
"success",
"message",
"data"
]
}
}
}
}
}
View in Interactive API Reference