For archived content, access the previous documentation here or the previous API reference here.

Update Subscription Schedule

Prev Next
Get
/recurring/schedules/{id}

Updates the schedule configuration of a specific subscription plan.

Header parameters
for-user-id
string

The sub-account user-id to make this transaction for. This header is only used if you have access to xenPlatform. See xenPlatform for more information.

Path parameters
id
stringRequired

Xendit-generated recurring schedule ID, with prefix resc-xxx.

Responses
200

Successfully updated the schedule configuration.

object
reference_id
string

Merchant-provided identifier for the schedule.

interval
string

Frequency of the recurring cycles.

Valid values[ "DAY", "WEEK", "MONTH" ]
interval_count
integer

Number of intervals between consecutive cycles.

total_recurrence
integer | null

Total number of cycles (optional; runs indefinitely if null).

anchor_date
string (date-time)

Start date for the recurring schedule (ISO 8601 format).

retry_interval
string

Interval between retry attempts for failed payments.

Valid values[ "DAY" ]
retry_interval_count
integer

Number of retry intervals between consecutive retries.

total_retry
integer

Maximum number of retries for failed cycles.

failed_attempt_notifications
Array of integer

Notifications triggered at specific retry attempts.

integer