Jump to Content

Update Recurring Payment

patch

https://api-sandbox.urbanpayx.com/api/v1/recurring-payments/{definition_id}

Edit a recurring payment's amount/recipient/cadence in place.

Recent Requests

Log in to see full request history

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

definition_id

string

required

Body Params

Edits a recurring payment's amount/recipient/cadence. Changing any of
amount/recipient/project/description changes the find-or-create identity
conceptually, but here we're updating the SAME workflow row by id, so the
stored key is recomputed to match (kept in sync for future toggle-offs).

amount

required

currency

string

length between 3 and 3

Defaults to EUR

project_id

string

required

description

string

required

length between 1 and 500

user_id

business_customer_id

send_payer_email

boolean

Defaults to false

cadence

string

enum

required

Allowed:

timezone

string

length between 1 and 64

Defaults to UTC

hour

integer

0 to 23

Defaults to 9

minute

integer

0 to 59

Defaults to 0

day_of_week

day_of_month

1 to 28

custom_cron

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json