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

# Scheduled Payments Overview

> Overview of scheduled payments resource and field definitions

Scheduled payments represent a transaction that will take place in the future. This may be a recurring credit or debit — such as a power bill or paycheck — or any other transaction whose date of occurence is known.

<Note>
  Scheduled payments are tied to the `user_guid`, not each specific account GUID. There can only be one scheduled payment per merchant. For example, if a user has two streaming subscriptions through one merchant, there can only be one scheduled payment tied to that merchant for the user.
</Note>

## Scheduled Payment Fields

| Field Name              | Data Type | Definition                                                                                                                                                                           |
| :---------------------- | :-------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `amount`                | `decimal` | The amount of the scheduled\_payment.                                                                                                                                                |
| `created_at`            | `string`  | Date and time the scheduled\_payment was created, represented in ISO 8601 format with timestamp (e.g., 2015-04-13T12:01:23-00:00).                                                   |
| `description`           | `string`  | A human-readable description of the scheduled\_payment, e.g., Power bill.                                                                                                            |
| `guid`                  | `string`  | The unique identifier for the scheduled\_payment, such as a recurring utility bill or streaming subscription. Defined by MX.                                                         |
| `is_completed`          | `boolean` | Indicates whether the scheduled\_payment has been paid or not. This field is only applicable to one-time transactions.                                                               |
| `is_recurring`          | `boolean` | Indicates whether the scheduled\_payment is expected to repeat.                                                                                                                      |
| `merchant_guid`         | `string`  | The unique identifier for the merchant identified in the scheduled\_payment.                                                                                                         |
| `occurs_on`             | `string`  | The date on which the payment is scheduled to occur, given in ISO 8601 format without a timestamp.                                                                                   |
| `recurrence_day`        | `integer` | The day of the month where the next payment is expected to occur.                                                                                                                    |
| `recurrence_type_name`  | `string`  | The repeatable pattern for the scheduled\_payment, given as a string.                                                                                                                |
| `recurrence_type`       | `integer` | The repeatable pattern for the scheduled\_payment, given as an integer.                                                                                                              |
| `transaction_type`      | `integer` | Indicates whether the transaction is a credit or a debit. 1 = CREDIT, 2 = DEBIT.                                                                                                     |
| `transaction_type_name` | `string`  | Indicates whether the transaction is a credit or a debit. 1 = CREDIT, 2 = DEBIT.                                                                                                     |
| `updated_at`            | `string`  | Date and time the scheduled\_payment was last updated, represented in ISO 8601 format with timestamp (e.g., 2015-04-13T12:01:23-00:00).                                              |
| `user_guid`             | `string`  | The unique identifier for the user associated with a scheduled\_payment. Scheduled payments are attached to the user\_guid, not individual accounts held by the user. Defined by MX. |

## Recurrence Type and Recurrence Type Name

| Value | Definition            |
| :---- | :-------------------- |
| 0     | `UNKNOWN`             |
| 1     | `EVERY_WEEK`          |
| 2     | `EVERY_OTHER_WEEK`    |
| 3     | `EVERY_MONTH`         |
| 4     | `EVERY_OTHER_MONTH`   |
| 5     | `EVERY_QUARTER`       |
| 6     | `EVERY_OTHER_QUARTER` |
| 7     | `EVERY_YEAR`          |

## Recurrence Day

| Recurrence Type                                                            | Valid Recurrence Day Values                                                                                                                                   |
| :------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `EVERY_YEAR`                                                               | The day of the year. This can range from 1 to 365.                                                                                                            |
| `EVERY_MONTH`, `EVERY_OTHER_MONTH`, `EVERY_QUARTER`, `EVERY_OTHER_QUARTER` | The day of the month. This can range from 1 to 31. If `recurrence_day` is greater than the number of days in a month, it occurs on the last day of the month. |
| `EVERY_WEEK`, `EVERY_OTHER_WEEK`                                           | The day of the week. This can range from 1 to 7.                                                                                                              |
