Get all billing cycles
GET/api/gateway/v1/settlement/billing-cycles
Get all billing cycles
Request
Query Parameters
Possible values: [INIT, IN_PROGRESS, CONFIRMED, SENT_TO_MONETA, FINALIZED, PENDING, CANCELLED]
Possible values: <= 50
Default value: 25
Number of items per page
Default value: 1
Page number
Default value: DESC
Order of the items
Key of the items
Header Parameters
Gateway API key
Responses
- 200
- 401
List of billing cycles
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Response status code
Response status message
data
object[]
required
Response data
Billing cycle code
Description of the billing cycle
Start date of billing period
End date of billing period
Possible values: [INIT, IN_PROGRESS, FINALIZED, PENDING, CANCELLED]
Status of the billing cycle
Total amount of charges in this billing cycle
Total amount paid in this billing cycle
Total amount unpaid in this billing cycle
Creation date
Request ID for tracking
meta
object
Pagination details, if applicable
Current page number
Number of items per page
Number of returned items
Total number of items
Total number of pages
Has next page
Has previous page
{
"status": 200,
"message": true,
"data": [
{
"code": "BC-2023-10",
"description": "Monthly billing cycle for October 2023",
"billingFrom": "2023-10-01T00:00:00Z",
"billingTo": "2023-10-31T23:59:59Z",
"status": "ACTIVE",
"totalAmount": 50000,
"totalPaid": 45000,
"totalUnPaid": 5000,
"createdAt": "2023-10-01T00:00:00Z"
}
],
"requestId": "req-123456",
"meta": {
"page": 1,
"perPage": 10,
"count": 10,
"totalCount": 100,
"totalPages": 10,
"hasNextPage": true,
"hasPrevPage": false
}
}
Unauthorized
- application/json
- Schema
- Example (from schema)
Schema
error
object
Error code
Error detail
{
"status": 401,
"message": "Invalid API key",
"error": {
"code": "UNAUTHORIZED",
"detail": "Invalid API key"
}
}