Skip to main content

object

Acquisition

LLM
View as Markdown
Open llms.txt

The checkout path currently available to the workspace. Assigned-offer details are present only when mode is assigned_offer. Unavailable means the assigned offer could not be safely resolved and checkout must remain disabled until status is refreshed.

Variants

Use mode to choose one of `catalog`, `assigned_offer`, `unavailable`.

CatalogBillingAcquisition

catalog

Required: `mode`.

  • Name
    mode
    Type
    enum
    Description
    Required property. Allowed values: catalog.

Example

catalog
{
  "mode": "catalog"
}

AssignedOfferBillingAcquisition

assigned_offer

Required: `mode`, `key`, `revision`, `plan`, `productName`, `base`, `overage`.

  • Name
    mode
    Type
    enum
    Description
    Required property. Allowed values: assigned_offer.
  • Name
    key
    Type
    string
    Description
    Stable assigned-offer key.
  • Name
    revision
    Type
    string
    Description
    Opaque assigned-offer revision required to start Checkout.
  • Name
    plan
    Type
    enum
    Description
    Canonical plan granted by the assigned offer. Allowed values: ultimate.
  • Name
    productName
    Type
    string
    Description
    Customer-facing assigned-offer name.
  • Name
    base
    Type
    OfferBase
    Description
    Required property.
  • Name
    overage
    Type
    OfferOverage
    Description
    Required property.

Example

assigned_offer
{
  "mode": "assigned_offer",
  "key": "string",
  "revision": "string",
  "plan": "ultimate",
  "productName": "string",
  "base": {
    "currency": "usd",
    "unitAmount": 0,
    "interval": "monthly"
  },
  "overage": {
    "includedQuantity": 0,
    "unitAmount": 0,
    "interval": "monthly"
  }
}

UnavailableBillingAcquisition

unavailable

Required: `mode`.

  • Name
    mode
    Type
    enum
    Description
    Required property. Allowed values: unavailable.

Example

unavailable
{
  "mode": "unavailable"
}

Related operations