> ## Documentation Index
> Fetch the complete documentation index at: https://apidocs.synchpay.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Creating a Recurring Payment

> Create a recurring payment plan for a registered user or phone number.

Use `POST /Payment/Recurring` to create a recurring payment plan for one of your companies.

## Endpoint

* **URL**: `https://api.synchpay.com/Payment/Recurring`
* **Method**: `POST`
* **Authorization**: `Bearer <AccessToken>`

<Tip>
  The access token is obtained from [/auth/token](https://apidocs.synchpay.dev/api-reference/authentication/authenticate) using your `ClientId` and `ClientSecret`.
</Tip>

## Request Body

| Parameter            | Type    | Description                                                          | Required |
| -------------------- | ------- | -------------------------------------------------------------------- | -------- |
| `Amount`             | integer | Amount to charge on each recurrence, in cents.                       | Yes      |
| `StartDate`          | string  | First recurrence date in `YYYY-MM-DD` format.                        | Yes      |
| `IntervalValue`      | integer | Number of units between recurring payments.                          | Yes      |
| `IntervalUnit`       | string  | Recurrence unit: `Day`, `Week`, `Month`, `Quarter`, or `Year`.       | Yes      |
| `PhoneNumber`        | string  | Payer phone number. Use when `RegistrationUserId` is not provided.   | No       |
| `RegistrationUserId` | string  | SynchPay registered user ID. Use when `PhoneNumber` is not provided. | No       |
| `CompanyId`          | string  | SynchPay company ID.                                                 | No       |
| `CompanyReferenceId` | string  | Your external company reference ID.                                  | No       |

<Note>
  Provide either `PhoneNumber` or `RegistrationUserId` so SynchPay can identify the payer. Use either `CompanyId` or `CompanyReferenceId` when the plan should be scoped to a specific company.
</Note>

## Example Request

```json theme={null}
{
  "Amount": 5000,
  "StartDate": "2026-07-01",
  "IntervalValue": 1,
  "IntervalUnit": "Month",
  "RegistrationUserId": "6e8d9257-bd5f-45cf-8f29-6d0ae8a6d991",
  "CompanyReferenceId": "loc-001"
}
```

## Response

| Field           | Type   | Description                              |
| --------------- | ------ | ---------------------------------------- |
| `PaymentPlanId` | string | Unique ID of the recurring payment plan. |

```json theme={null}
{
  "PaymentPlanId": "d4e5f6a7-b8c9-0123-4567-89abcdef0123"
}
```

## Frequency Examples

| IntervalValue | IntervalUnit | Resulting schedule |
| ------------- | ------------ | ------------------ |
| `1`           | `Month`      | Every month        |
| `2`           | `Week`       | Every two weeks    |
| `1`           | `Quarter`    | Every quarter      |
| `7`           | `Day`        | Every seven days   |