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.
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
A single execution record for a recurring billing contract, capturing the outcome
of one billing attempt. Stored as part of `executionHistory`
(capped at the most recent 10 entries).
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
executedAtrequired
string (date-time)
The date and time the billing execution was performed.
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
successrequired
boolean
Whether the billing attempt was approved by the payment processor.
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
amountBilledrequired
number (double)
The amount charged in this billing 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.
transactionIdrequired
string (uuid)
The transaction ID created in the payment engine, if one 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.
failureReasonrequired
string
An explanation of why the billing execution failed. Null for successful attempts.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.
responseCoderequired
string
The processor response code for this execution. Used for failure classification
against `failureRetryResultCodes`.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.
scheduledRunTimerequired
string (date-time)
The scheduled occurrence time this execution was triggered for.
Used by the Layer 2 idempotency guard to detect duplicate billing for the same
scheduled occurrence. Null for execution records created before this field was added.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.
preCreditAmountrequired
number (double)
The contract amount this cycle was priced at before any proration credit was applied: the
inline per-bill total, or the plan revision in force. Pre-surcharge, so it is the number a
later cycle compares against to detect a mid-cycle price change (`amountBilled`
is the processor's response amount and may include a surcharge). Null on records written
before proration existed; such a record never seeds a proration credit.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.
creditAppliedrequired
number (double)
The proration credit taken off this charge, or null when none applied. Zero is never
written; a cycle with no credit leaves the field absent.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.
chargedAmountrequired
number (double)
The contract amount actually submitted for this cycle after the credit:
`preCreditAmount` less `creditApplied`, floored at zero. Pre-surcharge,
like the two fields it derives from. Null on records written before proration existed.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.
planPriceIdrequired
string (uuid)
The plan price revision this charge was billed under, or null when the contract carries no
plan and bills its own inline amounts. Null too on records written before the field existed.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.
planIdrequired
string (uuid)
The plan the revision in `planPriceId` belongs to. Written together with it, and
null under exactly the same conditions.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.