WinkPG Docs
View as Markdown

llms.txt

The API reference isn't available right now

This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such model

This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.

Back to the API reference

This reference may be out of date

This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-23 00:19 UTC.

API reference Models

ContractPlanCreateDto

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

Payload for creating a plan, including the price it starts on.

Values

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields

Field Type Description
merchantId required string (uuid) The merchant that owns the plan. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
name required string The plan's operator-facing name. Must be unique within the owning merchant. nullablemax length 128
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
code required string The merchant's own short code for the plan. Optional, and not resolved by the platform. nullablemax length 64
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
description required string What the plan covers, in the operator's own words. nullablemax length 1024
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
currencyCode required string The ISO 4217 alphabetic currency code the plan's amounts are denominated in. nullablemin length 3max length 3pattern ^[A-Za-z]{3}$
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
isActive required boolean Whether the plan may be subscribed to. Turning it off hides it from the plan picker and blocks new subscriptions; it does not stop billing the contracts already on it.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
defaultSchedule required ContractSchedule ContractSchedule The recurrence a new contract on this plan starts from. Optional, and a suggestion only: the contract owns its schedule once created.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of ContractSchedule:

Field Type Description
frequency required Frequency Frequency The type of the recurrence rule.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Secondly
Minutely
Hourly
Daily
Weekly
Monthly
Yearly
count required integer (int32) The number of occurrences in a particular recurrence. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
until required string (date-time) The datetime that bounds the current recurrence. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
interval required integer (int32) The recurrence interval.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
bySecond required array of integer (int32) array of BySecond rule modifier. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
byMinute required array of integer (int32) array of BySecond rule modifier. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
byHour required array of integer (int32) array of BySecond rule modifier. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
byDay required array of ContractScheduleByDayRule array of ContractScheduleByDayRule Week day rule modifier. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
byMonth required array of integer (int32) array of Month day rule modifier. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
byMonthDay required array of integer (int32) array of Month days rule modifier. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
byYearDay required array of integer (int32) array of Year days rule modifier. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
byWeekNumber required array of integer (int32) array of Week number rule modifier. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
bySetPosition required array of integer (int32) array of BySetPosition rule modifier. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
firstDayOfWeek required DayOfWeek DayOfWeek The first day of week, used in calculating weekday-based recurrences nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
nextScheduledRun required 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
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
startDate required 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
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

trialDays required integer (int32) The trial length a new contract on this plan inherits, in days. Optional; empty or zero means no trial. A default for contract creation only: each contract owns its own trial end date once created, and changing this never moves an existing subscriber. nullablemin 0max 365
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
billSubtotalAmount required number (double) The base amount the plan charges each cycle, before tax. min 0
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
taxAmount required number (double) The tax added to the base amount each cycle. Leave empty when the plan carries no tax line. nullablemin 0
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
totalAmount required number (double) The total charged to a subscriber each cycle. This is the amount the billing engine charges; the subtotal and tax are the operator's breakdown of it. greater than 0
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This model has no documented fields.

Reconnecting to the server

Could not reconnect

This session has ended

Attempt 1

Your work on this page is still here. Retrying keeps it; reloading starts the page again.

The server no longer holds this page's state, so it has to be loaded again.