# PagedResultDtoOfContractDto

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

## Fields
- `items` (array<[ContractDto](https://devportal.demo.winkpg.io/docs/api/models/ContractDto.md)>): (nullable)
  Fields of each item:
  - `extraProperties` (object): (nullable, read only)
  - `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)
  - `customerId` (string(uuid)): Gets or sets the identifier of the customer who owns this contract.
  - `customerName` (string): Gets or sets the display name of the associated customer, used for grid rendering. (nullable)
  - `legacyNumber` (integer(int64)): Gets or sets the contract's legacy numeric key, the integer identifier the v1 API resolves  contracts by. Server-owned: stamped at create and ignored on every inbound payload. Null on  contracts created before the field existed and not yet back-filled by the v1 data migration. (nullable)
  - `totalExecutions` (integer(int32)): Gets or sets the total number of billing executions performed for this contract.
  - `successfulExecutions` (integer(int32)): Gets or sets the number of successful billing executions.
  - `failedExecutions` (integer(int32)): Gets or sets the number of failed billing executions.
  - `totalAmountBilled` (number(double)): Gets or sets the cumulative amount billed across all executions.
  - `amountPerAttempt` (number(double)): Gets or sets the amount charged per billing attempt.
  - `paymentMethodType` ([ContractPayMethodType](https://devportal.demo.winkpg.io/docs/api/models/ContractPayMethodType.md)): Gets or sets the type of payment method used by this contract.
    Values:
    - `Card`
    - `Check`
  - `customFields` (array<[ContractCustomField](https://devportal.demo.winkpg.io/docs/api/models/ContractCustomField.md)>): Gets or sets the merchant-defined custom field values carried on this contract, or null when  it carries none. Null and an empty collection are different answers: null means the contract  has never had custom fields set, empty means they were explicitly cleared. (nullable)
  - `perBillInvoice` ([ContractPerBillInvoice](https://devportal.demo.winkpg.io/docs/api/models/ContractPerBillInvoice.md)): Gets or sets the per-bill invoice configuration for this contract.
  - `thresholds` ([ContractThresholds](https://devportal.demo.winkpg.io/docs/api/models/ContractThresholds.md)): Gets or sets the threshold rules governing contract execution limits.
  - `aggregates` ([ContractAggregates](https://devportal.demo.winkpg.io/docs/api/models/ContractAggregates.md)): Gets or sets aggregate billing totals tracked across contract executions.
  - `schedule` ([ContractSchedule](https://devportal.demo.winkpg.io/docs/api/models/ContractSchedule.md)): Gets or sets the recurrence schedule for contract execution.
  - `payMethod` ([ContractPayMethod](https://devportal.demo.winkpg.io/docs/api/models/ContractPayMethod.md)): Gets or sets the payment method configuration used when the contract is billed.
  - `emailNotifications` ([ContractEmailNotifications](https://devportal.demo.winkpg.io/docs/api/models/ContractEmailNotifications.md)): Gets or sets the email notification settings for contract billing events.
  - `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, or null when the  contract carries its own inline amount. When set, the recurring billing engine resolves the  amount from the plan at charge time and the per-bill amounts on this contract are a snapshot  of it. (nullable)
  - `trialEndDate` (string(date-time)): Gets or sets the calendar day the contract's trial ends, in UTC, or null when the contract has  no trial. While this day is still ahead the contract is active but not charged; the first  charge falls on it, or on the schedule's first occurrence after it, at the full amount. (nullable)
  - `description` (string): Gets or sets an optional description providing additional context for the contract. (nullable)
  - `deactivationReason` ([ContractDeactivationReason](https://devportal.demo.winkpg.io/docs/api/models/ContractDeactivationReason.md)): Gets or sets the reason this contract was deactivated, or null when the contract is active  or was never deactivated. Server-owned: set by the recurring billing engine when a threshold  or schedule ends the contract, by the self-service cancellation flow when the payer cancels,  and cleared back to null when the contract is reactivated. Read-only over the API; an  inbound payload can never set it. (nullable, read only)
    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): Gets or sets why an operator paused this contract, or null when it is not paused. Present  only while `deactivationReason` is `Paused`. Server-owned: written by the  pause operation and cleared by every resume; read-only over the API. (nullable, read only)
  - `pausedDate` (string(date-time)): Gets or sets when the contract was paused, in UTC, or null when it is not paused. Server-owned  and read-only over the API. (nullable, read only)
  - `expectedResumeDate` (string(date-time)): Gets or sets the UTC calendar day on which the daily billing run resumes the contract on its  own, or null for a pause only an operator ends. Server-owned and read-only over the API; set  it through the pause operation. (nullable, read only)
  - `convenienceFeeWaived` (boolean): Gets or sets whether the cardholder enrolled in this contract on terms that disclosed no  convenience fee, so no scheduled charge under it carries one. Null or false means each charge's  fee follows the merchant's convenience-fee configuration. Server-owned: recorded when the  contract is created from a hosted payment page that carried no fee, and read-only over the API. (nullable, read only)
  - `name` (string): 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)
  - `tags` (array<[EntityTag](https://devportal.demo.winkpg.io/docs/api/models/EntityTag.md)>): Gets or sets the collection of tags used to categorize this contract. (nullable)
  - `concurrencyStamp` (string): Gets or sets the concurrency stamp used for optimistic concurrency control. (nullable)
  - `entityVersion` (integer(int32)): Gets the entity version, incremented on each modification for optimistic concurrency. (read only)
- `totalCount` (integer(int64))

## See also

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