List all subscriptions
You can see a list of your subscriptions. The subscriptions are returned sorted by creation date, with the most recent appearing first. You can use this API method and the limit parameter to page through subscriptions.
ARGUMENTS
Scroll inside to view more
|
Argument
|
Description
|
|---|---|
customer optional
| Only return subscriptions for the customer specified by this identifier. If you pass this argument, you cannot also pass mandate.
|
limit optional, default is 100
| A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 100.
|
mandate optional
| Only return subscriptions for the mandate specified by this identifier. If you pass this argument, you cannot also pass customer.
|
page optional
| Returns all the subscription in the respective page.
|
Returns A dictionary with a data property that contains an array of up to limit subscriptions and when you pass page it will return you all the entries in the respective page.Passing an optional customer or mandate will result in filtering to subscriptions with only that exact object. Each entry in the array is a separate subscription object. If no more subscriptions are available, the resulting array will be empty. If you provide a non-existent related object identifier, this call returns an error.
Request
Response
API Endpoints
Sandbox Link
GET
https://api-test.lotuspay.com/v1/subscriptions
Production Link
GET
https://api.lotuspay.com/v1/subscriptions
- Have questions?
- Need help? Contact support
- LLM? Read llms.txt
