# GET /api/invoicing/recurring-schedules

Recurring schedules: Retrieves a filtered list of recurring invoice schedules.

The paging shape of this endpoint is provisional and is expected to move to continuation
tokens, so integrators should not rely on the current offset parameters as a stable
contract. Filter by biller, status, and creation
time instead of paging deeply.

**Operation ID:** `recurringInvoiceScheduleGetList`

## Authorization

Requires: Invoicing.RecurringSchedules, merchant scope.

Requires API key scope: `admin`

Required permissions:
- `Invoicing.RecurringSchedules`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| BillerId | query | no | string(uuid) | Filter by billing entity. Required for partition-scoped queries. |
| Status | query | no | [RecurringInvoiceScheduleStatus](https://devportal.demo.winkpg.io/docs/api/models/RecurringInvoiceScheduleStatus.md) | Filter by series status. |
| MinCreationTime | query | no | string(date-time) | Filter to series created on or after this time (CreationTime date-range chip lower bound). |
| MaxCreationTime | query | no | string(date-time) | Filter to series created on or before this time (CreationTime date-range chip upper bound). |
| Filter | query | no | string | Gets or sets a general filter string for the result set. |
| Name | query | no | string | Gets or sets the name filter for the result set. |
| IncludeDeleted | query | no | boolean | Gets or sets a value indicating whether to include deleted entities in the result set. |
| IncludeInactive | query | no | boolean | Gets or sets a value indicating whether to include inactive entities in the result set. |
| Ids | query | no | array<string(uuid)> | Gets or sets a list of entity IDs to filter the result set. |
| Sorting | query | no | string |  |
| SkipCount | query | no | integer(int32) |  |
| MaxResultCount | query | no | integer(int32) |  |
| ExtraProperties | query | no | object |  |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

**`Status` values**

| Value | Description |
| --- | --- |
| `Active` | The series is active and generates invoices on each due run. |
| `Paused` | Generation is suspended; the series can be resumed later. No invoices are generated while paused. |
| `Cancelled` | The series has been cancelled. Terminal: no further generation. |
| `Completed` | The series reached its end (end date or max occurrences). Terminal: no further generation. |

## Responses

### 200

OK

**Content type:** `application/json`

Schema: [`PagedResultDtoOfRecurringInvoiceScheduleDto`](https://devportal.demo.winkpg.io/docs/api/models/PagedResultDtoOfRecurringInvoiceScheduleDto.md)

Properties:
- `items` (array<[RecurringInvoiceScheduleDto](https://devportal.demo.winkpg.io/docs/api/models/RecurringInvoiceScheduleDto.md)>): (nullable)
  Fields of each item:
  - `id` (string(uuid))
  - `creationTime` (string(date-time)): The date and time when this entity was created.
  - `creatorId` (string(uuid)): The ID of the user who created this entity. (nullable)
  - `lastModificationTime` (string(date-time)): The date and time when this entity was last modified. (nullable)
  - `lastModifierId` (string(uuid)): The ID of the user who last modified this entity. (nullable)
  - `isDeleted` (boolean): Indicates whether this entity has been deleted.
  - `deleterId` (string(uuid)): The ID of the user who deleted this entity, if it is deleted. (nullable)
  - `deletionTime` (string(date-time)): The date and time when this entity was deleted, if it is deleted. (nullable)
  - `billerId` (string(uuid))
  - `billerType` ([InvoicePartyType](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartyType.md)): Identifies the type of entity acting as the biller or recipient on an invoice.
    Values:
    - `GatewayOwner`: Platform-level gateway owner.
    - `Reseller`: Reseller entity.
    - `Merchant`: Merchant entity.
    - `Customer`: End customer.
  - `name` (string): (nullable)
  - `description` (string): (nullable)
  - `status` ([RecurringInvoiceScheduleStatus](https://devportal.demo.winkpg.io/docs/api/models/RecurringInvoiceScheduleStatus.md)): Lifecycle status of a recurring invoice schedule (series).
    Values:
    - `Active`: The series is active and generates invoices on each due run.
    - `Paused`: Generation is suspended; the series can be resumed later. No invoices are generated while paused.
    - `Cancelled`: The series has been cancelled. Terminal: no further generation.
    - `Completed`: The series reached its end (end date or max occurrences). Terminal: no further generation.
  - `schedule` ([ContractSchedule](https://devportal.demo.winkpg.io/docs/api/models/ContractSchedule.md))
  - `nextRunUtc` (string(date-time)): (nullable)
  - `lastRunUtc` (string(date-time)): (nullable)
  - `occurrenceCount` (integer(int32))
  - `endAfterOccurrences` (integer(int32)): (nullable)
  - `autoSend` (boolean)
  - `paymentLinkExpiryHours` (integer(int32)): (nullable)
  - `viewTokenExpiryDays` (integer(int32)): (nullable)
  - `customMessage` (string): (nullable)
  - `recipientId` (string(uuid))
  - `recipientType` ([InvoicePartyType](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartyType.md)): Identifies the type of entity acting as the biller or recipient on an invoice.
    Values:
    - `GatewayOwner`: Platform-level gateway owner.
    - `Reseller`: Reseller entity.
    - `Merchant`: Merchant entity.
    - `Customer`: End customer.
  - `currency` (string): (nullable)
  - `paymentTermsValue` ([PaymentTerms](https://devportal.demo.winkpg.io/docs/api/models/PaymentTerms.md)): (nullable)
    Values:
    - `DueOnReceipt`: Payment due immediately upon receipt.
    - `Net15`: Payment due within 15 days of issue.
    - `Net30`: Payment due within 30 days of issue.
    - `Net45`: Payment due within 45 days of issue.
    - `Net60`: Payment due within 60 days of issue.
    - `Net90`: Payment due within 90 days of issue.
    - `Custom`: Custom number of days specified via InvoiceConsts.
  - `customPaymentDays` (integer(int32)): (nullable)
  - `allowPartialPayment` (boolean): (nullable)
  - `minimumPaymentAmount` (number(double)): (nullable)
  - `partialPaymentTolerance` (number(double)): (nullable)
  - `allowedPaymentMethods` (array<string>): (nullable)
  - `vaultRestriction` ([VaultRestriction](https://devportal.demo.winkpg.io/docs/api/models/VaultRestriction.md)): (nullable)
    Values:
    - `Any`: Allow any payment method (new or saved).
    - `AllowNewAndSaved`: Allow both new and saved payment methods.
    - `SavedOnly`: Only allow previously saved (vaulted) payment methods.
  - `hppPageId` (string(uuid)): (nullable)
  - `templateId` (string(uuid)): (nullable)
  - `invoiceLevelDiscount` ([InvoiceDiscountDto](https://devportal.demo.winkpg.io/docs/api/models/InvoiceDiscountDto.md))
  - `reminderConfig` ([InvoiceReminderConfigDto](https://devportal.demo.winkpg.io/docs/api/models/InvoiceReminderConfigDto.md))
  - `billerSnapshot` ([InvoicePartySnapshotDto](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartySnapshotDto.md))
  - `recipientSnapshot` ([InvoicePartySnapshotDto](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartySnapshotDto.md))
  - `lineItems` (array<[InvoiceLineItemDto](https://devportal.demo.winkpg.io/docs/api/models/InvoiceLineItemDto.md)>): (nullable)
  - `customFields` (array<[CustomFieldValueDto](https://devportal.demo.winkpg.io/docs/api/models/CustomFieldValueDto.md)>): (nullable)
  - `notes` (array<[EntityNote](https://devportal.demo.winkpg.io/docs/api/models/EntityNote.md)>): (nullable)
  - `recipientNote` (string): (nullable)
  - `footerText` (string): (nullable)
  - `concurrencyStamp` (string): (nullable)
- `totalCount` (integer(int64))

### 403

Forbidden

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 401

Unauthorized

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 400

Bad Request

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

_Example: Request failed validation_

One or more fields were rejected before any rule ran. error.code is null on the envelope and the causes are in validationErrors, one entry per failure. An entry carries code when the validator declared a publishable one, and memberPaths when the full path says more than members does (an element inside a collection, for example). Both keys are omitted when they would add nothing.

```json
{
  "error": {
    "code": "null",
    "message": "Your request is not valid!",
    "details": "The following errors were detected during validation.",
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": [
      {
        "message": "'Amount' must be greater than 0.",
        "members": [
          "amount"
        ]
      },
      {
        "message": "The card has expired.",
        "members": [
          "expirationDate"
        ],
        "code": "CardData:CardExpired"
      },
      {
        "message": "'Value' must not be empty.",
        "members": [
          "value"
        ],
        "memberPaths": [
          "customFields[2].value"
        ]
      }
    ]
  }
}
```

### 404

Not Found

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

_Example: Resource not found_

The id in the path names no record the caller can see. Most resources answer with a null error.code and a message naming the resource type and the id; a resource that publishes a not-found code in the catalog above carries it in error.code instead, so check for one before matching on the message.

```json
{
  "error": {
    "code": "null",
    "message": "There is no entity Transaction with id = 7d1f3a52-0c4e-4b8a-9e21-5a6b7c8d9e00!",
    "details": "null",
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": "null"
  }
}
```

### 501

Not Implemented

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 500

Internal Server Error

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### default

The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The [error reference](https://devportal.demo.winkpg.io/docs/errors.md) lists the values `error.code` can take.

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

_Example: Business rule refused the request_

The request was understood and rejected by a platform rule. This is the shape that carries a code from the catalog above, so branch on error.code rather than on the message text. The HTTP status is the one listed against the code.

```json
{
  "error": {
    "code": "Transactions:OperationNotAllowed",
    "message": "The operation 'Void' is not allowed on a Sale transaction with result 'Approved' and settlement state 'Settled'.",
    "details": "null",
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": "null"
  }
}
```

### 429

The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause.

**Content type:** `application/problem+json`

Schema: [`RateLimitProblemDetails`](https://devportal.demo.winkpg.io/docs/api/models/RateLimitProblemDetails.md)

Properties:
- `type` (string) required: The problem type identifier. Always the same value: the failure is the status code itself,  so there is no sub-type for a caller to branch on. (nullable)
- `title` (string) required: A short, human-readable summary of the problem type. (nullable)
- `status` (integer(int32)) required: The HTTP status code, repeated in the body as the problem-details format defines.
- `detail` (string) required: A human-readable explanation of this occurrence of the problem. (nullable)
- `retryAfterSeconds` (integer(int32)) required: How long to wait before retrying, in whole seconds, carrying the same figure as the  `Retry-After` header. Always at least one: a value of zero would invite an immediate  retry that is certain to be rejected again.

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

## Example request

Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.

### cURL

```bash
curl -X GET "{{BASE_URL}}/api/invoicing/recurring-schedules" \
  -H "api-key: {{API_KEY}}"
```

### PowerShell

```powershell
$headers = @{
    'api-key' = '{{API_KEY}}'
}

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/invoicing/recurring-schedules' `
    -Headers $headers
```

### TypeScript (SDK)

```bash
npm install @winkpg/winkpg-api
```

```typescript
import { Configuration, InvoicingApi } from '@winkpg/winkpg-api';

const api = new InvoicingApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.recurringInvoiceScheduleGetList();
```

### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/invoicing/recurring-schedules', {
  method: 'GET',
  headers: {
    "api-key": "{{API_KEY}}",
  },
});

const data = await response.json();
```

### C# (SDK)

```bash
dotnet add package WinkPg.Api.Client
```

```csharp
using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new InvoicingApi(config);
var result = await api.RecurringInvoiceScheduleGetListAsync();
```

### C# (raw HTTP)

```csharp
using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("GET"), "/api/invoicing/recurring-schedules");
request.Headers.Add("api-key", "{{API_KEY}}");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();
```

### Python (SDK)

```bash
pip install winkpg-api
```

```python
import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.InvoicingApi(client)
    result = api.recurring_invoice_schedule_get_list()
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

headers = {
    "api-key": "{{API_KEY}}",
}

response = requests.request(
    "GET",
    "{{BASE_URL}}/api/invoicing/recurring-schedules",
    headers=headers,
)
response.raise_for_status()
data = response.json()
```

## See also

- [All documentation](https://devportal.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.