v1
latestOpenAPI 3.0.12026-07-2356172250.9 KBForecast
Get forecast plan
Retrieve a forecast of upcoming plan payments based on the specified schedule parameters.
get/rest/v2/plan-forecast
Query parameters
Specifies the start date for the forecast period. Format: YYYY-MM-DD.
frequency'WEEKLY,MONTHLY,YEARLY' required
Specifies how often the plan is billed. Supported values include day, week, and monthly.
frequency-day'range[1,28]' required
Specifies the billing day based on the frequency.
Weekly: Day of the week (1-7).
Monthly/Yearly: Day of the month (1-31).
frequency-week'range[1,52]'
Required when frequency is weekly. Specifies the weeks between payments.
frequency-month'range[1,12]'
Specifies the month interval based on frequency.
Monthly: Number of months between payments.
Yearly: Month of the year (1-12) when the payment occurs.
Specifies the end date for the forecast period. Required when forecasting monthly plans. Format: YYYY-MM-DD.
Headers
api-keystring required
An access API key issued to you by Xplor Pay.
Response
ok