{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/lune/json-schema/lune-account-schema.json",
  "title": "Account",
  "description": "An Account represents the entity which performs API operations.\n\nEach API operation like creating an order or creating an emission estimate is ring-fenced within an Account.\n",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/lune-accounts-api-openapi.yml#/components/schemas/Account",
  "allOf": [
    {
      "$ref": "#/$defs/AccountBase"
    }
  ],
  "type": "object",
  "required": [
    "scope",
    "sibling_id"
  ],
  "properties": {
    "scope": {
      "type": "string",
      "enum": [
        "account"
      ]
    },
    "sibling_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "Account id of the paired account.\n\nA live account points to its sibling test account and vice versa.\n"
    }
  },
  "$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"
      ]
    },
    "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"
      ]
    }
  }
}