Recurring schedules: Creates a new recurring invoice schedule.

POST /api/invoicing/recurring-schedules deprecated

Requires: Invoicing.RecurringSchedules, Invoicing.RecurringSchedules.Create, merchant scope.

**Required permissions**: `Invoicing.RecurringSchedules`, `Invoicing.RecurringSchedules.Create` **Scope**: merchant

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.

The request body is a RecurringInvoiceScheduleCreateDto. See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X POST "{{BASE_URL}}/api/invoicing/recurring-schedules" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "",
  "schedule": {},
  "recipientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "currency": "",
  "lineItems": [
    {
      "description": ""
    }
  ],
  "billerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'

PowerShell

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

$body = @'
{
  "name": "",
  "schedule": {},
  "recipientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "currency": "",
  "lineItems": [
    {
      "description": ""
    }
  ],
  "billerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/invoicing/recurring-schedules' `
    -Headers $headers -ContentType 'application/json' -Body $body

npm install @winkpg/winkpg-api

TypeScript (SDK)

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

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

const { data } = await api.recurringInvoiceScheduleCreate({
  "name": "",
  "schedule": {},
  "recipientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "currency": "",
  "lineItems": [
    {
      "description": ""
    }
  ],
  "billerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/invoicing/recurring-schedules', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "",
    "schedule": {},
    "recipientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "currency": "",
    "lineItems": [
      {
        "description": ""
      }
    ],
    "billerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }),
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;
using System.Text.Json;

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

var api = new InvoicingApi(config);
var body = JsonSerializer.Deserialize<RecurringInvoiceScheduleCreateDto>("""
    {
      "name": "",
      "schedule": {},
      "recipientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "currency": "",
      "lineItems": [
        {
          "description": ""
        }
      ],
      "billerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
    """);

var result = await api.RecurringInvoiceScheduleCreateAsync(body);

C# (raw HTTP)

using System.Text;

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

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

request.Content = new StringContent("""
    {
      "name": "",
      "schedule": {},
      "recipientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "currency": "",
      "lineItems": [
        {
          "description": ""
        }
      ],
      "billerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
    """, Encoding.UTF8, "application/json");

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

pip install winkpg-api

Python (SDK)

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)
    body = winkpg_api.RecurringInvoiceScheduleCreateDto.from_dict({
      "name": "",
      "schedule": {},
      "recipientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "currency": "",
      "lineItems": [
        {
          "description": ""
        }
      ],
      "billerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    })
    result = api.recurring_invoice_schedule_create(body)

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
}

body = {
  "name": "",
  "schedule": {},
  "recipientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "currency": "",
  "lineItems": [
    {
      "description": ""
    }
  ],
  "billerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

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

Parameters

Name	In	Type	Description
`suppressNulls` required	query	boolean	If true, omit properties with null values.

Request body

application/json , required

Field	Type	Description
`name` required	string	Operator-facing name for the series. nullablemax length 200
`description` required	string	Optional operator-facing description. Conditional: When Description is not null. Max length: 1000. nullable
`schedule` required	all of ContractSchedule	The recurrence rule (frequency, interval, start date, optional end date).
`endAfterOccurrences` required	integer (int32)	Optional cap on the total number of invoices the series will generate. Conditional: When EndAfterOccurrences is not null. Must be > 0. nullable
`autoSend` required	boolean	When true, each generated invoice is auto-sent via the standard send workflow.
`paymentLinkExpiryHours` required	integer (int32)	Optional payment-link expiry (hours) applied when auto-sending. nullable
`viewTokenExpiryDays` required	integer (int32)	Optional view-token expiry (days) applied when auto-sending. nullable
`customMessage` required	string	Optional custom recipient message applied when auto-sending. Conditional: When CustomMessage is not null. Max length: 2000. nullable
`recipientId` required	string (uuid)	Who the generated invoices are billed to.
`recipientType` required	all of InvoicePartyType	The type of recipient entity.
`currency` required	string	ISO 4217 currency code for generated invoices. nullablemin length 3max length 3pattern ^[A-Za-z]{3}$
`paymentTermsValue` required	all of PaymentTerms	Payment terms applied to generated invoices. nullable
`customPaymentDays` required	integer (int32)	Custom number of days when PaymentTerms is Custom. nullable
`allowPartialPayment` required	boolean	Whether partial payments are allowed on generated invoices. nullable
`minimumPaymentAmount` required	number (double)	Minimum payment amount when partial payments are enabled. nullable
`partialPaymentTolerance` required	number (double)	Auto-mark-paid tolerance for generated invoices. nullable
`allowedPaymentMethods` required	array of string	Subset of supported payment methods allowed on generated invoices. nullable
`vaultRestriction` required	all of VaultRestriction	Vault restriction applied to generated invoices. nullable
`hppPageId` required	string (uuid)	Linked HPP configuration id. nullable
`templateId` required	string (uuid)	Invoice style/template reference (styling only). nullable
`invoiceLevelDiscount` required	all of InvoiceDiscountDto	Optional invoice-level discount applied to generated invoices.
`reminderConfig` required	all of InvoiceReminderConfigDto	Reminder configuration applied to generated invoices.
`billerSnapshot` required	all of InvoicePartySnapshotDto	Biller snapshot frozen onto each generated invoice at issue time.
`recipientSnapshot` required	all of InvoicePartySnapshotDto	Recipient snapshot frozen onto each generated invoice at issue time.
`lineItems` required	array of InvoiceLineItemInputDto	Line items copied onto each generated invoice. nullable
`customFields` required	array of CustomFieldValueDto	Custom field values copied onto each generated invoice. nullable
`notes` required	array of EntityNote	Internal notes copied onto each generated invoice. nullable
`recipientNote` required	string	Recipient-facing note copied onto each generated invoice. nullable
`footerText` required	string	Footer / terms text copied onto each generated invoice. nullable
`billerId` required	string (uuid)	The billing entity id. Cannot be changed after creation.
`billerType` required	all of InvoicePartyType	The type of billing entity.

This request body has no documented fields.