Get all subscriptions

get

https://api.flutterwave.com/v3/subscriptions

This endpoint allows the developers to query all subscribers (cancelled subscriber included). You can do a single or bulk query with the endpoint depending on your use case.

Query Params

string

Defaults to [email protected]

This is the email of the subscriber. You can use this to query the transactions for a single customer.

transaction_id

int32

Defaults to 1190701

This is a unique transaction identifier generated by our systems. It is returned in the initiate charge response as data.id.

plan

int32

Defaults to 3874

This is the ID of the payment plan. It is returned in the call to create a payment plan as data.id.

subscribed_from

string

Defaults to 2020-01-01

This is the start date of the subscriptions(when they are first active). You can use this as a starting point for your query. The expected date format for this parameter is YYYY-MM-DD

subscribed_to

string

Defaults to 2020-05-05

This is the end date for a subscription. Like subscribed_from, It also has an expected date format of YYYY-MM-DD.

next_due_from

string

Defaults to 2020-01-01

This is the parameter to filter from the start date of the next due subscriptions.

next_due_to

string

Defaults to 2020-05-05

This is the parameter to filter to the end date of the next due subscriptions.

page

int32

Defaults to 1

This is the page number to retrieve e.g. setting 1 retrieves the first page.

status

string

Defaults to active

This is the status for the queried transactions. Expected values are active and cancelled.

Headers

Authorization

string

required

Defaults to Bearer FLWSECK_TEST-SANDBOXDEMOKEY-X

Pass your secret key as a bearer token in the request header to authorize this call

Responses

200200

400400