Get forecast plan
Retrieve a forecast of upcoming plan payments based on the specified schedule parameters.
Query parameters
Specifies the start date for the forecast period. Format: YYYY-MM-DD.
Specifies how often the plan is billed. Supported values include day, week, and monthly.
Specifies the billing day based on the frequency.
Weekly: Day of the week (1-7).
Monthly/Yearly: Day of the month (1-31).
Required when frequency is weekly. Specifies the weeks between payments.
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
An access API key issued to you by Xplor Pay.
Response
ok
Changes
No recorded changes to this endpoint across all 1 revision of this API.