ContractBillingSkip
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
The most recent billing run that found this contract due and did not charge it, and why. Set by the billing engine only, and cleared by the next run that reaches the processor or is covered by a proration credit.
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 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
skippedAt
required |
string (date-time) | When the run decided not to charge the contract, in UTC.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||
scheduledRunTime
required |
string (date-time) | The scheduled charge the run did not make, in UTC.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||
category
required |
RecurringBillingSkipCategory RecurringBillingSkipCategory | Why the run did not charge the 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.
| ||||||||||||
reason
required |
string | The billing engine's explanation of the skip, at most `MaxReasonLength`
characters. Never carries payment credential data.
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.