# Contract

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

## Fields
- `id` (string(uuid))
- `name` (string): (nullable)
- `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)
- `tags` (array<[EntityTag](https://devportal.demo.winkpg.io/docs/api/models/EntityTag.md)>): (nullable)
  Fields of each item:
  - `name` (string): (nullable, min length 0, max length 50)
  - `value` (string): (nullable, min length 0, max length 150)
- `customerId` (string(uuid))
- `legacyNumber` (integer(int64)): The contract's legacy numeric key, as used by the v1 API where contracts are identified by an  integer rather than a Guid. Server-owned: stamped once at create from a tenant-scoped counter  and never settable from an inbound payload. (nullable)
- `customFields` (array<[ContractCustomField](https://devportal.demo.winkpg.io/docs/api/models/ContractCustomField.md)>): The merchant-defined custom field values carried on this contract, or `null`  when it carries none. (nullable)
  Fields of each item:
  - `definitionId` (string(uuid)): The merchant custom-field definition this value belongs to, or `null` when  the value could not be matched to one. (nullable)
  - `name` (string): The name of the merchant's custom-field definition, matched case-insensitively. This is the  canonical key the platform uses for custom fields. (nullable, max length 50)
  - `value` (string) required: The value captured for the field. At most `TrxCustomFieldConsts.MaxValueLength`  characters and free of control characters. (nullable, max length 300)
  - `legacyKey` (integer(int32)): The v1 API caller's own integer `CustomKey` for this field, preserved verbatim, or  `null` for a value that never came through the v1 facade. (nullable)
- `perBillInvoice` ([ContractPerBillInvoice](https://devportal.demo.winkpg.io/docs/api/models/ContractPerBillInvoice.md))
  Fields:
  - `billSubtotalAmount` (number(double)): (min 0)
  - `taxAmount` (number(double)): (nullable, min 0)
  - `totalAmount` (number(double)): (min 0)
- `thresholds` ([ContractThresholds](https://devportal.demo.winkpg.io/docs/api/models/ContractThresholds.md))
  Fields:
  - `maxAmount` (number(double)): Total amount the contract may bill across its lifetime before it deactivates itself.  Leave it empty for no limit. The contract create and update endpoints require a value  greater than zero when one is supplied; a non-positive value stored by an older save is  read as no limit. (nullable, min 0)
  - `maxNumPayments` (integer(int32)): Total number of billing attempts, successful or not, the contract may make before it  deactivates itself. Leave it empty for no limit. The contract create and update endpoints  require at least 1 when a value is supplied; a non-positive value stored by an older save  is read as no limit. (nullable)
  - `maxSuccessfulBills` (integer(int32)): Number of successful bills the contract may take before it deactivates itself. Leave it  empty for no limit. The contract create and update endpoints require at least 1 when a  value is supplied; a non-positive value stored by an older save is read as no limit. (nullable)
  - `maxFailCount` (integer(int32)): Consecutive failed billing attempts that suspend the contract. Empty or `0` means the  contract is never suspended for failures and retries indefinitely. Unlike the three  capacity caps above, `0` is a valid, accepted value here. (nullable)
  - `failureInterval` (integer(int32)): How many `failurePeriod` units to wait before retrying after a failed billing  attempt. Applied together with `failurePeriod`. (nullable)
  - `failurePeriod` ([Period](https://devportal.demo.winkpg.io/docs/api/models/Period.md)): The unit the `failureInterval` retry delay is measured in. (nullable)
    Values:
    - `Day`
    - `Week`
    - `Month`
    - `Year`
  - `failureRetryResultCodes` (array<string>): Processor response codes that count toward the `maxFailCount` suspension threshold.  If a failure's response code is NOT in this list, the failure retries indefinitely  until the contract ends. If the code IS in this list and consecutive failures reach  `maxFailCount`, the contract is suspended.  Null or empty means all failure codes count toward suspension. (nullable)
- `aggregates` ([ContractAggregates](https://devportal.demo.winkpg.io/docs/api/models/ContractAggregates.md)): Cumulative execution statistics and recent history for a recurring billing contract.
  Fields:
  - `totalExecutions` (integer(int32))
  - `successfulExecutions` (integer(int32))
  - `failedExecutions` (integer(int32))
  - `amountBilled` (number(double)): (min 0)
  - `consecutiveFailures` (integer(int32)): Consecutive failed billing attempts without an intervening success. Reset to 0 on success.  Used with `maxFailCount` to determine suspension. (nullable)
  - `lastSuccessfulExecution` (string(date-time)): Timestamp of the last successful billing execution. (nullable)
  - `lastExecution` (string(date-time)): Timestamp of the last billing execution (success or failure). (nullable)
  - `executionHistory` (array<[ContractExecutionRecord](https://devportal.demo.winkpg.io/docs/api/models/ContractExecutionRecord.md)>): The most recent execution records for this contract (capped at 10, newest first).  May be `null` on older contracts; treat `null` the same as an empty list. (nullable)
  - `pendingCredit` (number(double)): A proration credit still owed to the customer, to be taken off the next charge, or  `null` (equivalently zero) when none is owed. (nullable)
  - `lastBillingSkip` ([ContractBillingSkip](https://devportal.demo.winkpg.io/docs/api/models/ContractBillingSkip.md)): The most recent billing run that found this contract due and did not charge it, and why, or  `null` when the last run that looked at the contract charged it (or none has  skipped it). Read-only: the billing engine is the only writer. (nullable, read only)
- `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<integer(int32)>): BySecond rule modifier. (nullable)
  - `byMinute` (array<integer(int32)>): BySecond rule modifier. (nullable)
  - `byHour` (array<integer(int32)>): BySecond rule modifier. (nullable)
  - `byDay` (array<[ContractScheduleByDayRule](https://devportal.demo.winkpg.io/docs/api/models/ContractScheduleByDayRule.md)>): Week day rule modifier. (nullable)
  - `byMonth` (array<integer(int32)>): Month day rule modifier. (nullable)
  - `byMonthDay` (array<integer(int32)>): Month days rule modifier. (nullable)
  - `byYearDay` (array<integer(int32)>): Year days rule modifier. (nullable)
  - `byWeekNumber` (array<integer(int32)>): Week number rule modifier. (nullable)
  - `bySetPosition` (array<integer(int32)>): 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)
- `payMethod` ([ContractPayMethod](https://devportal.demo.winkpg.io/docs/api/models/ContractPayMethod.md)): Represents a payment method attached to a recurring billing contract.  Exactly one of two shapes is expected on a Create request:  <list type="bullet">  <item><description><b>Tokenised:</b> set `paymentTokenReference` (the opaque `pt_` handle) to reference a previously stored payment method, for either `type` = `Card` or `type` = `Check`. `card` and `check` must be left null; the recurring billing engine resolves the underlying card or bank-account data from the token store at execution time. This is the recommended shape because it keeps PCI scope at the token layer.</description></item>  <item><description><b>Raw:</b> populate `card` (when `type` is `Card`) or `check` (when `type` is `Check`) with the account data. Both token fields must be null.</description></item>  </list>  The Create validator rejects payloads that mix both shapes (a token alongside raw `card`/`check` data) or that omit both.
  Fields:
  - `type` ([ContractPayMethodType](https://devportal.demo.winkpg.io/docs/api/models/ContractPayMethodType.md)): Gets or sets the funding instrument family. Determines which raw-data field (`card` or `check`) is consulted when the payment method carries no token binding (neither `paymentTokenReference` nor `paymentTokenId`).
    Values:
    - `Card`
    - `Check`
  - `paymentTokenId` (string(uuid)): Internal vault identifier of a previously stored payment method, valid for both `Card` and `Check` contracts. This value correlates directly to stored cardholder data and is an <b>internal</b> binding: prefer `paymentTokenReference` on every external integration. It remains accepted inbound for callers that have not yet migrated, and is resolved and re-stamped server-side on every contract write. (nullable)
  - `card` ([StoredCard](https://devportal.demo.winkpg.io/docs/api/models/StoredCard.md)): Raw card account data. Populate only when no token is supplied and `type` is `Card`. Prefer `paymentTokenReference` for new integrations. (nullable)
  - `check` ([StoredCheck](https://devportal.demo.winkpg.io/docs/api/models/StoredCheck.md)): Raw check / ACH account data. Populate only when no token is supplied and `type` is `Check`. Prefer `paymentTokenReference` (a stored check/ACH token) for new integrations. (nullable)
  - `paymentTokenReference` (string): The externally-emitted, chargeable public reference of the stored payment method this contract bills: the opaque `pt_`-prefixed handle returned when the payment method was stored. This is the identifier external integrations should use, and it is valid for both `Card` and `Check` contracts. (nullable)
- `emailNotifications` ([ContractEmailNotifications](https://devportal.demo.winkpg.io/docs/api/models/ContractEmailNotifications.md))
  Fields:
  - `emailCustomerOnApproval` (boolean)
  - `emailMerchantOnApproval` (boolean)
  - `emailCustomerOnFailure` (boolean)
  - `emailMerchantOnFailure` (boolean)
  - `sendUpcomingChargeReminder` (boolean): (nullable)
  - `upcomingChargeReminderDaysBefore` (integer(int32)): Required: When SendUpcomingChargeReminder is true. (nullable)
  - `upcomingChargeReminderMessage` (string): (nullable, max length 500)
- `isActive` (boolean)
- `planId` (string(uuid)): The reusable plan this contract subscribes to for its price, or `null` when  the contract carries its own inline amount. (nullable)
- `trialEndDate` (string(date-time)): The calendar day the contract's trial period ends, in UTC, or `null` when the  contract has no trial. Nothing is charged before this day: the first charge falls on it (or  on the schedule's first occurrence after it) at the full contract amount. (nullable)
- `priceChangedAt` (string(date-time)): When an operator last changed what this contract charges per cycle (the plan it subscribes  to, or its inline amount), in UTC, or `null` when that has never happened  since the field existed. Server owned: stamped by the contract update path, never settable  from an inbound payload. (nullable)
- `deactivationReason` ([ContractDeactivationReason](https://devportal.demo.winkpg.io/docs/api/models/ContractDeactivationReason.md)): Describes why this contract was deactivated. Null when the contract is active  or was never deactivated by the billing engine. Set automatically by the  recurring billing manager and cleared when the contract is reactivated. (nullable)
  Values:
  - `Suspended`: Suspended by the billing engine after consecutive failures exceeded the maxFailCount threshold.
  - `MaxPaymentsReached`: Total execution count (successful + failed) reached maxNumPayments.
  - `MaxSuccessfulBillsReached`: Successful execution count reached maxSuccessfulBills.
  - `MaxAmountReached`: Cumulative amount billed reached maxAmount.
  - `ScheduleExhausted`: The recurrence schedule produced no further occurrences: either the until end date was reached or the recurrence count was exhausted.
  - `Manual`: Manually deactivated by an operator via the UI or API.
  - `CancelledByCardholder`: Cancelled by the cardholder themselves, from the link in an upcoming-charge reminder, with no operator involved.
  - `Paused`: Paused on purpose by an operator, to be resumed later: either by hand, or automatically by the daily billing run once the contract's expected resume date has passed. A pause is a voluntary stop, which is what separates it from Suspended (the billing engine gave up after consecutive failures) and from Manual (deactivated with no intention to resume). The pause itself is described by the contract's pause fields (reason, paused date, expected resume date), which are cleared when the contract resumes.
- `pauseReason` (string): Why an operator paused this contract, or `null` when it is not paused. Server  owned: written by the pause operation and cleared by every resume, never settable from an  inbound payload. (nullable)
- `pausedDate` (string(date-time)): When the contract was paused, in UTC, or `null` when it is not paused. Server  owned, stamped by the pause operation and cleared on resume. (nullable)
- `expectedResumeDate` (string(date-time)): The calendar day, in UTC, on which the daily billing run resumes this contract on its own, or  `null` for a pause with no end date, which only an operator can resume. A  calendar date compared as written, never timezone-converted, the same rule  `trialEndDate` follows: the run that finds this day at or before today resumes  the contract and projects its next charge from that moment. (nullable)
- `convenienceFeeWaived` (boolean): Whether the cardholder enrolled in this contract on terms that disclosed no convenience fee,  so no scheduled charge under it may carry one. `null` or `false`  means the fee is decided at each charge from the merchant's live configuration, as it always  has been. Server owned: stamped once when a Hosted Payment Page session carrying the  `suppress_convenience_fee` directive creates the contract, never settable from an inbound  payload. (nullable)
- `upcomingChargeReminderSentForRun` (string(date-time)): The scheduled run, in UTC, that the pre-charge reminder was last sent for, or  `null` when no reminder has been sent. Server owned: written only by the  recurring billing run after the reminder email is queued, never settable from an inbound  payload. (nullable)
- `description` (string): (nullable)
- `creationTime` (string(date-time)): The date and time when this entity was created. (nullable)
- `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. (nullable)
- `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)
- `concurrencyStamp` (string): Optimistic-concurrency stamp for the contract, checked independently of the customer that  holds it. A null stamp means "no concurrency check" until the contract is next updated, which  stamps it going forward. (nullable)

## See also

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