v1
latestOpenAPI 3.0.12026-07-263591116.9 KBSubscriptions V2
List of Subscriptions
get/v2/subscriptions/list
Query parameters
start_datestring required
Start date for the list, [DD-MM-YYY]
end_datestring required
End date for the list, [DD-MM-YYY]
status'all' | 'active' | 'expired' | 'error' | 'cancelled'
Filter list based on status of the document
num_recordsstring
Number of records to fetch
pageinteger
Page number
customer_idstring
Customer ID
Response
Subscription List fetched successfully
Example response
{
"success": true,
"message": "Details Fetched",
"data": {
"transactions": [
{
"customer_id": "Cust123",
"customer_name": "CUST123",
"subscription_date": "10 June 2024",
"subscription_start_time": "10 June 2024",
"subscription_end_time": "10 Aug 2024",
"sub_serial_number": "SUB-123",
"repeat_every": 1,
"repeat_unit": "months",
"status": "active",
"invoice_count": 1,
"invoices": [
{
"name": "CUST123",
"id": "Cust123",
"serial_number": "INV-123",
"status": "active",
"hash_id": "SUB123",
"record_time": "10 June 2024",
"total_amount": 1000
}
],
"last_created_invoice": "10 June 2024",
"upcoming_date": "10 June 2024",
"hash_id": "SUB123",
"total_amount": 1000
}
],
"total_records": 10
}
}