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 operation

This instance documents no operation under that identifier. It may have been renamed, or it may belong to a feature this installation hasn't enabled.

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-11-12 05:58 UTC.

API reference Contracts

Resumes a paused contract.

POST /api/contracts/{id}/resume deprecated

Requires: Customers.Contracts, Customers.Contracts.Update, merchant scope.

Requires API key scope: admin (Administration)

Reactivates it, clears the pause fields, and projects the next charge as the first occurrence of its schedule on or after today, so billing continues on the contract's own cadence rather than catching up on the cycles the pause covered. A contract that is not paused is refused; a suspended or deactivated contract is reactivated through the ordinary update instead.

Signed in, you can send this request to your own sandbox merchant from the console and read the answer. Sign in to try it.

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.

The request body is a . See the Request body section below for its fields.

Code sample language

cURL

curl -X POST "{{BASE_URL}}/api/contracts/{id}/resume" \
  -H "api-key: {{API_KEY}}"

PowerShell

$headers = @{
    'api-key' = '{{API_KEY}}'
}

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/contracts/{id}/resume' `
    -Headers $headers

npm install @winkpg/winkpg-api

TypeScript (SDK)

import { Configuration, ContractsApi } from '@winkpg/winkpg-api';

const api = new ContractsApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.contractsResume("3fa85f64-5717-4562-b3fc-2c963f66afa6");

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/contracts/{id}/resume', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
  },
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

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.ContractsResumeAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"));

C# (raw HTTP)

using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/contracts/{id}/resume");
request.Headers.Add("api-key", "{{API_KEY}}");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();

pip install winkpg-api

Python (SDK)

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_resume("3fa85f64-5717-4562-b3fc-2c963f66afa6")

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/contracts/{id}/resume",
    headers=headers,
)
response.raise_for_status()
data = response.json()

Parameters

Name In Type Description
id required path string (uuid) The contract to resume.
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.
suppressNulls required query boolean If true, omit properties with null 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.

Request body

application/json , required

Field Type Description

This request body has no documented fields.

Responses

Response status

OK

Body: ContractDto ContractDto Each item has these fields.

Field Type Description
extraProperties required object nullableread only
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.
id required string (uuid)
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.
creationTime required string (date-time) The date and time when this entity was 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.
creatorId required string (uuid) The ID of the user who created this entity. 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.
lastModificationTime required string (date-time) The date and time when this entity was last modified. 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.
lastModifierId required string (uuid) The ID of the user who last modified this entity. 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.
isDeleted required boolean Indicates whether this entity has been deleted.
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.
deleterId required string (uuid) The ID of the user who deleted this entity, if it is deleted. 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.
deletionTime required string (date-time) The date and time when this entity was deleted, if it is deleted. 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.
customerId required string (uuid) Gets or sets the identifier of the customer who owns this contract.
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.
customerName required string Gets or sets the display name of the associated customer, used for grid rendering. 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.
legacyNumber required 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
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.
totalExecutions required integer (int32) Gets or sets the total number of billing executions performed for this contract.
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.
successfulExecutions required integer (int32) Gets or sets the number of successful billing executions.
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.
failedExecutions required integer (int32) Gets or sets the number of failed billing executions.
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.
totalAmountBilled required number (double) Gets or sets the cumulative amount billed across all executions.
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.
amountPerAttempt required number (double) Gets or sets the amount charged per billing attempt.
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.
paymentMethodType required ContractPayMethodType ContractPayMethodType Gets or sets the type of payment method used by this contract.
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.
Card
Check
customFields required array of ContractCustomField array of ContractCustomField 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
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 each ContractCustomField:

Field Type Description
definitionId required string (uuid) The merchant custom-field definition this value belongs to, or `null` when the value could not be matched to one. 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 name of the merchant's custom-field definition, matched case-insensitively. This is the canonical key the platform uses for custom fields. nullablemax length 50
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.
value required string The value captured for the field. At most `TrxCustomFieldConsts.MaxValueLength` characters and free of control characters. nullablemax length 300
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.
legacyKey required 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
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.

perBillInvoice required ContractPerBillInvoice ContractPerBillInvoice Gets or sets the per-bill invoice configuration for this contract.
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 ContractPerBillInvoice:

Field Type Description
billSubtotalAmount required number (double) 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) 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) 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.

This body has no documented fields.

thresholds required ContractThresholds ContractThresholds Gets or sets the threshold rules governing contract execution limits.
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 ContractThresholds:

Field Type Description
maxAmount required 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. 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.
maxNumPayments required 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
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.
maxSuccessfulBills required 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
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.
maxFailCount required 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
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.
failureInterval required integer (int32) How many `failurePeriod` units to wait before retrying after a failed billing attempt. Applied together with `failurePeriod`. 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.
failurePeriod required Period Period The unit the `failureInterval` retry delay is measured in. 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.
Day
Week
Month
Year
failureRetryResultCodes required array of string array of 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
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.

aggregates required ContractAggregates ContractAggregates Gets or sets aggregate billing totals tracked across contract executions.
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 ContractAggregates:

Field Type Description
totalExecutions required integer (int32)
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.
successfulExecutions required integer (int32)
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.
failedExecutions required integer (int32)
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.
amountBilled required number (double) 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.
consecutiveFailures required integer (int32) Consecutive failed billing attempts without an intervening success. Reset to 0 on success. Used with `maxFailCount` to determine suspension. 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.
lastSuccessfulExecution required string (date-time) Timestamp of the last successful billing execution. 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.
lastExecution required string (date-time) Timestamp of the last billing execution (success or failure). 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.
executionHistory required array of ContractExecutionRecord array of ContractExecutionRecord 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
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.
pendingCredit required 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
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.
lastBillingSkip required ContractBillingSkip ContractBillingSkip 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. nullableread only
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.

schedule required ContractSchedule ContractSchedule Gets or sets the recurrence schedule for contract execution.
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.

payMethod required ContractPayMethod ContractPayMethod Gets or sets the payment method configuration used when the contract is billed.
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 ContractPayMethod:

Field Type Description
type required ContractPayMethodType ContractPayMethodType 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: 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.
Card
Check
paymentTokenId required 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
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.
card required StoredCard StoredCard Raw card account data. Populate only when no token is supplied and `type` is `Card`. Prefer `paymentTokenReference` for new integrations. 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.
check required StoredCheck StoredCheck 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
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.
paymentTokenReference required 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
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.

emailNotifications required ContractEmailNotifications ContractEmailNotifications Gets or sets the email notification settings for contract billing events.
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 ContractEmailNotifications:

Field Type Description
emailCustomerOnApproval required boolean
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.
emailMerchantOnApproval required boolean
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.
emailCustomerOnFailure required boolean
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.
emailMerchantOnFailure required boolean
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.
sendUpcomingChargeReminder required boolean 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.
upcomingChargeReminderDaysBefore required integer (int32) Required: When SendUpcomingChargeReminder is true. 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.
upcomingChargeReminderMessage required string nullablemax length 500
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.

isActive required boolean Gets or sets a value indicating whether this contract is active and eligible for execution.
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.
planId required 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
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.
trialEndDate required 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
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 Gets or sets an optional description providing additional context for the contract. 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.
deactivationReason required ContractDeactivationReason ContractDeactivationReason 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. nullableread only
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.
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 required 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. nullableread only
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.
pausedDate required 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. nullableread only
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.
expectedResumeDate required 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. nullableread only
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.
convenienceFeeWaived required 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. nullableread only
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.
dualPricingConsentedRate required number (double) Gets or sets the card price rate, as a decimal fraction, that the cardholder's consent stated when they enrolled, for a merchant that posts a cash price and a card price as a percentage. A card is charged the card price under this contract only when this or `dualPricingConsentedAmount` is set, and never uplifted by more than the consent stated. Null when the consent stated no card price, or stated it as an amount. Server-owned: recorded when the contract is created, from the consent the card's recurring charges run under (a hosted payment page enrollment, a consent recorded in the back office with the card price, or an API consent sent with `enrollmentTerms.cardPriceDisclosed`), and read-only over the API. nullableread only
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.
dualPricingConsentedAmount required number (double) Gets or sets the card price amount (the card price minus the cash price, in the contract currency) that the cardholder's consent stated when they enrolled, for a merchant that posts a card price as the cash price plus a fixed amount. A card is never charged more than the cash price plus this amount under this contract. Null when the consent stated no card price, or stated it as a rate. Server-owned: recorded when the contract is created, on the terms of `dualPricingConsentedRate`, and read-only over the API. nullableread only
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 Gets or sets the display name of the contract. 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.
notes required array of EntityNote array of EntityNote Gets or sets the collection of notes attached to this contract. 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.

Fields of each EntityNote:

Field Type Description
id required string (uuid)
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.
enteredBy required string (uuid)
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.
timestamp required string (date-time)
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.
enteredByName required 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
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.
content required string nullablemin length 0max length 1000
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.

tags required array of EntityTag array of EntityTag Gets or sets the collection of tags used to categorize this contract. 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.

Fields of each EntityTag:

Field Type Description
name required string nullablemin length 0max length 50
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.
value required string nullablemin length 0max length 150
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.

concurrencyStamp required string Gets or sets the concurrency stamp used for optimistic concurrency control. 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.
entityVersion required integer (int32) Gets the entity version, incremented on each modification for optimistic concurrency. read only
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 response has no documented body fields.

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.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo RemoteServiceErrorInfo
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 response has no documented body fields.

  1. 400 Bad Request Bad request. The request was malformed or failed validation. When validation rejected it, `error.validationErrors` names each member at fault and why.
  2. 401 Unauthorized Unauthorized. The request carried no API key or signed-in session, or the key it carried is invalid, revoked or expired.
  3. 403 Forbidden Forbidden. The API key lacks the scope this operation needs, the signed-in user lacks the permission, or a business rule refused the request. The error code in the body names the reason.
  4. 404 Not Found Not found. The resource the request names does not exist or is not visible to the caller: a resource that belongs to a merchant or tenant outside the caller's scope is reported as not found.
  5. 500 Internal Server Error Internal server error. The platform failed unexpectedly while handling the request. If it keeps failing, contact support and quote the correlation id, which the response carries in the `X-Correlation-Id` header and as `error.data.correlationId`.
  6. 501 Not Implemented Not implemented. The operation is declared but has no implementation on this deployment, so no request to it can succeed. Retrying does not help.
  7. 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 lists the values `error.code` can take.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 lists the values `error.code` can take.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo RemoteServiceErrorInfo
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 RemoteServiceErrorInfo:

Field Type Description
code required string 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.
message required string 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.
details required string 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.
data required object 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.
validationErrors required array of RemoteServiceValidationErrorInfo array of RemoteServiceValidationErrorInfo 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.

This response has no documented body fields.

Errors

A failed request returns the platform error envelope. The error reference lists every value error.code can carry and shows the four response shapes.

Codes declared by

Authentication

  • ApiKey with scopes

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.