DocumentationAPI ReferencesSupportBlogAsk AI
API References

Get payment plans

get
https://api.flutterwave.com/v3/payment-plans

This section describes how to fetch all payment plans on your account.

Query Params
string
Defaults to 2020-01-01

This is the specified date to start the list from. YYYY-MM-DD

string
Defaults to 2020-05-05

The is the specified end period for the search. YYYY-MM-DD

int32
Defaults to 1

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

int32
Defaults to 5000

This is the exact amount set when creating the payment plan

string
Defaults to NGN

This is the currency the payment plan amount is charged in

string
Defaults to weekly

This is how often the payment plan is set to execute

string
Defaults to active

This is the status of the payment plan

Headers
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

Updated over 1 year ago

Language
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated over 1 year ago