Skip to main content
GET
Preview recurring schedule change

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

consumer
integer
required

Consumer account ID.

Query Parameters

installment_type
enum<string>
required
Available options:
weekly,
bimonthly,
monthly

Response

Recurring schedule preview returned.

data
object | null
required

Numeric preview values for the Update Recurring Date dropdown. Money values are decimal strings so the frontend can format them consistently.

Last modified on July 19, 2026