# PUT /api/invoicing/recurring-schedules/{id} Recurring schedules: Updates an existing recurring invoice schedule by id. **Required permissions**: `Invoicing.RecurringSchedules`, `Invoicing.RecurringSchedules.Update` **Scope**: merchant **Operation ID:** `recurringInvoiceScheduleUpdate` ## Authorization Requires: Invoicing.RecurringSchedules, Invoicing.RecurringSchedules.Update, merchant scope. Required permissions: - `Invoicing.RecurringSchedules` - `Invoicing.RecurringSchedules.Update` ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | id | path | yes | string(uuid) | | | suppressNulls | query | no | boolean | If true, omit properties with null values. | ## Request Body **Content type:** `application/json` Schema: `RecurringInvoiceScheduleUpdateDto` Properties: - `name` (string) required: Operator-facing name for the series. - `description` (string): Optional operator-facing description. Conditional: When Description is not null. Max length: 1000. - `schedule` (object) required: The recurrence rule (frequency, interval, start date, optional end date). - `endAfterOccurrences` (integer(int32)): Optional cap on the total number of invoices the series will generate. Conditional: When EndAfterOccurrences is not null. Must be > 0. - `autoSend` (boolean): When true, each generated invoice is auto-sent via the standard send workflow. - `paymentLinkExpiryHours` (integer(int32)): Optional payment-link expiry (hours) applied when auto-sending. - `viewTokenExpiryDays` (integer(int32)): Optional view-token expiry (days) applied when auto-sending. - `customMessage` (string): Optional custom recipient message applied when auto-sending. Conditional: When CustomMessage is not null. Max length: 2000. - `recipientId` (string(uuid)) required: Who the generated invoices are billed to. - `recipientType` (object): The type of recipient entity. - `currency` (string) required: ISO 4217 currency code for generated invoices. - `paymentTermsValue` (object): Payment terms applied to generated invoices. - `customPaymentDays` (integer(int32)): Custom number of days when PaymentTerms is Custom. - `allowPartialPayment` (boolean): Whether partial payments are allowed on generated invoices. - `minimumPaymentAmount` (number(double)): Minimum payment amount when partial payments are enabled. - `partialPaymentTolerance` (number(double)): Auto-mark-paid tolerance for generated invoices. - `allowedPaymentMethods` (array): Subset of supported payment methods allowed on generated invoices. - `vaultRestriction` (object): Vault restriction applied to generated invoices. - `hppPageId` (string(uuid)): Linked HPP configuration id. - `templateId` (string(uuid)): Invoice style/template reference (styling only). - `invoiceLevelDiscount` (object): Optional invoice-level discount applied to generated invoices. - `reminderConfig` (object): Reminder configuration applied to generated invoices. - `billerSnapshot` (object): Biller snapshot frozen onto each generated invoice at issue time. - `recipientSnapshot` (object): Recipient snapshot frozen onto each generated invoice at issue time. - `lineItems` (array) required: Line items copied onto each generated invoice. - `customFields` (array): Custom field values copied onto each generated invoice. - `notes` (array): Internal notes copied onto each generated invoice. - `recipientNote` (string): Recipient-facing note copied onto each generated invoice. - `footerText` (string): Footer / terms text copied onto each generated invoice. - `concurrencyStamp` (string): Optimistic concurrency stamp. **Content type:** `text/json` Schema: `RecurringInvoiceScheduleUpdateDto` Properties: - `name` (string) required: Operator-facing name for the series. - `description` (string): Optional operator-facing description. Conditional: When Description is not null. Max length: 1000. - `schedule` (object) required: The recurrence rule (frequency, interval, start date, optional end date). - `endAfterOccurrences` (integer(int32)): Optional cap on the total number of invoices the series will generate. Conditional: When EndAfterOccurrences is not null. Must be > 0. - `autoSend` (boolean): When true, each generated invoice is auto-sent via the standard send workflow. - `paymentLinkExpiryHours` (integer(int32)): Optional payment-link expiry (hours) applied when auto-sending. - `viewTokenExpiryDays` (integer(int32)): Optional view-token expiry (days) applied when auto-sending. - `customMessage` (string): Optional custom recipient message applied when auto-sending. Conditional: When CustomMessage is not null. Max length: 2000. - `recipientId` (string(uuid)) required: Who the generated invoices are billed to. - `recipientType` (object): The type of recipient entity. - `currency` (string) required: ISO 4217 currency code for generated invoices. - `paymentTermsValue` (object): Payment terms applied to generated invoices. - `customPaymentDays` (integer(int32)): Custom number of days when PaymentTerms is Custom. - `allowPartialPayment` (boolean): Whether partial payments are allowed on generated invoices. - `minimumPaymentAmount` (number(double)): Minimum payment amount when partial payments are enabled. - `partialPaymentTolerance` (number(double)): Auto-mark-paid tolerance for generated invoices. - `allowedPaymentMethods` (array): Subset of supported payment methods allowed on generated invoices. - `vaultRestriction` (object): Vault restriction applied to generated invoices. - `hppPageId` (string(uuid)): Linked HPP configuration id. - `templateId` (string(uuid)): Invoice style/template reference (styling only). - `invoiceLevelDiscount` (object): Optional invoice-level discount applied to generated invoices. - `reminderConfig` (object): Reminder configuration applied to generated invoices. - `billerSnapshot` (object): Biller snapshot frozen onto each generated invoice at issue time. - `recipientSnapshot` (object): Recipient snapshot frozen onto each generated invoice at issue time. - `lineItems` (array) required: Line items copied onto each generated invoice. - `customFields` (array): Custom field values copied onto each generated invoice. - `notes` (array): Internal notes copied onto each generated invoice. - `recipientNote` (string): Recipient-facing note copied onto each generated invoice. - `footerText` (string): Footer / terms text copied onto each generated invoice. - `concurrencyStamp` (string): Optimistic concurrency stamp. **Content type:** `application/*+json` Schema: `RecurringInvoiceScheduleUpdateDto` Properties: - `name` (string) required: Operator-facing name for the series. - `description` (string): Optional operator-facing description. Conditional: When Description is not null. Max length: 1000. - `schedule` (object) required: The recurrence rule (frequency, interval, start date, optional end date). - `endAfterOccurrences` (integer(int32)): Optional cap on the total number of invoices the series will generate. Conditional: When EndAfterOccurrences is not null. Must be > 0. - `autoSend` (boolean): When true, each generated invoice is auto-sent via the standard send workflow. - `paymentLinkExpiryHours` (integer(int32)): Optional payment-link expiry (hours) applied when auto-sending. - `viewTokenExpiryDays` (integer(int32)): Optional view-token expiry (days) applied when auto-sending. - `customMessage` (string): Optional custom recipient message applied when auto-sending. Conditional: When CustomMessage is not null. Max length: 2000. - `recipientId` (string(uuid)) required: Who the generated invoices are billed to. - `recipientType` (object): The type of recipient entity. - `currency` (string) required: ISO 4217 currency code for generated invoices. - `paymentTermsValue` (object): Payment terms applied to generated invoices. - `customPaymentDays` (integer(int32)): Custom number of days when PaymentTerms is Custom. - `allowPartialPayment` (boolean): Whether partial payments are allowed on generated invoices. - `minimumPaymentAmount` (number(double)): Minimum payment amount when partial payments are enabled. - `partialPaymentTolerance` (number(double)): Auto-mark-paid tolerance for generated invoices. - `allowedPaymentMethods` (array): Subset of supported payment methods allowed on generated invoices. - `vaultRestriction` (object): Vault restriction applied to generated invoices. - `hppPageId` (string(uuid)): Linked HPP configuration id. - `templateId` (string(uuid)): Invoice style/template reference (styling only). - `invoiceLevelDiscount` (object): Optional invoice-level discount applied to generated invoices. - `reminderConfig` (object): Reminder configuration applied to generated invoices. - `billerSnapshot` (object): Biller snapshot frozen onto each generated invoice at issue time. - `recipientSnapshot` (object): Recipient snapshot frozen onto each generated invoice at issue time. - `lineItems` (array) required: Line items copied onto each generated invoice. - `customFields` (array): Custom field values copied onto each generated invoice. - `notes` (array): Internal notes copied onto each generated invoice. - `recipientNote` (string): Recipient-facing note copied onto each generated invoice. - `footerText` (string): Footer / terms text copied onto each generated invoice. - `concurrencyStamp` (string): Optimistic concurrency stamp. ## Responses ### 200 OK **Content type:** `application/json` Schema: `RecurringInvoiceScheduleDto` Properties: - `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. - `lastModificationTime` (string(date-time)): The date and time when this entity was last modified. - `lastModifierId` (string(uuid)): The ID of the user who last modified this entity. - `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. - `deletionTime` (string(date-time)): The date and time when this entity was deleted, if it is deleted. - `billerId` (string(uuid)) - `billerType` (InvoicePartyType): Identifies the type of entity acting as the biller or recipient on an invoice. - `name` (string) - `description` (string) - `status` (RecurringInvoiceScheduleStatus): Lifecycle status of a recurring invoice schedule (series). - `schedule` (ContractSchedule) - `nextRunUtc` (string(date-time)) - `lastRunUtc` (string(date-time)) - `occurrenceCount` (integer(int32)) - `endAfterOccurrences` (integer(int32)) - `autoSend` (boolean) - `paymentLinkExpiryHours` (integer(int32)) - `viewTokenExpiryDays` (integer(int32)) - `customMessage` (string) - `recipientId` (string(uuid)) - `recipientType` (InvoicePartyType): Identifies the type of entity acting as the biller or recipient on an invoice. - `currency` (string) - `paymentTermsValue` (object) - `customPaymentDays` (integer(int32)) - `allowPartialPayment` (boolean) - `minimumPaymentAmount` (number(double)) - `partialPaymentTolerance` (number(double)) - `allowedPaymentMethods` (array) - `vaultRestriction` (object) - `hppPageId` (string(uuid)) - `templateId` (string(uuid)) - `invoiceLevelDiscount` (InvoiceDiscountDto): DTO for an invoice-level discount. - `reminderConfig` (InvoiceReminderConfigDto): DTO for invoice reminder configuration. Each member overrides the tenant's reminder default on its own; a member that is null or omitted inherits that default. - `billerSnapshot` (InvoicePartySnapshotDto): Read DTO for denormalized biller/recipient info frozen at invoice issuance. - `recipientSnapshot` (InvoicePartySnapshotDto): Read DTO for denormalized biller/recipient info frozen at invoice issuance. - `lineItems` (array) - `customFields` (array) - `notes` (array) - `recipientNote` (string) - `footerText` (string) - `concurrencyStamp` (string) ### 403 Forbidden **Content type:** `application/json` Schema: `RemoteServiceErrorResponse` Properties: - `error` (RemoteServiceErrorInfo) ### 401 Unauthorized **Content type:** `application/json` Schema: `RemoteServiceErrorResponse` Properties: - `error` (RemoteServiceErrorInfo) ### 400 Bad Request **Content type:** `application/json` Schema: `RemoteServiceErrorResponse` Properties: - `error` (RemoteServiceErrorInfo) ### 404 Not Found **Content type:** `application/json` Schema: `RemoteServiceErrorResponse` Properties: - `error` (RemoteServiceErrorInfo) ### 501 Not Implemented **Content type:** `application/json` Schema: `RemoteServiceErrorResponse` Properties: - `error` (RemoteServiceErrorInfo) ### 500 Internal Server Error **Content type:** `application/json` Schema: `RemoteServiceErrorResponse` Properties: - `error` (RemoteServiceErrorInfo) ### 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. See the error-code reference in this document's description for the values `error.code` can take. **Content type:** `application/json` Schema: `RemoteServiceErrorResponse` Properties: - `error` (RemoteServiceErrorInfo) ### 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` 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. - `title` (string) required: A short, human-readable summary of the problem type. - `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. - `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` Properties: - `error` (RemoteServiceErrorInfo) ## 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 RecurringInvoiceScheduleUpdateDto. See the Request body section below for its fields. ### cURL ```bash curl -X PUT "{{BASE_URL}}/api/invoicing/recurring-schedules/{id}" \ -H "api-key: {{API_KEY}}" \ -H "Content-Type: application/json" \ -d '{ "name": "", "schedule": {}, "recipientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "currency": "", "lineItems": [ { "description": "" } ] }' ``` ### PowerShell ```powershell $headers = @{ 'api-key' = '{{API_KEY}}' } $body = @' { "name": "", "schedule": {}, "recipientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "currency": "", "lineItems": [ { "description": "" } ] } '@ $response = Invoke-RestMethod -Method PUT -Uri '{{BASE_URL}}/api/invoicing/recurring-schedules/{id}' ` -Headers $headers -ContentType 'application/json' -Body $body ``` ### 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.recurringInvoiceScheduleUpdate("3fa85f64-5717-4562-b3fc-2c963f66afa6", { "name": "", "schedule": {}, "recipientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "currency": "", "lineItems": [ { "description": "" } ] }); ``` ### TypeScript (raw HTTP) ```typescript const response = await fetch('{{BASE_URL}}/api/invoicing/recurring-schedules/{id}', { method: 'PUT', headers: { "api-key": "{{API_KEY}}", "Content-Type": "application/json", }, body: JSON.stringify({ "name": "", "schedule": {}, "recipientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "currency": "", "lineItems": [ { "description": "" } ] }), }); 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; 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(""" { "name": "", "schedule": {}, "recipientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "currency": "", "lineItems": [ { "description": "" } ] } """); var result = await api.RecurringInvoiceScheduleUpdateAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"), body); ``` ### C# (raw HTTP) ```csharp using System.Text; using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") }; var request = new HttpRequestMessage(new HttpMethod("PUT"), "/api/invoicing/recurring-schedules/{id}"); request.Headers.Add("api-key", "{{API_KEY}}"); request.Content = new StringContent(""" { "name": "", "schedule": {}, "recipientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "currency": "", "lineItems": [ { "description": "" } ] } """, Encoding.UTF8, "application/json"); 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) body = winkpg_api.RecurringInvoiceScheduleUpdateDto.from_dict({ "name": "", "schedule": {}, "recipientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "currency": "", "lineItems": [ { "description": "" } ] }) result = api.recurring_invoice_schedule_update("3fa85f64-5717-4562-b3fc-2c963f66afa6", body) ``` ### Python (raw HTTP) ```bash pip install requests ``` ```python import requests headers = { "api-key": "{{API_KEY}}", "Content-Type": "application/json", } body = { "name": "", "schedule": {}, "recipientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "currency": "", "lineItems": [ { "description": "" } ] } response = requests.request( "PUT", "{{BASE_URL}}/api/invoicing/recurring-schedules/{id}", headers=headers, json=body, ) response.raise_for_status() data = response.json() ``` ## See also - [All documentation](https://devportal-simpay-sbx.winkpg.io/llms.txt): the machine-readable index of every public page on this site.