Skip to main content
GET
/
v1
/
recurring
Get Recurring Schedules
curl --request GET \
  --url https://api.peere.network/v1/recurring \
  --header 'Authorization: Bearer <token>'
{
  "statusCode": 200,
  "success": true,
  "data": {
    "schedules": [
      {
        "scheduleId": "<string>",
        "customerId": "<string>",
        "amount": 123,
        "currency": "<string>",
        "frequency": "<string>",
        "status": "<string>",
        "nextBillingDate": "2023-11-07T05:31:56Z"
      }
    ],
    "total": 123
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

customerId
string
status
enum<string>
Available options:
active,
paused,
cancelled
limit
integer
skip
integer

Response

Recurring schedules retrieved successfully

statusCode
integer
Example:

200

success
boolean
Example:

true

data
object