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-23 00:19 UTC.

API reference Models

ContractPauseDto

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

Payload for pausing a contract: why, and optionally the day billing should resume on its own.

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
reason required string Why the contract is being paused, in the operator's own words. Optional; shown on the contract while it is paused. At most 500 characters. 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.
expectedResumeDate required string (date-time) The calendar day, in UTC, on which the daily billing run resumes the contract on its own. Leave empty for a pause that only an operator ends. Must not be in the past; the viewer's own calendar day is accepted everywhere on earth, and a day already behind in UTC resumes the contract on the next daily run. Only the date is kept: any time of day is discarded, after a value carrying an offset is converted to UTC, so send the bare date. The contract resumes on the first recurring billing run, scheduled or started by an operator, whose UTC date is on or after that day; the sandbox run-now operation does not resume paused 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 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.