Skip to main content
PUT
cURL
Update an existing recurring series by its recurring_id. Only the optional fields included in the request body are changed.

Authorizations

x-api-key
string
header
required

Path Parameters

terminal_friendly_id
string
required

The unique identifier of the terminal.

Required string length: 6
Pattern: ^[\dA-Za-z]{6}$

Body

application/json
recurring_id
string
required

The recurring series identifier.

Required string length: 8
Pattern: ^[\dA-Za-z]{8}$
amount
number

New payment amount in major currency units (e.g. 10.00 for $10.00 USD).

Required range: 0.01 <= x <= 999999.99
number_of_payments
integer

New total number of payments.

Required range: x >= 1
first_payment_date
string

New start date (YYYY-MM-DD). Only changeable if original start date has not passed.

Pattern: ^\d{4}-\d{2}-\d{2}$
recurring_date_type
enum<string>
Available options:
daily,
weekly,
monthly,
yearly
time_interval
integer

New interval between payments.

Required range: x >= 1

Response

Default Response

recurring_id
string
required
Required string length: 8
Pattern: ^[\dA-Za-z]{8}$
updated
boolean
required