# POST /api/invoicing/recurring-schedules/{id}/pause Recurring schedules: Pauses an active series. No further invoices are generated until the series is resumed. **Operation ID:** `recurringInvoiceSchedulePause` ## Authorization Requires: Invoicing.RecurringSchedules, Invoicing.RecurringSchedules.Pause, merchant scope. Requires API key scope: `admin` Required permissions: - `Invoicing.RecurringSchedules` - `Invoicing.RecurringSchedules.Pause` ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | id | path | yes | string(uuid) | | | suppressNulls | query | no | boolean | If true, omit properties with null values. | ## Responses ### 200 OK **Content type:** `application/json` Schema: [`RecurringInvoiceScheduleDto`](https://devportal.demo.winkpg.io/docs/api/models/RecurringInvoiceScheduleDto.md) 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. (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)) Fields: - `frequency` ([Frequency](https://devportal.demo.winkpg.io/docs/api/models/Frequency.md)): The type of the recurrence rule. Values: - `Secondly` - `Minutely` - `Hourly` - `Daily` - `Weekly` - `Monthly` - `Yearly` - `count` (integer(int32)): The number of occurrences in a particular recurrence. (nullable) - `until` (string(date-time)): The datetime that bounds the current recurrence. (nullable) - `interval` (integer(int32)): The recurrence interval. - `bySecond` (array): BySecond rule modifier. (nullable) - `byMinute` (array): BySecond rule modifier. (nullable) - `byHour` (array): BySecond rule modifier. (nullable) - `byDay` (array<[ContractScheduleByDayRule](https://devportal.demo.winkpg.io/docs/api/models/ContractScheduleByDayRule.md)>): Week day rule modifier. (nullable) - `byMonth` (array): Month day rule modifier. (nullable) - `byMonthDay` (array): Month days rule modifier. (nullable) - `byYearDay` (array): Year days rule modifier. (nullable) - `byWeekNumber` (array): Week number rule modifier. (nullable) - `bySetPosition` (array): BySetPosition rule modifier. (nullable) - `firstDayOfWeek` ([DayOfWeek](https://devportal.demo.winkpg.io/docs/api/models/DayOfWeek.md)): The first day of week, used in calculating weekday-based recurrences (nullable) Values: - `Sunday` - `Monday` - `Tuesday` - `Wednesday` - `Thursday` - `Friday` - `Saturday` - `nextScheduledRun` (string(date-time)): The next computed billing date, updated after each billing run. Null for contracts that have never been scheduled or have ended. (nullable) - `startDate` (string(date-time)): The earliest date on which this contract is eligible to bill. Set by the user when creating the contract (defaults to the creation date) and may be set to a future date to delay first billing. The recurrence engine anchors expansion to this date and the daily billing job will not fire a contract whose `startDate` is in the future. Null on contracts created before this field existed. When it is null, the server anchors the schedule on the contract's creation time, or on the current time when that is also absent; callers that compute a schedule themselves should apply the same fallback. (nullable) - `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): (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)): DTO for an invoice-level discount. Fields: - `type` ([DiscountType](https://devportal.demo.winkpg.io/docs/api/models/DiscountType.md)): The type of discount applied to a line item or invoice. Values: - `Percent`: Percentage discount (e.g., 10%). - `Flat`: Flat dollar amount discount (e.g., $5.00). - `value` (number(double)) - `description` (string): (nullable) - `reminderConfig` ([InvoiceReminderConfigDto](https://devportal.demo.winkpg.io/docs/api/models/InvoiceReminderConfigDto.md)): 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. Fields: - `preDueDays` (array): Days before the due date to send a reminder (for example 7, 3, 1). Null or omitted inherits the tenant default; an empty list sends no pre-due reminders for this invoice. (nullable) - `dueDayReminder` (boolean): (nullable) - `postDueDays` (array): Days after the due date to send a reminder (for example 1, 7, 14, 30). Null or omitted inherits the tenant default; an empty list sends no scheduled post-due reminders for this invoice. (nullable) - `postDueRecurringDays` (integer(int32)): (nullable) - `stopOnPaid` (boolean): (nullable) - `maxReminders` (integer(int32)): (nullable) - `dunningEndAction` ([DunningEndAction](https://devportal.demo.winkpg.io/docs/api/models/DunningEndAction.md)): (nullable) Values: - `None`: No automatic action taken. - `MarkUncollectible`: Transition the invoice to Uncollectible. - `Close`: Transition the invoice to Closed. - `daysUntilUncollectible` (integer(int32)): (nullable) - `billerSnapshot` ([InvoicePartySnapshotDto](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartySnapshotDto.md)): Read DTO for denormalized biller/recipient info frozen at invoice issuance. Fields: - `name` (string): (nullable, max length 200) - `email` (string): (nullable, max length 256) - `phone` (string): (nullable, max length 30) - `addressLine1` (string): (nullable, max length 200) - `addressLine2` (string): (nullable, max length 200) - `city` (string): (nullable, max length 100) - `state` (string): (nullable, max length 100) - `postalCode` (string): (nullable, max length 20) - `country` (string): (nullable, max length 100) - `companyName` (string): (nullable, max length 200) - `taxId` (string): (nullable, max length 50) - `logoUrl` (string): (nullable, max length 2048) - `recipientSnapshot` ([InvoicePartySnapshotDto](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartySnapshotDto.md)): Read DTO for denormalized biller/recipient info frozen at invoice issuance. Fields: - `name` (string): (nullable, max length 200) - `email` (string): (nullable, max length 256) - `phone` (string): (nullable, max length 30) - `addressLine1` (string): (nullable, max length 200) - `addressLine2` (string): (nullable, max length 200) - `city` (string): (nullable, max length 100) - `state` (string): (nullable, max length 100) - `postalCode` (string): (nullable, max length 20) - `country` (string): (nullable, max length 100) - `companyName` (string): (nullable, max length 200) - `taxId` (string): (nullable, max length 50) - `logoUrl` (string): (nullable, max length 2048) - `lineItems` (array<[InvoiceLineItemDto](https://devportal.demo.winkpg.io/docs/api/models/InvoiceLineItemDto.md)>): (nullable) Fields of each item: - `id` (string(uuid)): Stable identity for update/delete operations. - `sortOrder` (integer(int32)): Display order on the invoice. - `parentLineItemId` (string(uuid)): Parent line item ID for bundle/discount/tax line hierarchies. (nullable) - `name` (string): Product name snapshot (formal product name). (nullable) - `description` (string): Line item description shown on PDF and HPP. (nullable) - `notes` (string): Per-line notes visible to the biller only. (nullable) - `productId` (string(uuid)): Optional link to the product catalog. (nullable) - `productCode` (string): SKU or product code. (nullable) - `unitOfMeasure` (string): Unit of measure (e.g., "each", "hour", "GB"). (nullable) - `commodityCode` (string): Commodity code sent as enhanced (Level 3) card data when the invoice is paid by card. At most 25 characters. (nullable) - `quantity` (number(double)): Quantity. - `unitPrice` (number(double)): Unit price. - `grossAmount` (number(double)): Computed: Quantity * UnitPrice. - `cost` (number(double)): Cost for margin tracking. (nullable) - `pricingSource` ([PricingSource](https://devportal.demo.winkpg.io/docs/api/models/PricingSource.md)): How the unit price was determined. (nullable) Values: - `Catalog`: Price taken from the product catalog at time of invoicing. - `Override`: Price manually overridden by the user. - `Promotion`: Price determined by a promotion or coupon. - `Contract`: Price from a negotiated contract or quote. - `discountType` ([DiscountType](https://devportal.demo.winkpg.io/docs/api/models/DiscountType.md)): Type of discount applied to this line item. (nullable) Values: - `Percent`: Percentage discount (e.g., 10%). - `Flat`: Flat dollar amount discount (e.g., $5.00). - `discountValue` (number(double)): Discount value (percentage or flat amount). (nullable) - `discountAmount` (number(double)): Resolved discount amount. (nullable) - `netAmount` (number(double)): After discount, before tax. - `taxRateId` (string(uuid)): Reference to a reusable tax rate definition. (nullable) - `taxRatePercent` (number(double)): Snapshot of the tax rate percentage. (nullable) - `taxableAmount` (number(double)): Explicit taxable base amount. (nullable) - `taxAmount` (number(double)): Computed tax amount. - `taxJurisdiction` (string): Tax jurisdiction (state/country). (nullable) - `taxRateSource` ([InvoiceTaxRateSource](https://devportal.demo.winkpg.io/docs/api/models/InvoiceTaxRateSource.md)): Where `taxRatePercent` came from. Always populated on read: a line stored before provenance existed reads as Catalog when it names a `taxRateId`, otherwise Manual. (nullable) Values: - `Manual`: The operator typed the percentage, or nothing recorded where it came from. - `Catalog`: The percentage was snapshotted from one of the biller's named tax rates. - `Provider`: The percentage was sourced from the merchant's bound tax provider. - `taxRateProviderName` (string): The tax provider that sourced the percentage, when `taxRateSource` is Provider. (nullable) - `taxCode` (string): Tax code snapshotted from product or overridden. (nullable) - `isTaxable` (boolean): Whether tax applies to this line. (nullable) - `lineTotal` (number(double)): Line total including tax. - `isDiscountLine` (boolean): Indicates this is a discount adjustment line. (nullable) - `isSystemGenerated` (boolean): Indicates this line was auto-generated. (nullable) - `isOptional` (boolean): For quotes-to-invoices flow: whether this line is optional. (nullable) - `revenueAccount` (string): GL account for revenue recognition. (nullable) - `recognitionStartDate` (string(date-time)): Revenue recognition start date. (nullable) - `recognitionEndDate` (string(date-time)): Revenue recognition end date. (nullable) - `attributes` (object): Extensibility metadata (key-value pairs). (nullable) - `customFields` (array<[CustomFieldValueDto](https://devportal.demo.winkpg.io/docs/api/models/CustomFieldValueDto.md)>): (nullable) Fields of each item: - `id` (string(uuid)) - `key` (string) required: (nullable, max length 100) - `label` (string): (nullable, max length 200) - `value` (string): (nullable, max length 2000) - `notes` (array<[EntityNote](https://devportal.demo.winkpg.io/docs/api/models/EntityNote.md)>): (nullable) Fields of each item: - `id` (string(uuid)) - `enteredBy` (string(uuid)) - `timestamp` (string(date-time)) - `enteredByName` (string): Denormalized display name of the user who created the note. Populated at creation time from `ICurrentUser` to avoid N+1 lookups when rendering. (nullable) - `content` (string): (nullable, min length 0, max length 1000) - `recipientNote` (string): (nullable) - `footerText` (string): (nullable) - `concurrencyStamp` (string): (nullable) ### 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 POST "{{BASE_URL}}/api/invoicing/recurring-schedules/{id}/pause" \ -H "api-key: {{API_KEY}}" ``` ### PowerShell ```powershell $headers = @{ 'api-key' = '{{API_KEY}}' } $response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/invoicing/recurring-schedules/{id}/pause' ` -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.recurringInvoiceSchedulePause("3fa85f64-5717-4562-b3fc-2c963f66afa6"); ``` ### TypeScript (raw HTTP) ```typescript const response = await fetch('{{BASE_URL}}/api/invoicing/recurring-schedules/{id}/pause', { method: 'POST', 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.RecurringInvoiceSchedulePauseAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6")); ``` ### C# (raw HTTP) ```csharp using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") }; var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/invoicing/recurring-schedules/{id}/pause"); 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_pause("3fa85f64-5717-4562-b3fc-2c963f66afa6") ``` ### Python (raw HTTP) ```bash pip install requests ``` ```python import requests headers = { "api-key": "{{API_KEY}}", } response = requests.request( "POST", "{{BASE_URL}}/api/invoicing/recurring-schedules/{id}/pause", 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.