PublicSustainabilityPage

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/lune/json-schema/lune-public-sustainability-page-schema.json",
  "title": "PublicSustainabilityPage",
  "description": "The public sustainability summary page for a given account.",
  "x-generated": "2026-10-29",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/lune-openapi.yml#/components/schemas/PublicSustainabilityPage",
  "type": "object",
  "required": [
    "title",
    "description",
    "include_certificates",
    "bundles",
    "un_sdg",
    "logo",
    "organisation_logo",
    "account_name"
  ],
  "properties": {
    "title": {
      "description": "The sustainability page title format and info.",
      "oneOf": [
        {
          "type": "object",
          "x-lune-name": "By value",
          "required": [
            "format",
            "currency",
            "value"
          ],
          "properties": {
            "format": {
              "type": "string",
              "enum": [
                "by_price"
              ]
            },
            "currency": {
              "$ref": "#/$defs/CurrencyCode"
            },
            "value": {
              "$ref": "#/$defs/MonetaryAmountValue"
            }
          }
        },
        {
          "type": "object",
          "x-lune-name": "By quantity",
          "required": [
            "format",
            "quantity"
          ],
          "properties": {
            "format": {
              "type": "string",
              "enum": [
                "by_volume"
              ]
            },
            "quantity": {
              "type": "string",
              "description": "The total quantity of tCO2 offset by all completed orders.",
              "pattern": "^[0-9]+(\\.[0-9]+)?$"
            }
          }
        }
      ]
    },
    "description": {
      "oneOf": [
        {
          "$ref": "#/$defs/NullEnum"
        },
        {
          "type": "object",
          "x-lune-name": "New York to London flights",
          "required": [
            "format",
            "flights_nyc_to_london"
          ],
          "properties": {
            "format": {
              "type": "string",
              "enum": [
                "by_equivalent"
              ]
            },
            "flights_nyc_to_london": {
              "type": "number",
              "description": "The number of one-way flights from NYC to London the emissions of which are an equivalent to the CO2 reduction."
            }
          }
        },
        {
          "type": "object",
          "x-lune-name": "UN SDGs and projects",
          "required": [
            "format",
            "number_of_un_sdgs",
            "number_of_projects"
          ],
          "properties": {
            "format": {
              "type": "string",
              "enum": [
                "by_supported_goals"
              ]
            },
            "number_of_un_sdgs": {
              "type": "number",
              "description": "The number of supported UN Sustainable Development Goals (SDGs)."
            },
            "number_of_projects": {
              "type": "number",
              "description": "The number of supported carbon offset projects."
            }
          }
        },
        {
          "type": "object",
          "x-lune-name": "Custom description",
          "required": [
            "format",
            "custom_description"
          ],
          "properties": {
            "format": {
              "type": "string",
              "enum": [
                "by_custom_description"
              ]
            },
            "custom_description": {
              "type": [
                "string",
                "null"
              ],
              "description": "The custom description of the sustainability page provided in the configuration."
            }
          }
        }
      ]
    },
    "logo": {
      "type": [
        "string",
        "null"
      ],
      "description": "The sustainability page logo URL."
    },
    "organisation_logo": {
      "type": [
        "string",
        "null"
      ],
      "description": "The organisation logo"
    },
    "account_name": {
      "type": "string",
      "description": "The name of the account for which the sustainability page is generated."
    },
    "include_certificates": {
      "type": "boolean",
      "description": "Whether to include the certificates section in the sustainability page."
    },
    "bundles": {
      "type": [
        "array",
        "null"
      ],
      "description": "The sustainability page bundle percentages and details.",
      "items": {
        "type": "object",
        "required": [
          "percent_of_total",
          "bundle",
          "quantity"
        ],
        "properties": {
          "percent_of_total": {
            "type": "number",
            "description": "The volume of emissions offset via this bundle as a percentage of all offset emissions."
          },
          "quantity": {
            "type": "string",
            "description": "The quantity of tCO2 offset via this bundle.",
            "pattern": "^[0-9]+(\\.[0-9]+)?$"
          },
          "bundle": {
            "type": "object",
            "required": [
              "name",
              "background_colour",
              "primary_image",
              "primary_image_hires",
              "small_thumbnail",
              "description",
              "offset_type",
              "carbon_permanence"
            ],
            "properties": {
              "name": {
                "type": "string",
                "description": "The bundle's name"
              },
              "background_colour": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "A bundle's background colour in hexadecimal format"
              },
              "primary_image": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "A bundle's image URL"
              },
              "primary_image_hires": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "A bundle's high resolution image URL"
              },
              "small_thumbnail": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "A bundle's small thumbnail image URL"
              },
              "description": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The bundle's description"
              },
              "offset_type": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Offset type classification\n",
                "enum": [
                  "emissions_reduction",
                  "carbon_removal",
                  null
                ]
              },
              "carbon_permanence": {
                "$ref": "#/$defs/CarbonPermanence"
              }
            }
          }
        }
      }
    },
    "un_sdg": {
      "$ref": "#/$defs/SupportedUNSdg"
    }
  },
  "$defs": {
    "CarbonPermanence": {
      "type": "string",
      "description": "The bundle's carbon storage permanence.",
      "enum": [
        "long_term",
        "short_term",
        "no_storage"
      ]
    },
    "CurrencyCode": {
      "x-lune-name": "Currency code",
      "type": "string",
      "description": "ISO 4217 3 character currency code.\n\nNote: Lune supports most but not all currency codes.\n",
      "enum": [
        "AED",
        "AFN",
        "ALL",
        "AMD",
        "ANG",
        "AOA",
        "ARS",
        "AUD",
        "AWG",
        "AZN",
        "BAM",
        "BBD",
        "BDT",
        "BGN",
        "BHD",
        "BIF",
        "BMD",
        "BND",
        "BOB",
        "BRL",
        "BSD",
        "BTC",
        "BTN",
        "BWP",
        "BYN",
        "BYR",
        "BZD",
        "CAD",
        "CDF",
        "CHF",
        "CLF",
        "CLP",
        "CNY",
        "CNH",
        "COP",
        "CRC",
        "CUC",
        "CUP",
        "CVE",
        "CZK",
        "DJF",
        "DKK",
        "DOP",
        "DZD",
        "EGP",
        "ERN",
        "ETB",
        "EUR",
        "FJD",
        "FKP",
        "GBP",
        "GEL",
        "GGP",
        "GHS",
        "GIP",
        "GMD",
        "GNF",
        "GTQ",
        "GYD",
        "HKD",
        "HNL",
        "HRK",
        "HTG",
        "HUF",
        "IDR",
        "ILS",
        "IMP",
        "INR",
        "IQD",
        "IRR",
        "ISK",
        "JEP",
        "JMD",
        "JOD",
        "JPY",
        "KES",
        "KGS",
        "KHR",
        "KMF",
        "KPW",
        "KRW",
        "KWD",
        "KYD",
        "KZT",
        "LAK",
        "LBP",
        "LKR",
        "LRD",
        "LSL",
        "LTL",
        "LVL",
        "LYD",
        "MAD",
        "MDL",
        "MGA",
        "MKD",
        "MMK",
        "MNT",
        "MOP",
        "MRU",
        "MUR",
        "MVR",
        "MWK",
        "MXN",
        "MYR",
        "MZN",
        "NAD",
        "NGN",
        "NIO",
        "NOK",
        "NPR",
        "NZD",
        "OMR",
        "PAB",
        "PEN",
        "PGK",
        "PHP",
        "PKR",
        "PLN",
        "PYG",
        "QAR",
        "RON",
        "RSD",
        "RUB",
        "RWF",
        "SAR",
        "SBD",
        "SCR",
        "SDG",
        "SEK",
        "SGD",
        "SHP",
        "SLE",
        "SLL",
        "SOS",
        "SRD",
        "STD",
        "SVC",
        "SYP",
        "SZL",
        "THB",
        "TJS",
        "TMT",
        "TND",
        "TOP",
        "TRY",
        "TTD",
        "TWD",
        "TZS",
        "UAH",
        "UGX",
        "USD",
        "UYU",
        "UZS",
        "VES",
        "VND",
        "VUV",
        "WST",
        "XAF",
        "XAG",
        "XAU",
        "XCD",
        "XDR",
        "XOF",
        "XPF",
        "YER",
        "ZAR",
        "ZMK",
        "ZMW",
        "ZWL"
      ]
    },
    "MonetaryAmountValue": {
      "type": "string",
      "pattern": "^[0-9]+(\\.[0-9]+)?$",
      "description": "Specify the monetary value in the currency defined by the `currency_code` property in the request. If no `currency_code` is provided, the currency will default to that of the associated account.\n"
    },
    "NullEnum": {
      "type": [
        "string",
        "null"
      ],
      "x-lune-name": "Null",
      "description": "The property is set to `null`.",
      "enum": [
        null
      ]
    },
    "SupportedUNSdg": {
      "type": [
        "array",
        "null"
      ],
      "description": "The list of supported UN Sustainable Development Goals (SDGs).\n\nThe array is sorted by the goal number (the `un_sdg_number` property), ascending.\n",
      "items": {
        "type": "object",
        "required": [
          "un_sdg_number",
          "occurrences"
        ],
        "properties": {
          "un_sdg_number": {
            "type": "number",
            "description": "The number which identifies the specific UN SDG."
          },
          "occurrences": {
            "type": "number",
            "description": "The total number of projects supporting this UN SDG."
          }
        }
      }
    }
  }
}