---
title: "Get a recurrence by ID"
method: GET
path: "/recurrences/{recurrence_id}"
tags: ["Recurrences"]
---

# Get a recurrence by ID

`GET /recurrences/{recurrence_id}`

## Request

- Base URL: `https://api.sandbox.monite.com/v1`
- URL: `https://api.sandbox.monite.com/v1/recurrences/{recurrence_id}`
- Auth: HTTP bearer

## Path parameters

- `recurrence_id` string, required

## Headers

- `x-monite-version` string, required
- `x-monite-entity-id` string, required

## Response `200`

Successful Response

- RecurrenceResponse
  - `id` string, uuid, required
  - `created_at` string, date-time, required: Time at which the recurrence was created. Timestamps follow the ISO 8601 standard.
  - `updated_at` string, date-time, required: Time at which the recurrence was last updated. Timestamps follow the ISO 8601 standard.
  - `automation_level` 'draft' | 'issue' | 'issue_and_send', required: Automation level for recurrence
  - `body_text` string: The body text for the email that will be sent with the recurring invoice.
  - `current_iteration` integer, required: Current iteration number
  - `day_of_month` 'first_day' | 'last_day', required
  - `end_date` string, date: The end date of the recurring invoice, in the `yyyy-mm-dd` format. The end date is inclusive, that is, the last invoice will be created on this date if the last occurrence falls on this date. `end_date` is mutually exclusive with `max_occurrences`. Either `end_date` or `max_occurrences` must be specified.
  - `end_month` integer: Deprecated, use `end_date` instead
  - `end_year` integer: Deprecated, use `end_date` instead
  - `frequency` 'day' | 'week' | 'month' | 'quarter' | 'year', required
  - `interval` integer, required: The interval between each occurrence of the invoice. For example, when using monthly frequency, an interval of 1 means invoices will be created every month, an interval of 2 means invoices will be created every 2 months.
  - `invoice_id` string, uuid, required: ID of the base invoice that will be used as a template for creating recurring invoices.
  - `iterations` RecurrenceIteration[], required: List of iterations for the recurrence
    - `issue_at` string, date, required
    - `issued_invoice_id` string, uuid
    - `iteration` integer
    - `status` 'pending' | 'completed' | 'canceled' | 'skipped' | 'issue_failed' | 'send_failed', required
  - `max_occurrences` integer: How many times the recurring invoice will be created. The recurrence will stop after this number is reached. `max_occurrences` is mutually exclusive with `end_date`. Either `max_occurrences` or `end_date` must be specified.
  - `recipients` Recipients
    - `bcc` string[]
    - `cc` string[]
    - `to` string[]
  - `start_date` string, date, required: The date when the first invoice will be created, in the `yyyy-mm-dd` format. Cannot be a past date. Subsequent invoice dates will be calculated based on `start_date`, `frequency`, and `interval`.
  - `start_month` integer, required: Deprecated, use `start_date` instead
  - `start_year` integer, required: Deprecated, use `start_date` instead
  - `status` 'active' | 'paused' | 'canceled' | 'completed', required: Represents the status of a recurrence Allowed transitions: - active -> paused - active -> canceled - active -> completed - paused -> active - paused -> canceled
  - `subject_text` string: The subject for the email that will be sent with the recurring invoice.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not found
- `422`: Validation Error
- `500`: Internal Server Error

---

[API](https://skmtc.dev/monite/apis/monite-3.md) - [All operations](https://skmtc.dev/monite/apis/monite-3/llms.txt) - [OpenAPI document](https://skmtc.dev/monite/apis/monite-3/revisions/c13be6f83ce9?raw)