---
title: "Get forecast plan"
method: GET
path: "/rest/v2/plan-forecast"
tags: ["Forecast"]
---

# Get forecast plan

`GET /rest/v2/plan-forecast`

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

## Query parameters

- `frequency` 'WEEKLY,MONTHLY,YEARLY', required
- `frequency-day` 'range[1,28]', required
- `frequency-week` 'range[1,52]'
- `frequency-month` 'range[1,12]'

## Headers

- `api-key` string, required

## Response `200`

ok

- ForecastResponsePayload — payload
  - `forecast` Forecast — forecast
    - `dates` string[] — List of scheduled payment dates included in the forecast.
  - `payloadType` string — Type of payload returned in the response.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found

---

[API](https://skmtc.net/xplorpay/apis/external-us-onboarding-workflow.md) · [All operations](https://skmtc.net/xplorpay/apis/external-us-onboarding-workflow/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xplorpay/external-us-onboarding-workflow/revisions/f37077c24b66/schema)