# Checkout Recurring Payment Jobs API

Automate the configuration of future payments for a Recurring Order.

The Recurring Payment Jobs API lets Checkout automate the configuration of the Recurring Cart associated with a [Recurring Order](/api/projects/recurring-orders.md), so that its future Orders can be paid using Checkout. To understand how Recurring Orders work with Checkout and their constraints, see [Recurring Orders in Checkout](/checkout/recurring-orders-in-checkout.md).

Use the Checkout Recurring Payment Jobs API only for Payments managed by Checkout.

When you create a [Recurring Order](/api/projects/recurring-orders.md), Checkout uses the Order's Recurring Payment Job to:

- Set the payment allocation of the Recurring Cart's `recurringPaymentConfiguration` to 100% of the [PaymentMethod](/search.md?urn=ctp:api:type:PaymentMethod).
- Create the [Recurring Payment](/checkout/recurring-payments-api.md) that links the [Recurring Order](/api/projects/recurring-orders.md) to the [PaymentMethod](/search.md?urn=ctp:api:type:PaymentMethod) and to the [Payment Connector](/checkout/connectors-and-applications.md#payment-connectors) responsible for processing its future payments.

A Recurring Payment Job is used only once to set up the future payments of a Recurring Order. After it has been processed, its `status` reflects the outcome, but Checkout no longer uses it.

If a Recurring Payment Job has not been processed yet by the time it is needed, Checkout automatically retries it until it succeeds or reaches the maximum number of 3 attempts.

## Scope

| Scope | Permission granted |
| --- | --- |
| `view_recurring_payment_jobs:{projectKey}` | View Recurring Payment Jobs |
| `manage_recurring_payment_jobs:{projectKey}` | Manage Recurring Payment Jobs |

## Get Recurring Payment Job

### Get Recurring Payment Job by ID

[endpoint definition](/search.md?urn=ctp:checkout:endpoint:/{projectKey}/recurring-payment-jobs/{id}:GET).

### Get Recurring Payment Job by Key

[endpoint definition](/search.md?urn=ctp:checkout:endpoint:/{projectKey}/recurring-payment-jobs/key={key}:GET).

## Query Recurring Payment Jobs

[endpoint definition](/search.md?urn=ctp:checkout:endpoint:/{projectKey}/recurring-payment-jobs:GET).

## Create Recurring Payment Job

[endpoint definition](/search.md?urn=ctp:checkout:endpoint:/{projectKey}/recurring-payment-jobs:POST).

## Delete Recurring Payment Job

### Delete Recurring Payment Job by ID

[endpoint definition](/search.md?urn=ctp:checkout:endpoint:/{projectKey}/recurring-payment-jobs/{id}:DELETE).

### Delete Recurring Payment Job by Key

[endpoint definition](/search.md?urn=ctp:checkout:endpoint:/{projectKey}/recurring-payment-jobs/key={key}:DELETE).

## Sort results

When querying Recurring Payment Jobs, you can sort the results using the `sort` query parameter. The following fields are available for sorting:

| Field | Description | Example |
| --- | --- | --- |
| `id` | Sort by Recurring Payment Job ID | `id asc` |
| `key` | Sort by Recurring Payment Job key | `key asc` |
| `createdAt` | Sort by creation timestamp | `createdAt desc` |
| `lastModifiedAt` | Sort by the last modified timestamp | `lastModifiedAt asc` |

### Sorting examples

**Basic sorting:**

```http title="Basic sorting"
GET /{projectKey}/recurring-payment-jobs?sort=createdAt%20desc
GET /{projectKey}/recurring-payment-jobs?sort=id%20asc
```

**Sorting with pagination:**

```http title="Sorting with pagination"
GET /{projectKey}/recurring-payment-jobs?sort=lastModifiedAt%20desc&limit=10&offset=0
```

## Representations

#### RecurringPaymentJob

[type definition](/search.md?urn=ctp:checkout:type:RecurringPaymentJob).

#### RecurringPaymentJobDraft

[type definition](/search.md?urn=ctp:checkout:type:RecurringPaymentJobDraft).

#### RecurringPaymentJobStatus

[type definition](/search.md?urn=ctp:checkout:type:RecurringPaymentJobStatus).

#### RecurringPaymentJobState

[type definition](/search.md?urn=ctp:checkout:type:RecurringPaymentJobState).

#### RecurringPaymentJobError

[type definition](/search.md?urn=ctp:checkout:type:RecurringPaymentJobError).

#### PaymentMethodReference

[type definition](/search.md?urn=ctp:checkout:type:PaymentMethodReference).

## Related pages

- [Area overview page with navigation](/checkout.md)
- [Previous page: Payment Intents](/checkout/payment-intents-api.md)
- [Next page: Recurring Payments](/checkout/recurring-payments-api.md)
- [Search documentation and API specs](/search.md)