# GET /api/contracts/{id} Get contract by ID Retrieves detailed information about a specific contract including fee schedules. **Operation ID:** `contractsGet` ## Authorization Requires: Customers.Contracts, merchant scope. Requires API key scope: `admin` Required permissions: - `Customers.Contracts` ## 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: [`ContractDto`](https://devportal.demo.winkpg.io/docs/api/models/ContractDto.md) Properties: - `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) 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)): Gets or sets the per-bill invoice configuration for this contract. 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 governing contract execution limits. 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): 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 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 for contract execution. 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) - `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. 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 internal 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. 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, 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) 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 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) - `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) ### 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 GET "{{BASE_URL}}/api/contracts/{id}" \ -H "api-key: {{API_KEY}}" ``` ### PowerShell ```powershell $headers = @{ 'api-key' = '{{API_KEY}}' } $response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/contracts/{id}' ` -Headers $headers ``` ### TypeScript (SDK) ```bash npm install @winkpg/winkpg-api ``` ```typescript import { Configuration, ContractsApi } from '@winkpg/winkpg-api'; const api = new ContractsApi(new Configuration({ basePath: '{{BASE_URL}}', apiKey: '{{API_KEY}}', })); const { data } = await api.contractsGet("3fa85f64-5717-4562-b3fc-2c963f66afa6"); ``` ### TypeScript (raw HTTP) ```typescript const response = await fetch('{{BASE_URL}}/api/contracts/{id}', { method: 'GET', 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 ContractsApi(config); var result = await api.ContractsGetAsync(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("GET"), "/api/contracts/{id}"); 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.ContractsApi(client) result = api.contracts_get("3fa85f64-5717-4562-b3fc-2c963f66afa6") ``` ### Python (raw HTTP) ```bash pip install requests ``` ```python import requests headers = { "api-key": "{{API_KEY}}", } response = requests.request( "GET", "{{BASE_URL}}/api/contracts/{id}", 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.