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 model

This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.

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-10-22 22:52 UTC.

API reference Models

Contract

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

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.

Fields

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.
name 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.
notes required array of EntityNote array of EntityNote 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 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.

customerId 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.
legacyNumber required 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
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.
customFields required array of ContractCustomField array of ContractCustomField The merchant-defined custom field values carried on this contract, or `null` when it carries none. 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
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
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 Cumulative execution statistics and recent history for a recurring billing 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 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
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 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.
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
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
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) The reusable plan this contract subscribes to for its price, or `null` when the contract carries its own inline 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.
trialEndDate required 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
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.
priceChangedAt required 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
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 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: 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 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
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) 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
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) 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
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 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
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.
upcomingChargeReminderSentForRun required 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
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 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.
creationTime required string (date-time) The date and time when this entity was created. 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.
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. 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.
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.
concurrencyStamp required 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
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 model has no documented fields.

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.