Lune · Schema

ClientAccount

Client accounts are designed for clients working with multi-tenancy applications. Client accounts are created programmatically. The API key (created in live or test mode) determines whether the Client account is a live or test account. Create a Client Account for each of your customers to segregate their API operations. Use the special `Lune-Account` header to perform operations against a specific Client Account.

LogisticsEmissionsCarbonSupply ChainSustainability

Properties

Name Type Description
id string The Account's unique identifier
name string The Account's name
organisation_id string The unique identifier of the organisation this account belongs to
organisation_type object
handle stringnull `handle` is a client defined URL-friendly string that identifies the account. The `handle` is unique per organisation and account type.
currency object
type object
logo stringnull The account logo
beneficiary stringnull Retirement beneficiary This is the name that appears on future retirements that are made in this account. If none is present, the organisation beneficiary will be used instead.
bundle_portfolio_id stringnull Bundle portfolio id tied to the account.
external_pages_visibility object
scope string
idempotency_key object
View JSON Schema on GitHub

JSON Schema

lune-client-account-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/lune/json-schema/lune-client-account-schema.json",
  "title": "ClientAccount",
  "description": "Client accounts are designed for clients working with multi-tenancy applications.\n\nClient accounts are created programmatically. The API key (created in live or test mode) determines whether the Client account is a live or test account.\n\nCreate a Client Account for each of your customers to segregate their API operations.\n\nUse the special `Lune-Account` header to perform operations against a specific Client Account.\n",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/lune-client-accounts-api-openapi.yml#/components/schemas/ClientAccount",
  "allOf": [
    {
      "$ref": "#/$defs/AccountBase"
    }
  ],
  "type": "object",
  "required": [
    "scope"
  ],
  "properties": {
    "scope": {
      "type": "string",
      "enum": [
        "client_account"
      ]
    },
    "idempotency_key": {
      "oneOf": [
        {
          "$ref": "#/$defs/AccountIdempotencyKey"
        },
        {
          "$ref": "#/$defs/NullEnum"
        }
      ]
    }
  },
  "$defs": {
    "AccountBase": {
      "type": "object",
      "required": [
        "id",
        "name",
        "organisation_id",
        "organisation_type",
        "handle",
        "currency",
        "type",
        "logo",
        "beneficiary",
        "bundle_portfolio_id",
        "external_pages_visibility"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "The Account's unique identifier"
        },
        "name": {
          "type": "string",
          "description": "The Account's name"
        },
        "organisation_id": {
          "type": "string",
          "description": "The unique identifier of the organisation this account belongs to"
        },
        "organisation_type": {
          "$ref": "#/$defs/AccountOrganisationType"
        },
        "handle": {
          "type": [
            "string",
            "null"
          ],
          "pattern": "^[a-z0-9-_]+$",
          "description": "`handle` is a client defined URL-friendly string that identifies the account.\n\nThe `handle` is unique per organisation and account type.\n"
        },
        "currency": {
          "$ref": "#/$defs/AccountCurrencyCode"
        },
        "type": {
          "$ref": "#/$defs/AccountType"
        },
        "logo": {
          "type": [
            "string",
            "null"
          ],
          "description": "The account logo"
        },
        "beneficiary": {
          "type": [
            "string",
            "null"
          ],
          "description": "Retirement beneficiary\n\nThis is the name that appears on future retirements that are made in this account.\nIf none is present, the organisation beneficiary will be used instead.\n",
          "minLength": 1
        },
        "bundle_portfolio_id": {
          "type": [
            "string",
            "null"
          ],
          "description": "Bundle portfolio id tied to the account."
        },
        "external_pages_visibility": {
          "$ref": "#/$defs/AccountExternalPagesVisibility"
        }
      }
    },
    "AccountCurrencyCode": {
      "type": "string",
      "description": "The account's currency.\n\nISO 4217 3 character currency code.\n\nNote: Lune does not support all currency codes.\n",
      "enum": [
        "GBP",
        "EUR",
        "USD",
        "SEK",
        "CHF",
        "PLN",
        "DKK",
        "NOK",
        "BGN",
        "INR",
        "SGD",
        "AED",
        "AUD",
        "HUF",
        "ISK",
        "CZK",
        "CAD"
      ]
    },
    "AccountExternalPagesVisibility": {
      "description": "Controls the visibility of external pages such as sustainability and analytics pages.\n\n`public` pages are visible to everyone.\n`private` pages are only visible through a verified JWT.\n`hidden` pages not visible.\n\nDefaults to `hidden`.\n",
      "type": "string",
      "enum": [
        "public",
        "hidden",
        "private"
      ]
    },
    "AccountIdempotencyKey": {
      "type": "string",
      "maxLength": 100,
      "description": "A unique identifier provided by the client.\n\n`idempotency_key` is unique per account type.\n\nIf an account with the same `idempotency_key` already exists, the API returns\nHTTP 409 Conflict with error code `account_idempotency_already_exists`.\n"
    },
    "AccountOrganisationType": {
      "type": "string",
      "description": "Indicates whether the account's organisation acts as a shipper or supplier.\n\nLegacy accounts without a stored value are returned as `shipper`.\n",
      "enum": [
        "shipper",
        "supplier"
      ]
    },
    "AccountType": {
      "type": "string",
      "description": "The account's type.\n",
      "enum": [
        "live",
        "test"
      ]
    },
    "NullEnum": {
      "type": [
        "string",
        "null"
      ],
      "x-lune-name": "Null",
      "description": "The property is set to `null`.",
      "enum": [
        null
      ]
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/lune-client-account"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.