Subscriptions
This endpoint allows you to retrieve recurring payments that occur daily, weekly, monthly, or yearly from transactions. The endpoint returns the transaction date, amount, the name of the service that the service subscribed to (e.g. Netflix), the subscription duration (i.e. yearly or monthly subscription), etc.
The expired subscriptions represent subscriptions with due dates that are no longer valid. while the non_expired ones are subscriptions with due dates that haven't expired.
GET Lookup Transactions that are subscriptions
1
{{baseUrl}}/api/v1/financial/account_subscription
Copied!
Params
Curl
Response
Parameters
Type
Description
account_id required
string
Account ID
gotten from the widget
status
string
Subscription that is either expired ornot_expired
start_date
string
Transaction Start Date
end_date
string
Transaction End Date
1
curl -L -X GET '{{baseUrl}}/api/v1/financial/account_subscription' \
2
-H 'Content-Type: application/json' \
3
-H 'Authorization: SECRET_KEY' \
4
-H 'AppId: APP_ID'
Copied!
1
{
2
"entity": {
3
"subscriptions": [
4
{
5
"id": 2344,
6
"transaction_date": "2020-08-27",
7
"value_date": "2020-08-27",
8
"tran_type": "debit",
9
"bank_name": "Guaranty Trust Bank",
10
"amount": "20000.00",
11
"reference": "0",
12
"narration": "NIBSS Instant Payment Outward 000013200827095534000141716971 Toba TO UBA/TOBA S OWOLABI /26.875/REF:000013200827095534000141716971",
13
"service": "mimi's confectionery",
14
"is_subscription": true,
15
"duration": "Monthly Subscription",
16
"next_date": "2020-09-26"
17
}
18
],
19
"Total": 1,
20
"previous_page": "",
21
"next_page": "",
22
"total_pages": 1,
23
"current_page": 1
24
}
25
}
Copied!
Last modified 1yr ago
Copy link