Skip to content

Commit 4ce6472

Browse files
Merge pull request #88 from seunfapps/chore/filter-subscriptions
Add functionality to filter subscriptions
2 parents 643f137 + abf79cc commit 4ce6472

File tree

2 files changed

+12
-6
lines changed

2 files changed

+12
-6
lines changed

docs/subscription.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,12 @@ from paystackapi.subscription import Subscription
4242
response = Subscription.list()
4343
```
4444

45-
*Arguments*
45+
*Optional Arguments*
4646

47-
No argument required.
47+
- `perPage`: Number of results per page.
48+
- `page`: Pagination page number.
49+
- `customer`: Customer ID
50+
- `plan`: Plan ID
4851

4952
*Returns*
5053

paystackapi/subscription.py

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,17 +23,20 @@ def create(cls, **kwargs):
2323
return cls().requests.post('subscription', data=kwargs)
2424

2525
@classmethod
26-
def list(cls):
26+
def list(cls, **kwargs):
2727
"""
2828
List subscriptions.
2929
30-
Args:
31-
No argument required.
30+
Optional Args:
31+
perPage: Number of subscriptions listed per page for pagination
32+
page: pagination page number.
33+
customer: Customer ID.
34+
plan: Plan ID.
3235
3336
Returns:
3437
Json data from paystack API.
3538
"""
36-
return cls().requests.get('subscription')
39+
return cls().requests.get('subscription', qs=kwargs)
3740

3841
@classmethod
3942
def disable(cls, **kwargs):

0 commit comments

Comments
 (0)