# Get data for upcoming calendar events

`GET /v2/statistics/calendar`

Core API v2, Statistics.

**Authentication:** Send `Authorization: Bearer <token>`. To authenticate, generate a Secret API Key from your ODUS Dashboard and include it in the `Authorization` header as follows: `Authorization: Bearer <YOUR_SECRET_API_KEY>`

## Parameters

### Query parameters

- `startDate` (string, required): Start date in ISO 8601 format. Example: `2026-01-01`.
- `endDate` (string): End date in ISO 8601 format. Defaults to the end of the current month if not provided. Example: `2026-01-31`.

## Responses

### `200`

OK

Type: object (CalendarDataDTO).

- `data` (array of object, required): Date for the calendar entry.
  - `date` (string, required): Date for the calendar entry. Example: `2025-09-02T19:25:42.282Z`.
  - `upcomingRecurringPayments` (number, required): Count of upcoming recurring payments for this date. Example: `5`.
  - `upcomingRetries` (number, required): Count of upcoming retries for this date. Example: `2`.
  - `successfulRebills` (number, required): Count of successful rebills for this date. Example: `3`.
  - `softDeclines` (number, required): Count of soft declines for this date. Example: `1`.
  - `hardDeclines` (number, required): Count of rebills for this date that will not recover on their own: the payment method was refused outright, or no authorization was attempted against it at all. It spans more than one decline type, so filtering the payment list on a single latestDeclineType value returns fewer payments than this count. Example: `0`.

### `202`

The merchant is entitled but its environment is not provisioned yet. Provisioning has been kicked off (exactly once) and is in progress; retry the request — it succeeds once the environment is ready. Returned only for identity-token (dashboard) requests bound to a merchant, not for secret-key API calls; any such endpoint can return it while provisioning is underway.

Type: object (ProvisioningInProgress).

- `status` (string, required): Signals the merchant environment is still being provisioned. One of `provisioning`.
- `merchantAccountId` (string, required): The merchant account whose environment is being provisioned. Example: `dAI3aa87ROOeupeBCjNSKCOBOisBCYjB`.

### Errors

- `400`: The request was rejected. `type` is `invalid_request_error` when the request itself is at fault — `errors` then lists every problem found, with field-attributable entries prefixed by the field’s path; or `invalid_state_error` when the request was well-formed but the resource is not in a state that allows it.
- `401`: No API key was supplied, or the key is not valid. `type` is `authentication_error`.
- `403`: The API key is valid but lacks the permission this operation requires. `type` is `permission_error`.
- `429`: Too many requests. A limit applies per operation; requests to other operations are unaffected. `type` is `rate_limit_error`. Use the `Retry-After-global` header to know when to retry.
- `500`: The request could not be completed because of an unexpected error. `type` is `api_error`.
- `503`: The request could not be served right now: the API is temporarily at capacity, or a dependency needed to authorize the request is unavailable — the auth service that verifies credentials, or the entitlement lookup behind it. `type` is `api_error`. It is raised before the operation runs, so the request had no effect, and unlike a plain 500 the condition is transient: retry with backoff.
- `504`: The request exceeded the processing time limit and was abandoned. `type` is `api_error` and `code` is `timeout` — unlike a plain 500 the request may still have taken effect, so retry with the same idempotency key rather than blindly.

Every error response has the same body: see [Errors](https://docs.odus.com/docs/guides/api-features/errors.md).

---

Generated from the Core API v2 OpenAPI document, https://api.odus.com/openapi.v2.json. Interactive page: https://docs.odus.com/docs/api/core/v2/statistics-controller-get-calendar-data