customerId
required |
string (uuid)
|
Gets or sets the identifier of the customer associated with 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.
|
customFields
required |
array of ContractCustomField
array of ContractCustomField |
Gets or sets the merchant-defined custom field values to carry on this contract. Identify a
field by the `Name` of one of the merchant's custom-field definitions; the value is
stamped onto each transaction the contract bills. Leave the collection out to keep whatever
the contract already carries; send an empty collection to clear them.
nullable
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, controlling how individual invoices are generated.
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 that govern contract execution limits (e.g., maximum amount, retry caps).
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.
| 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 and counters 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 that determines when the contract is executed.
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.
Conditional: When PayMethod is not null.
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.
| 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.
Conditional: When EmailNotifications is not null.
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. Leave it empty to
price the contract inline through `perBillInvoice`. When a plan is supplied, the
per-bill amounts on this payload are ignored and replaced with the plan's current price.
nullable
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 for no trial. Nothing
is charged before this day; the first charge falls on it, or on the schedule's first
occurrence after it, at the full contract amount. On create it must be after the start date
and not in the past. Left empty on create against a plan that carries trial days, it is
seeded from the plan; the value stays editable per contract afterwards.
nullable
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.
|
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 or label 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. |
skipPlanTrial
required |
boolean
|
Gets or sets a value that declines the plan's trial for this contract. By default a contract
created against a plan that carries trial days inherits them when `TrialEndDate` is
left empty; set this to true to create the contract with no trial instead. Ignored when
`TrialEndDate` is supplied, which always wins, and meaningless for a contract with no
plan.
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.
|