# ContractCreateDto

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

Data transfer object for creating a new recurring billing contract.

## Fields
- `customerId` (string(uuid)) required: Gets or sets the identifier of the customer associated with this contract. (nullable)
- `customFields` (array<[ContractCustomField](https://devportal.demo.winkpg.io/docs/api/models/ContractCustomField.md)>): Gets or sets the merchant-defined custom field values to carry on this contract. Identify a  field by the `Name` of one of the merchant's custom-field definitions; the value is  stamped onto each transaction the contract bills. Leave the collection out to keep whatever  the contract already carries; send an empty collection to clear them. (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)) required: Gets or sets the per-bill invoice configuration, controlling how individual invoices are generated.
  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)): Gets or sets the threshold rules that govern contract execution limits (e.g., maximum amount, retry caps).
  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)): Gets or sets aggregate billing totals and counters tracked across contract executions.
  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)): Gets or sets the recurrence schedule that determines when the contract is executed.
  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)) required: Gets or sets the payment method configuration used when the contract is billed. Conditional: When PayMethod is not null.
  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)): Gets or sets the email notification settings for contract billing events. Conditional: When EmailNotifications is not null.
  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): Gets or sets a value indicating whether this contract is active and eligible for execution.
- `planId` (string(uuid)): Gets or sets the reusable plan this contract subscribes to for its price. Leave it empty to  price the contract inline through `perBillInvoice`. When a plan is supplied, the  per-bill amounts on this payload are ignored and replaced with the plan's current price. (nullable)
- `trialEndDate` (string(date-time)): Gets or sets the calendar day the contract's trial ends, in UTC, or null for 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. On create it must be after the start date  and not in the past. Left empty on create against a plan that carries trial days, it is  seeded from the plan; the value stays editable per contract afterwards. (nullable)
- `description` (string): Gets or sets an optional description providing additional context for the contract. (nullable)
- `name` (string) required: Gets or sets the display name of the contract. (nullable)
- `notes` (array<[EntityNote](https://devportal.demo.winkpg.io/docs/api/models/EntityNote.md)>): Gets or sets the collection of notes attached to this contract. (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)>): Gets or sets the collection of tags used to categorize or label this contract. (nullable)
  Fields of each item:
  - `name` (string): (nullable, min length 0, max length 50)
  - `value` (string): (nullable, min length 0, max length 150)
- `skipPlanTrial` (boolean): Gets or sets a value that declines the plan's trial for this contract. By default a contract  created against a plan that carries trial days inherits them when `TrialEndDate` is  left empty; set this to true to create the contract with no trial instead. Ignored when  `TrialEndDate` is supplied, which always wins, and meaningless for a contract with no  plan.

## See also

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