Skip to main content

Documentation Index

Fetch the complete documentation index at: https://www.smartretry.com/docs/llms.txt

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

PUT /v1/payments/recurring/update/{terminal_friendly_id} Updates configuration for an active recurring series. You can change the billing amount, frequency, total payment count, or cancellation date. Only fields you include in the request body are updated - omitted fields retain their current values.
Scheduling fields (recurring_date_type, time_interval) can only be updated on series where managed_by is our_platform. Attempting to update these fields on a merchant- or payment_provider-managed series returns an error.
curl --request PUT \
  --url https://api.smartretry.com/v1/payments/recurring/update/ABC123 \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_API_KEY' \
  --data '{
    "recurring_id": "RC9F4A2B",
    "amount": 24.99,
    "number_of_payments": 24
  }'

​
Path parameters

​
terminal_friendly_id
string
required
Your 6-character terminal identifier.

​
Request body

​
recurring_id
string
required
The 8-character identifier of the recurring series to update.
​
amount
number
New default charge amount for future payments in this series, in major currency units (e.g., 24.99 for $24.99). Does not affect charges that have already been processed.
​
first_payment_date
string
New start date for the series in YYYY-MM-DD format. Only supported when managed_by is our_platform.
​
recurring_date_type
string
New billing frequency. One of daily, weekly, monthly, or yearly. Only supported when managed_by is our_platform.
​
time_interval
integer
New interval multiplier. Minimum value: 1. Only supported when managed_by is our_platform.
​
number_of_payments
integer
New total payment count for the series. Minimum value: 1. The count includes payments already completed - setting this to a value lower than completed_payments will immediately complete the series.

​
Response

​
recurring_id
string
The identifier of the updated recurring series (8 characters).
​
accepted
boolean
true if the update was applied successfully.
Example response
{
  "recurring_id": "RC9F4A2B",
  "accepted": true
}
To preview how a schedule change affects upcoming payments before applying it, call the status endpoint first to review current future_transactions.