Skip to main content
GET
/
api
/
v1
/
customers
/
{customer_id}
/
schedules
List customer schedules
curl --request GET \
  --url https://api.config.money/api/v1/customers/{customer_id}/schedules \
  --header 'Authorization: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "status": "active",
      "amount": {
        "value": 123,
        "currency": "<string>"
      },
      "frequency": {
        "type": "daily",
        "day": 123,
        "interval": 123
      },
      "customer": {
        "type": "phone",
        "value": "<string>",
        "account_number": "<string>",
        "sort_code": "<string>"
      },
      "description": "<string>",
      "metadata": {},
      "next_payment_date": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "consent_url": "<string>"
    }
  ],
  "total": 123
}

​
List Customer Schedules

Retrieve all collection schedules associated with a specific customer.
This endpoint requires API key authentication. Include your API key in the Authorization header.

​
Endpoint

GET /api/v1/customers/{customer_id}/schedules

​
Headers

NameTypeDescription
AuthorizationstringYour API key in the format Bearer YOUR_API_KEY

​
Path Parameters

ParameterTypeDescription
customer_idstringID of the customer

​
Query Parameters

ParameterTypeDescription
limitintegerNumber of records to return (default: 10, max: 100)
offsetintegerNumber of records to skip (default: 0)

​
Response

​
Success Response (200 OK)

{
  "data": [
    {
      "id": "sched_123456789",
      "status": "active",
      "amount": {
        "value": 2000,
        "currency": "GBP"
      },
      "frequency": {
        "type": "monthly",
        "day": 1
      },
      "description": "Monthly phone plan",
      "next_payment_date": "2024-04-01T00:00:00Z",
      "created_at": "2024-03-20T10:00:00Z"
    },
    {
      "id": "sched_987654321",
      "status": "paused",
      "amount": {
        "value": 5000,
        "currency": "GBP"
      },
      "frequency": {
        "type": "weekly",
        "day": 1
      },
      "description": "Weekly subscription",
      "next_payment_date": "2024-03-25T00:00:00Z",
      "created_at": "2024-03-20T11:00:00Z"
    }
  ],
  "total": 2
}

​
Error Responses

​
401 Unauthorized

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid API key"
  }
}

​
404 Not Found

{
  "error": {
    "code": "not_found",
    "message": "Customer not found"
  }
}

​
429 Too Many Requests

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Too many requests"
  }
}

​
Examples

​
List All Schedules for a Customer

curl -X GET https://api.config.money/api/v1/customers/cust_123456789/schedules \
  -H "Authorization: Bearer YOUR_API_KEY"

​
List Schedules with Pagination

curl -X GET "https://api.config.money/api/v1/customers/cust_123456789/schedules?limit=20&offset=40" \
  -H "Authorization: Bearer YOUR_API_KEY"

Authorizations

​
Authorization
string
header
required

API key in the format 'Bearer YOUR_API_KEY'

Path Parameters

​
customer_id
string
required

ID of the customer

Query Parameters

​
limit
integer
default:10

Number of records to return

​
offset
integer
default:0

Number of records to skip

Response

200 - application/json

List of schedules

​
data
object[]
​
total
integer