Forecast

Get Plan Forecast

get

Retrieve a forecast of upcoming plan payments based on the specified schedule parameters.

Query parameters

start-dateanyRequired

Specifies the start date for the forecast period. Format: YYYY-MM-DD.

frequencystring · enumRequired

Specifies how often the plan is billed. Supported values include day, week, and monthly.

Possible values:

frequency-daystring · enumRequired

Specifies the billing day based on the frequency.

Weekly: Day of the week (1-7).

Monthly/Yearly: Day of the month (1-31).

Possible values:

frequency-weekstring · enumOptional

Required when frequency is weekly. Specifies the weeks between payments.

Possible values:

frequency-monthstring · enumOptional

Specifies the month interval based on frequency.

Monthly: Number of months between payments.

Yearly: Month of the year (1-12) when the payment occurs.

Possible values:

end-dateanyOptional

Specifies the end date for the forecast period. Required when forecasting monthly plans. Format: YYYY-MM-DD.

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Responses

200

ok

application/jsonapplication/xml

payload

payloadTypestringOptional

Type of payload returned in the response.

401

Unauthorized

application/jsonapplication/xml

403

Forbidden

application/jsonapplication/xml

404

Not Found

application/jsonapplication/xml

get

/rest/v2/plan-forecast

HTTPcURLJavaScriptPython

GET /rest/v2/plan-forecast?frequency=WEEKLY%2CMONTHLY%2CYEARLY&frequency-day=range[1%2C28] HTTP/1.1
api-key: text
Accept: */*

{
  "forecast": {
    "dates": "string"
  },
  "payloadType": "text"
}