Sustainability pages

Create a sustainability page

HTTP POST to /v1/sustainability-pagesCreate a public https://sustainability.lune.co/<slug> page to communicate your climate impact efforts.

Request body

statusstringrequired

The sustainability page status which determines whether it is visible to the public.

enabled

disabled

slugstringrequired

Pattern: ^[a-z0-9.-]+$

The sustainability page slug. The slug is used to identify the page publicly and should be unique.

titlestringrequired

The sustainability page title stat format.

by_volume

by_price

descriptionstringnullable

by_equivalent

by_supported_goals

by_custom_description

custom_descriptionstringnullable

The sustainability page custom description. Only displayed when description is set to by_custom_description.

sectionsarrayrequired

The sustainability page sections that will be displayed in the page. Only a single instance of each section type is allowed and the order is irrelevant.

string

The sustainability page section name.

bundles_breakdown

certificates

unsdg

Sample request

Response

A Sustainability Page represents the entity which enables accounts or client accounts to share their impact publicly.

Upon the first retirement, the Sustainability Page displays certificates with proof of the retired carbon credits and beneficiary.

statusstringrequired

The sustainability page status which determines whether it is visible to the public.

enabled

disabled

slugstringrequired

Pattern: ^[a-z0-9.-]+$

The sustainability page slug. The slug is used to identify the page publicly and should be unique.

titlestringrequired

The sustainability page title stat format.

by_volume

by_price

descriptionstringrequirednullable

by_equivalent

by_supported_goals

by_custom_description

custom_descriptionstringrequirednullable

The sustainability page custom description. Only displayed when description is set to by_custom_description.

sectionsarrayrequirednullable

The sustainability page sections that will be displayed in the page. Only a single instance of each section type is allowed and the order is irrelevant.

string

The sustainability page section name.

bundles_breakdown

certificates

unsdg

Sample response

Errors

This API operation can return the following errors:

HTTP status codeError code

400

api_version_invalid

400

bundle_selection_ratios_invalid

400

bundle_selection_bundle_invalid

400

order_value_invalid

400

bundle_id_invalid

400

id_invalid

400

distance_invalid

400

test_account_name_update_disallowed

400

bundle_selection_ratios_invalid_format

400

address_not_found

Update a sustainability page

HTTP PUT to /v1/sustainability-pagesUpdate the format, layout and status of your public https://sustainability.lune.co/<slug> page.

Request body

statusstringrequired

The sustainability page status which determines whether it is visible to the public.

enabled

disabled

slugstringrequired

Pattern: ^[a-z0-9.-]+$

The sustainability page slug. The slug is used to identify the page publicly and should be unique.

titlestringrequired

The sustainability page title stat format.

by_volume

by_price

descriptionstringnullable

by_equivalent

by_supported_goals

by_custom_description

custom_descriptionstringnullable

The sustainability page custom description. Only displayed when description is set to by_custom_description.

sectionsarrayrequired

The sustainability page sections that will be displayed in the page. Only a single instance of each section type is allowed and the order is irrelevant.

string

The sustainability page section name.

bundles_breakdown

certificates

unsdg

Sample request

Response

A Sustainability Page represents the entity which enables accounts or client accounts to share their impact publicly.

Upon the first retirement, the Sustainability Page displays certificates with proof of the retired carbon credits and beneficiary.

statusstringrequired

The sustainability page status which determines whether it is visible to the public.

enabled

disabled

slugstringrequired

Pattern: ^[a-z0-9.-]+$

The sustainability page slug. The slug is used to identify the page publicly and should be unique.

titlestringrequired

The sustainability page title stat format.

by_volume

by_price

descriptionstringrequirednullable

by_equivalent

by_supported_goals

by_custom_description

custom_descriptionstringrequirednullable

The sustainability page custom description. Only displayed when description is set to by_custom_description.

sectionsarrayrequirednullable

The sustainability page sections that will be displayed in the page. Only a single instance of each section type is allowed and the order is irrelevant.

string

The sustainability page section name.

bundles_breakdown

certificates

unsdg

Sample response

Errors

This API operation can return the following errors:

HTTP status codeError code

400

api_version_invalid

400

bundle_selection_ratios_invalid

400

bundle_selection_bundle_invalid

400

order_value_invalid

400

bundle_id_invalid

400

id_invalid

400

distance_invalid

400

test_account_name_update_disallowed

400

bundle_selection_ratios_invalid_format

400

address_not_found

Get the current account's sustainability page

HTTP GET to /v1/sustainability-pages/current-accountGet the configuration of the current account's sustainability page.

Sample request

Response

A Sustainability Page represents the entity which enables accounts or client accounts to share their impact publicly.

Upon the first retirement, the Sustainability Page displays certificates with proof of the retired carbon credits and beneficiary.

statusstringrequired

The sustainability page status which determines whether it is visible to the public.

enabled

disabled

slugstringrequired

Pattern: ^[a-z0-9.-]+$

The sustainability page slug. The slug is used to identify the page publicly and should be unique.

titlestringrequired

The sustainability page title stat format.

by_volume

by_price

descriptionstringrequirednullable

by_equivalent

by_supported_goals

by_custom_description

custom_descriptionstringrequirednullable

The sustainability page custom description. Only displayed when description is set to by_custom_description.

sectionsarrayrequirednullable

The sustainability page sections that will be displayed in the page. Only a single instance of each section type is allowed and the order is irrelevant.

string

The sustainability page section name.

bundles_breakdown

certificates

unsdg

Sample response

Errors

This API operation can return the following errors:

HTTP status codeError code

400

api_version_invalid

400

bundle_selection_ratios_invalid

400

bundle_selection_bundle_invalid

400

order_value_invalid

400

bundle_id_invalid

400

id_invalid

400

distance_invalid

400

test_account_name_update_disallowed

400

bundle_selection_ratios_invalid_format

400

address_not_found

Get a sustainability page

HTTP GET to /v1/sustainability-pages/public/{type}/{slug}

No authentication required

Get the current account's public sustainability summary info.

Query parameters

typestringrequired

The type of the sustainability page.

live

test

slugstringrequired

The slug of the sustainability page.

Sample request

Response

The public sustainability summary page for a given account.

titleoneOfrequired

The sustainability page title format and info.

descriptiononeOfrequired

logostringrequirednullable

The sustainability page logo URL.

organisation_logostringrequirednullable

The organisation logo

account_namestringrequired

The name of the account for which the sustainability page is generated.

include_certificatesbooleanrequired

Whether to include the certificates section in the sustainability page.

bundlesarrayrequirednullable

The sustainability page bundle percentages and details.

object

percent_of_totalnumberrequired

The volume of emissions offset via this bundle as a percentage of all offset emissions.

quantitystringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

The quantity of tCO2 offset via this bundle.

bundleobjectrequired

namestringrequired

The bundle's name

background_colourstringrequirednullable

A bundle's background colour in hexadecimal format

primary_imagestringrequirednullable

A bundle's image URL

primary_image_hiresstringrequirednullable

A bundle's high resolution image URL

small_thumbnailstringrequirednullable

A bundle's small thumbnail image URL

descriptionstringrequirednullable

The bundle's description

offset_typestringrequirednullable

Offset type classification

emissions_reduction

carbon_removal

carbon_permanencestringrequired

The bundle's carbon storage permanence.

long_term

short_term

no_storage

un_sdgarrayrequirednullable

The list of supported UN Sustainable Development Goals (SDGs).

The array is sorted by the goal number (the un_sdg_number property), ascending.

object

un_sdg_numbernumberrequired

The number which identifies the specific UN SDG.

occurrencesnumberrequired

The total number of projects supporting this UN SDG.

Sample response

Errors

This API operation can return the following errors:

HTTP status codeError code

400

api_version_invalid

400

bundle_selection_ratios_invalid

400

bundle_selection_bundle_invalid

400

order_value_invalid

400

bundle_id_invalid

400

id_invalid

400

distance_invalid

400

test_account_name_update_disallowed

400

bundle_selection_ratios_invalid_format

400

address_not_found

Get a sustainability page

HTTP GET to /v1/sustainability-pages/public/{organisation_id}/{type}/{handle}

No authentication required

Get the current account's public sustainability summary info.

Query parameters

organisation_idstringrequired

The unique identifier of the organisation this account belongs to

typestringrequired

The type of the sustainability page.

live

test

handlestringrequired

The handle of the sustainability page's account.

Sample request

Response

The public sustainability summary page for a given account.

titleoneOfrequired

The sustainability page title format and info.

descriptiononeOfrequired

logostringrequirednullable

The sustainability page logo URL.

organisation_logostringrequirednullable

The organisation logo

account_namestringrequired

The name of the account for which the sustainability page is generated.

include_certificatesbooleanrequired

Whether to include the certificates section in the sustainability page.

bundlesarrayrequirednullable

The sustainability page bundle percentages and details.

object

percent_of_totalnumberrequired

The volume of emissions offset via this bundle as a percentage of all offset emissions.

quantitystringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

The quantity of tCO2 offset via this bundle.

bundleobjectrequired

namestringrequired

The bundle's name

background_colourstringrequirednullable

A bundle's background colour in hexadecimal format

primary_imagestringrequirednullable

A bundle's image URL

primary_image_hiresstringrequirednullable

A bundle's high resolution image URL

small_thumbnailstringrequirednullable

A bundle's small thumbnail image URL

descriptionstringrequirednullable

The bundle's description

offset_typestringrequirednullable

Offset type classification

emissions_reduction

carbon_removal

carbon_permanencestringrequired

The bundle's carbon storage permanence.

long_term

short_term

no_storage

un_sdgarrayrequirednullable

The list of supported UN Sustainable Development Goals (SDGs).

The array is sorted by the goal number (the un_sdg_number property), ascending.

object

un_sdg_numbernumberrequired

The number which identifies the specific UN SDG.

occurrencesnumberrequired

The total number of projects supporting this UN SDG.

Sample response

Errors

This API operation can return the following errors:

HTTP status codeError code

404

429