API Reference

Update a Recurring Charge

patch
{base_url}/api/distributor/v1/recurring_charges/

Updates mutable fields (total_amount, end_date) and/or drives a lifecycle transition via action (pause, resume, cancel). Mutable fields apply to future runs; invalid transitions return 409. The funding source is not a partner-facing field and cannot be switched here.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
float

Applies to future runs only. At most 2 decimal places; a more precise amount is rejected (422).

date | null

Add/extend/clear the end date.

string
enum

Optional lifecycle verb: pause, resume, cancel. Invalid transitions return 409, as does any mutation of a canceled or completed schedule.

Allowed:
Responses

401

unauthorized request

403

forbidden request

404

out-of-scope schedule

409

invalid lifecycle transition

422

invalid total_amount

Updated about 2 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?