The order object

{
  "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
  "number": "OR-2026-0001",
  "status": "created",
  "order_type": "subscription_creation",
  "execution_mode": "execute_in_lago",
  "currency": "USD",
  "executed_at": "2026-07-01T00:00:00Z",
  "execution_record": {
    "executed_at": "2026-07-01T00:00:00Z",
    "execution_mode": "execute_in_lago",
    "invoice_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "subscription_ids": [
      "1a901a90-1a90-1a90-1a90-1a901a901a90"
    ],
    "terminated_subscription_ids": [
      "1a901a90-1a90-1a90-1a90-1a901a901a90"
    ],
    "applied_coupon_ids": [
      "1a901a90-1a90-1a90-1a90-1a901a901a90"
    ],
    "wallet_ids": [
      "1a901a90-1a90-1a90-1a90-1a901a901a90"
    ],
    "errors": [
      "plan_not_found"
    ]
  },
  "lago_organization_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
  "lago_customer_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
  "lago_order_form_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
  "created_at": "2026-04-29T08:59:51Z",
  "updated_at": "2026-04-29T08:59:51Z",
  "billing_snapshot": {
    "addOns": [
      {
        "id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "localId": "b5c1e2a4-4e1e-4a7f-9f0e-9c1a0c7e1f2b",
        "type": "add_on",
        "payload": {
          "code": "setup_fee",
          "units": 1,
          "unitAmountCents": 10000,
          "totalAmountCents": 10000,
          "fromDatetime": "2026-01-01T00:00:00Z",
          "toDatetime": "2026-12-31T23:59:59Z"
        },
        "overrides": {
          "description": "Onboarding package, discounted for the first year",
          "units": 2,
          "unitAmountCents": 8000,
          "totalAmountCents": 16000,
          "invoiceDisplayName": "Onboarding",
          "fromDatetime": "2026-01-01T00:00:00Z",
          "toDatetime": "2026-12-31T23:59:59Z"
        }
      }
    ],
    "plans": [
      {
        "id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "type": "plan",
        "payload": {
          "code": "premium_plan",
          "subscriptionExternalId": "sub_1234567890",
          "subscriptionName": "Premium plan - Acme Corp",
          "billingTime": "calendar",
          "startDate": "2026-01-01T00:00:00Z",
          "endDate": "2027-01-01T00:00:00Z",
          "paymentMethodId": "1a901a90-1a90-1a90-1a90-1a901a901a90",
          "charges": [
            {
              "id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
              "billableMetric": {
                "code": "api_calls"
              },
              "chargeModel": "standard"
            }
          ],
          "fixedCharges": [
            {
              "id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
              "addOn": {
                "code": "seats"
              },
              "chargeModel": "standard"
            }
          ]
        },
        "localId": "b5c1e2a4-4e1e-4a7f-9f0e-9c1a0c7e1f2b",
        "overrides": {
          "amountCents": 50000,
          "amountCurrency": "USD",
          "invoiceDisplayName": "Premium",
          "name": "Premium plan - Acme Corp",
          "description": "Negotiated premium plan",
          "trialPeriod": 30,
          "minimumCommitment": {
            "amountCents": 100000,
            "invoiceDisplayName": "Annual commitment"
          },
          "usageThresholds": [
            {
              "amountCents": 100000,
              "recurring": false,
              "thresholdDisplayName": "First 1,000 EUR of usage"
            }
          ],
          "charges": [
            {
              "billableMetricCode": "api_calls",
              "chargeModel": "standard",
              "properties": {
                "amount": "0.02"
              },
              "minAmountCents": 10000,
              "invoiceDisplayName": "API calls"
            }
          ],
          "fixedCharges": [
            {
              "addOnCode": "seats",
              "units": "10",
              "properties": {
                "amount": "5"
              },
              "invoiceDisplayName": "Seats"
            }
          ]
        }
      }
    ],
    "coupons": [
      {
        "id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "localId": "b5c1e2a4-4e1e-4a7f-9f0e-9c1a0c7e1f2b",
        "type": "coupon",
        "payload": {
          "code": "welcome_offer",
          "type": "fixed_amount",
          "amountCents": 10000,
          "currency": "USD",
          "percentageRate": 10.5,
          "frequency": "once",
          "frequencyDuration": 3
        },
        "overrides": {
          "amountCents": 15000,
          "amountCurrency": "USD",
          "percentageRate": 15,
          "frequency": "recurring",
          "frequencyDuration": 6
        }
      }
    ],
    "walletCredits": [
      {
        "localId": "b5c1e2a4-4e1e-4a7f-9f0e-9c1a0c7e1f2b",
        "type": "wallet_credit",
        "payload": {
          "paidCredits": "100.0",
          "grantedCredits": "20.0",
          "rateAmount": "1.0",
          "currency": "USD",
          "expirationAt": "2027-01-01T00:00:00Z",
          "appliesTo": {
            "feeTypes": [
              "charge"
            ],
            "billableMetricCodes": [
              "api_calls"
            ]
          },
          "recurringTransactionRules": [
            {
              "trigger": "interval",
              "interval": "monthly",
              "thresholdCredits": "10.0",
              "method": "fixed",
              "targetOngoingBalance": "100.0",
              "grantsTargetTopUp": false,
              "paidCredits": "100.0",
              "grantedCredits": "20.0",
              "startedAt": "2026-01-01T00:00:00Z",
              "expirationAt": "2027-01-01T00:00:00Z",
              "transactionName": "Monthly top-up",
              "invoiceRequiresSuccessfulPayment": false
            }
          ]
        }
      }
    ]
  }
}

lago_id

string<uuid>

required

Unique identifier of the order, created by Lago.

Example:

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

number

string

required

The unique number assigned to the order by Lago.

Example:

"OR-2026-0001"

status

enum<string>

required

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

created: the order has been created from a signed order form and is waiting to be executed.
executed: the order has been carried out. What it produced is listed in execution_record.
failed: the execution was attempted and rolled back. The reasons are listed in execution_record.errors. Lago does not retry on its own, so a new attempt has to be triggered through the execute endpoint.

Available options:

created,

executed,

failed

Example:

"created"

order_type

enum<string>

required

The commercial motion the quote describes. It can be any of the following values:

subscription_creation: the quote creates one or more subscriptions.
subscription_amendment: the quote amends an existing subscription, named by the quote's own lago_subscription_id.
one_off: the quote bills add-ons once, without any subscription.

Available options:

subscription_creation,

subscription_amendment,

one_off

Example:

"subscription_creation"

execution_mode

enum<string> | null

required

How the order is carried out. It is null while the order has neither been scheduled nor executed. It can be any of the following values:

execute_in_lago: Lago applies the quoted deal itself, creating the subscriptions, coupons, wallets or one-off invoice it describes.
order_only: Lago records the order without applying it, leaving the execution to your own systems.

Available options:

null,

execute_in_lago,

order_only

Example:

"execute_in_lago"

currency

enum<string> | null

required

The currency the order is denominated in, inherited from the quote version it comes from.

Available options:

null,

AED,

AFN,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BWP,

BYN,

BZD,

CAD,

CDF,

CHF,

CLF,

CLP,

CNY,

COP,

CRC,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

INR,

ISK,

JMD,

JPY,

KES,

KGS,

KHR,

KMF,

KRW,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

MAD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRO,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SEK,

SGD,

SHP,

SLL,

SOS,

SRD,

STD,

SZL,

THB,

TJS,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

UYU,

UZS,

VND,

VUV,

WST,

XAF,

XCD,

XOF,

XPF,

YER,

ZAR,

ZMW

Example:

"USD"

executed_at

string<date-time> | null

required

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

Example:

"2026-07-01T00:00:00Z"

execution_record

object

required

A trace of what the execution produced. Every key is always present, whichever the order type, so a reader never has to tell a missing key from an empty one; the keys that do not apply keep their empty value.

Which ones are filled depends on the order_type of the quote, and only for an execute_in_lago order: invoice_id for one_off, subscription_ids with applied_coupon_ids and wallet_ids for subscription_creation, and the same plus terminated_subscription_ids for subscription_amendment. An order_only order records the mode and the timestamp alone.

Show child attributes

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 was placed for, created by Lago.

Example:

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

lago_order_form_id

string<uuid>

required

Unique identifier of the signed order form the order comes from, created by Lago. An order form carries at most one order.

Example:

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

created_at

string<date-time>

required

The date and time in UTC (ISO 8601) when the order 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 was last updated.

Example:

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

billing_snapshot

object | null

required

The billing items of the quote version the order comes from, as they stood when it was approved. This is what the execution applies. It is omitted from the webhook payloads, being a heavy blob.

Show child attributes

⌘I