Skip to main content
PUT
/
api
/
v1
/
schedules
/
{id}
Update a direct debit schedule
curl --request PUT \
  --url https://api.config.money/api/v1/schedules/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "metadata": {},
  "start_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z",
  "max_retries": 123,
  "status": "active"
}
'
{
  "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>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.config.money/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key in the format 'Bearer YOUR_API_KEY'

Path Parameters

​
id
string
required

ID of the schedule to update

Body

application/json
​
amount
object
​
frequency
object
​
description
string

Description of the payment for customer reference

​
metadata
object

Additional data to store with the schedule

​
start_date
string<date-time>

ISO 8601 date when the schedule should start

​
end_date
string<date-time>

ISO 8601 date when the schedule should end

​
max_retries
integer

Maximum number of retry attempts for failed payments

​
status
enum<string>

New status for the schedule

Available options:
active,
paused,
cancelled

Response

Schedule updated successfully

​
id
string

Unique schedule identifier

​
status
enum<string>

Schedule status

Available options:
active,
paused,
cancelled
​
amount
object
​
frequency
object
​
customer
object
​
description
string
​
metadata
object
​
next_payment_date
string<date-time>
​
created_at
string<date-time>
​
consent_url
string<uri>

URL to the customer portal where consent for collections can be given