Skip to main content
​
lago_id
string<uuid>
required

Unique identifier of the order form, created by Lago.

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

​
number
string
required

The unique number assigned to the order form by Lago.

Example:

"OF-2026-0001"

​
status
enum<string>
required

The status of the order form. It can be any of the following values:

  • generated: the order form is waiting for the customer's signature.
  • signed: the customer has signed, and an order has been created from the order form.
  • expired: the order form reached its expires_at without being signed.
  • voided: the order form has been voided before being signed.

Only a generated order form is actionable. Reaching expired or voided also voids the quote version the order form was generated from; signing does not, since the deal it quotes goes on to be executed.

Available options:
generated,
signed,
expired,
voided
Example:

"generated"

​
void_reason
enum<string> | null
required

The reason why the order form is no longer actionable. It is null unless the status is voided or expired. It can be any of the following values:

  • manual: the order form has been voided explicitly, through the API or the Lago user interface.
  • expired: the order form reached its expires_at without being signed.
  • invalid: reserved for an order form Lago voids because it can no longer be executed. No flow writes it yet.
Available options:
null,
manual,
expired,
invalid
Example:

"manual"

​
expires_at
string<date-time> | null
required

The date and time in UTC (ISO 8601) after which the order form is meant to expire. It is null when the order form never expires. It is validated when the quote is approved, where a value on or after the day the quoted deal stops being executable is rejected rather than clamped. Expiry is then swept hourly and compared by calendar date, so signing keeps succeeding until the sweep moves the order form to expired.

Example:

"2026-06-30T23:59:59Z"

​
signed_at
string<date-time> | null
required

The date and time in UTC (ISO 8601) when the order form was marked as signed. It is null unless the status is signed.

Example:

"2026-04-29T08:59:51Z"

​
voided_at
string<date-time> | null
required

The date and time in UTC (ISO 8601) when the order form stopped being actionable. It is set both when the order form is voided and when it expires, and is null otherwise.

Example:

"2026-04-29T08:59:51Z"

​
signed_document_url
string<uri> | null
required

The URL of the signed document attached to the order form. It is null when no document was uploaded.

Example:

"https://api.getlago.com/rails/active_storage/blobs/redirect/eyJfcmFpbHMi/OF-2026-0001"

​
lago_organization_id
string<uuid>
required

Unique identifier of the organization, created by Lago.

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

​
lago_customer_id
string<uuid>
required

Unique identifier of the customer the order form is addressed to, created by Lago.

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

​
lago_quote_id
string<uuid>
required

Unique identifier of the quote the order form comes from, created by Lago.

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

​
lago_quote_version_id
string<uuid>
required

Unique identifier of the approved quote version the order form was generated from, created by Lago. A quote version carries at most one order form.

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

​
created_at
string<date-time>
required

The date and time in UTC (ISO 8601) when the order form was created.

Example:

"2026-04-29T08:59:51Z"

​
updated_at
string<date-time>
required

The date and time in UTC (ISO 8601) when the order form was last updated.

Example:

"2026-04-29T08:59:51Z"