Orders

Create an order by mass

HTTP POST to /v1/orders/by-mass

Request body

oneOf
Total mass and per-bundle percentages

Sample request

Response

idstringrequired

The order's unique identifier

idempotency_keystringrequirednullable

Account-unique identifier provided by the client.

idempotency_key has two purposes:

Clients can safely retry order requests without accidentally performing the same operation twice. The current state of the original order is returned.
Clients can use idempotency_key to reconcile orders with other entities on their system.

typestringrequired

Identifies whether the order has been placed by quantity (kg CO2) or value (monetary amount)

quantity

value

statusstringrequired

Order status

received

placed

paid

retiring

cancelled

currencystringrequired

Order currency code

offset_coststringrequirednullable

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

The net offset cost being purchased. May be lower than requested_value.

This property is set when bundles are assigned to the order. Unit: order currency

total_coststringrequirednullable

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

The total cost for the order inclusive of fees.

Unit: order currency

commissionstringrequirednullable

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

Lune's fee.

This property is set when bundles are assigned to the order. Unit: order currency

quantitystringrequirednullable

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

Quantity of CO2 offsets purchased in tonnes.

payment_methodstringrequirednullable

How the order will be paid. When card, Lune will attempt to charge the card and pay this order. When invoice, Lune will email an invoice with payment instructions.

invoice

card

created_atstring (date-time)required

Order creation timestamp

bundlesarrayrequirednullable

bundles are set when the order's status is placed, paid, retiring or complete.

The bundles associated with the order including their relative quantity and cost breakdown.

object

bundle_idstringrequired

The bundle's unique identifier

bundle_namestringrequired

The bundle's name

primary_imagestring

A bundle's image URL

quantitystringrequired

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

Quantity for the specific bundle (tonnes CO2)

unit_pricestringrequired

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

Bundle unit price per tonne CO2

Unit: order currency

gross_unit_pricestringrequired

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

Bundle unit price per tonne CO2 inclusive of fees.

Unit: order currency

offset_coststringrequired

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

The bundle's net offset cost being purchased.

Unit: order currency

insufficient_available_quantitybooleanrequirednullable

If true, there is no inventory necessary to fully satisfy the order for this bundle.

projectsarrayrequirednullable

Projects are set when the order's status is retiring or complete.

The projects associated with the order including their relative quantity and cost breakdown.

Orders are placed against bundles, not projects. Projects in a bundle may change based on supply.

This property is set as soon as we can guarantee project supply.

object

project_idstringrequired

The project's unique identifier

project_namestringrequired

The project's name

project_typestringrequired

The project's offset type, eg Forest conservation, Afforestation, Direct Air Capture

project_slugstringrequired

The project's unique slug

project_logostring

URL to the project's logo

quantitystringrequired

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

Carbon offset purchased (tonnes CO2)

unit_pricestringrequired

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

Project unit price per tonne CO2

Unit: order currency

offset_coststringrequired

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

The net offset cost being purchased.

Unit: order currency

statusstringrequired

Describes whether credits for a project have been allocated to an order or retired

allocated

retired

certificatestringrequirednullable

Carbon credits PDF certificate URL.

This property is set when an order has state 'complete'

The property is set (and the certificate is available) regardless of the Sustainability page configuration.

The URL requires API authentication and cannot be accessed anonymously.

public_certificate_urlstringrequirednullable

The Carbon credits certificate public URL.

Once the Sustainability page of the associated account is enabled and configured to include the certificate section, and the order is set to 'complete', this URL will link to the publicly accessible certificate.

metadataobjectrequired

An arbitrary dictionary (key-value pairs) to store application-specific information.

Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.

offset_link_idstringrequirednullable

The offset link identifier, if the order was placed through an offset link

emailstringrequirednullable

End-user email.

This property is currently populated on orders placed through offset links.

requested_quantitystringrequired

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

Requested quantity of CO2 offsets to purchase in tonnes.

requested_valueoneOfrequired
Null

Requested value of CO2 offsets to purchase in the account's currency.

estimate_idoneOfrequired
Null

The emission calculation unique identifier

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

Create an order by value

HTTP POST to /v1/orders/by-value

Request body

valuestringrequired

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

Maximum price of CO2 offsets to purchase (in the account's currency).

value must not be lower than the currency's minimum unit.

idempotency_keystring

Account-unique identifier provided by the client.

idempotency_key has two purposes:

Clients can safely retry order requests without accidentally performing the same operation twice. The current state of the original order is returned.
Clients can use idempotency_key to reconcile orders with other entities on their system.

bundle_selectionarray

Bundle selection to be used for the order. For the order, this property overrides the account's bundle selection.

object

Maps a bundle id to an allocation ratio

bundle_idstringrequired

The bundle's unique identifier

percentageoneOf
Selection percentage as integer

metadataobject

An arbitrary dictionary (key-value pairs) to store application-specific information.

Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.

quantity_truncstring

Selects to which precision to truncate quantities specific to carbon offsetting.

g

kg

t

Sample request

Response

idstringrequired

The order's unique identifier

idempotency_keystringrequirednullable

Account-unique identifier provided by the client.

idempotency_key has two purposes:

Clients can safely retry order requests without accidentally performing the same operation twice. The current state of the original order is returned.
Clients can use idempotency_key to reconcile orders with other entities on their system.

typestringrequired

Identifies whether the order has been placed by quantity (kg CO2) or value (monetary amount)

quantity

value

statusstringrequired

Order status

received

placed

paid

retiring

cancelled

currencystringrequired

Order currency code

offset_coststringrequirednullable

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

The net offset cost being purchased. May be lower than requested_value.

This property is set when bundles are assigned to the order. Unit: order currency

total_coststringrequirednullable

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

The total cost for the order inclusive of fees.

Unit: order currency

commissionstringrequirednullable

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

Lune's fee.

This property is set when bundles are assigned to the order. Unit: order currency

quantitystringrequirednullable

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

Quantity of CO2 offsets purchased in tonnes.

payment_methodstringrequirednullable

How the order will be paid. When card, Lune will attempt to charge the card and pay this order. When invoice, Lune will email an invoice with payment instructions.

invoice

card

created_atstring (date-time)required

Order creation timestamp

bundlesarrayrequirednullable

bundles are set when the order's status is placed, paid, retiring or complete.

The bundles associated with the order including their relative quantity and cost breakdown.

object

bundle_idstringrequired

The bundle's unique identifier

bundle_namestringrequired

The bundle's name

primary_imagestring

A bundle's image URL

quantitystringrequired

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

Quantity for the specific bundle (tonnes CO2)

unit_pricestringrequired

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

Bundle unit price per tonne CO2

Unit: order currency

gross_unit_pricestringrequired

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

Bundle unit price per tonne CO2 inclusive of fees.

Unit: order currency

offset_coststringrequired

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

The bundle's net offset cost being purchased.

Unit: order currency

insufficient_available_quantitybooleanrequirednullable

If true, there is no inventory necessary to fully satisfy the order for this bundle.

projectsarrayrequirednullable

Projects are set when the order's status is retiring or complete.

The projects associated with the order including their relative quantity and cost breakdown.

Orders are placed against bundles, not projects. Projects in a bundle may change based on supply.

This property is set as soon as we can guarantee project supply.

object

project_idstringrequired

The project's unique identifier

project_namestringrequired

The project's name

project_typestringrequired

The project's offset type, eg Forest conservation, Afforestation, Direct Air Capture

project_slugstringrequired

The project's unique slug

project_logostring

URL to the project's logo

quantitystringrequired

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

Carbon offset purchased (tonnes CO2)

unit_pricestringrequired

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

Project unit price per tonne CO2

Unit: order currency

offset_coststringrequired

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

The net offset cost being purchased.

Unit: order currency

statusstringrequired

Describes whether credits for a project have been allocated to an order or retired

allocated

retired

certificatestringrequirednullable

Carbon credits PDF certificate URL.

This property is set when an order has state 'complete'

The property is set (and the certificate is available) regardless of the Sustainability page configuration.

The URL requires API authentication and cannot be accessed anonymously.

public_certificate_urlstringrequirednullable

The Carbon credits certificate public URL.

metadataobjectrequired

An arbitrary dictionary (key-value pairs) to store application-specific information.

Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.

offset_link_idstringrequirednullable

The offset link identifier, if the order was placed through an offset link

emailstringrequirednullable

End-user email.

This property is currently populated on orders placed through offset links.

requested_valuestringrequired

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

Requested value of CO2 offsets to purchase in the account's currency.

requested_quantityoneOfrequired
Null

Requested quantity of CO2 offsets to purchase in tonnes.

estimate_idoneOfrequired
Null

The emission calculation unique identifier

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

Create an order by estimate id

HTTP POST to /v1/orders/by-estimate

Request body

estimate_idstringrequired

The emission calculation unique identifier

idempotency_keystring

Account-unique identifier provided by the client.

idempotency_key has two purposes:

Clients can safely retry order requests without accidentally performing the same operation twice. The current state of the original order is returned.
Clients can use idempotency_key to reconcile orders with other entities on their system.

bundle_selectionarray

Bundle selection percentages.

The sum of all percentages must equal 100.

If not specified, the preconfigured allocation ratios are going to be used.

If, for each selection, percentage is not provided, the selection is divided equally (best effort) between bundles. percentage must be provided for all or none of the bundles.

object

Maps a bundle id to an allocation ratio

bundle_idstringrequired

The bundle's unique identifier

percentageoneOf
Selection percentage as integer

metadataobject

An arbitrary dictionary (key-value pairs) to store application-specific information.

Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.

quantity_truncstring

Selects to which precision to truncate quantities specific to carbon offsetting.

g

kg

t

Sample request

Response

idstringrequired

The order's unique identifier

idempotency_keystringrequirednullable

Account-unique identifier provided by the client.

idempotency_key has two purposes:

Clients can safely retry order requests without accidentally performing the same operation twice. The current state of the original order is returned.
Clients can use idempotency_key to reconcile orders with other entities on their system.

typestringrequired

Identifies whether the order has been placed by quantity (kg CO2) or value (monetary amount)

quantity

value

statusstringrequired

Order status

received

placed

paid

retiring

cancelled

currencystringrequired

Order currency code

offset_coststringrequirednullable

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

The net offset cost being purchased. May be lower than requested_value.

This property is set when bundles are assigned to the order. Unit: order currency

total_coststringrequirednullable

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

The total cost for the order inclusive of fees.

Unit: order currency

commissionstringrequirednullable

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

Lune's fee.

This property is set when bundles are assigned to the order. Unit: order currency

quantitystringrequirednullable

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

Quantity of CO2 offsets purchased in tonnes.

payment_methodstringrequirednullable

How the order will be paid. When card, Lune will attempt to charge the card and pay this order. When invoice, Lune will email an invoice with payment instructions.

invoice

card

created_atstring (date-time)required

Order creation timestamp

bundlesarrayrequirednullable

bundles are set when the order's status is placed, paid, retiring or complete.

The bundles associated with the order including their relative quantity and cost breakdown.

object

bundle_idstringrequired

The bundle's unique identifier

bundle_namestringrequired

The bundle's name

primary_imagestring

A bundle's image URL

quantitystringrequired

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

Quantity for the specific bundle (tonnes CO2)

unit_pricestringrequired

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

Bundle unit price per tonne CO2

Unit: order currency

gross_unit_pricestringrequired

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

Bundle unit price per tonne CO2 inclusive of fees.

Unit: order currency

offset_coststringrequired

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

The bundle's net offset cost being purchased.

Unit: order currency

insufficient_available_quantitybooleanrequirednullable

If true, there is no inventory necessary to fully satisfy the order for this bundle.

projectsarrayrequirednullable

Projects are set when the order's status is retiring or complete.

The projects associated with the order including their relative quantity and cost breakdown.

Orders are placed against bundles, not projects. Projects in a bundle may change based on supply.

This property is set as soon as we can guarantee project supply.

object

project_idstringrequired

The project's unique identifier

project_namestringrequired

The project's name

project_typestringrequired

The project's offset type, eg Forest conservation, Afforestation, Direct Air Capture

project_slugstringrequired

The project's unique slug

project_logostring

URL to the project's logo

quantitystringrequired

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

Carbon offset purchased (tonnes CO2)

unit_pricestringrequired

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

Project unit price per tonne CO2

Unit: order currency

offset_coststringrequired

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

The net offset cost being purchased.

Unit: order currency

statusstringrequired

Describes whether credits for a project have been allocated to an order or retired

allocated

retired

certificatestringrequirednullable

Carbon credits PDF certificate URL.

This property is set when an order has state 'complete'

The property is set (and the certificate is available) regardless of the Sustainability page configuration.

The URL requires API authentication and cannot be accessed anonymously.

public_certificate_urlstringrequirednullable

The Carbon credits certificate public URL.

metadataobjectrequired

An arbitrary dictionary (key-value pairs) to store application-specific information.

Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.

offset_link_idstringrequirednullable

The offset link identifier, if the order was placed through an offset link

emailstringrequirednullable

End-user email.

This property is currently populated on orders placed through offset links.

estimate_idstringrequired

The emission calculation unique identifier

requested_valueoneOfrequired
Null

Requested value of CO2 offsets to purchase in the account's currency.

requested_quantitystringrequired

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

Requested quantity of CO2 offsets to purchase in tonnes.

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

List orders

HTTP GET to /v1/orders

Sample request

Returns the account's paginated orders in reverse order (most recent first).

Query parameters

limitstring

Pattern: ^\d+$

Maximum number of resources to return, between 1 and 100.

afterstring

A cursor for use in pagination.

The cursor that points to the starting item of the next page of results. If not provided, the first page of results is returned.

offset_link_idstring

Filter orders by offset_link_id.

If offset_link_id is set, the response will only include orders belonging to the particular offset link.

Response

has_morebooleanrequired

Whether or not there are more elements available after this set.

If false, this set comprises the end of the array.

Part of a paginated response.

next_cursorstringrequirednullable

The cursor value to be used as the after parameter for fetching the next page of results.

null if has_more is false.

dataarrayrequired

An array of Order objects ordered by creation date descending.

Part of a paginated response.

object

An Order represents a carbon credit purchase.

Orders are placed against one or multiple project bundles. Credits are allocated to the Order from any of the projects that belong to the bundles. These are then retired.

An Order transitions through multiple statuses throughout its lifetime as Lune fulfills the Order.

As soon as an Order has a credit retired, the Order's certificate can be downloaded.

idstringrequired

The order's unique identifier

idempotency_keystringrequirednullable

Account-unique identifier provided by the client.

idempotency_key has two purposes:

Clients can safely retry order requests without accidentally performing the same operation twice. The current state of the original order is returned.
Clients can use idempotency_key to reconcile orders with other entities on their system.

typestringrequired

Identifies whether the order has been placed by quantity (kg CO2) or value (monetary amount)

quantity

value

statusstringrequired

Order status

received

placed

paid

retiring

cancelled

currencystringrequired

Order currency code

offset_coststringrequirednullable

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

The net offset cost being purchased. May be lower than requested_value.

This property is set when bundles are assigned to the order. Unit: order currency

total_coststringrequirednullable

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

The total cost for the order inclusive of fees.

Unit: order currency

commissionstringrequirednullable

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

Lune's fee.

This property is set when bundles are assigned to the order. Unit: order currency

quantitystringrequirednullable

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

Quantity of CO2 offsets purchased in tonnes.

payment_methodstringrequirednullable

How the order will be paid. When card, Lune will attempt to charge the card and pay this order. When invoice, Lune will email an invoice with payment instructions.

invoice

card

created_atstring (date-time)required

Order creation timestamp

bundlesarrayrequirednullable

bundles are set when the order's status is placed, paid, retiring or complete.

The bundles associated with the order including their relative quantity and cost breakdown.

object

bundle_idstringrequired

The bundle's unique identifier

bundle_namestringrequired

The bundle's name

primary_imagestring

A bundle's image URL

quantitystringrequired

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

Quantity for the specific bundle (tonnes CO2)

unit_pricestringrequired

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

Bundle unit price per tonne CO2

Unit: order currency

gross_unit_pricestringrequired

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

Bundle unit price per tonne CO2 inclusive of fees.

Unit: order currency

offset_coststringrequired

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

The bundle's net offset cost being purchased.

Unit: order currency

insufficient_available_quantitybooleanrequirednullable

If true, there is no inventory necessary to fully satisfy the order for this bundle.

projectsarrayrequirednullable

Projects are set when the order's status is retiring or complete.

The projects associated with the order including their relative quantity and cost breakdown.

Orders are placed against bundles, not projects. Projects in a bundle may change based on supply.

This property is set as soon as we can guarantee project supply.

object

project_idstringrequired

The project's unique identifier

project_namestringrequired

The project's name

project_typestringrequired

The project's offset type, eg Forest conservation, Afforestation, Direct Air Capture

project_slugstringrequired

The project's unique slug

project_logostring

URL to the project's logo

quantitystringrequired

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

Carbon offset purchased (tonnes CO2)

unit_pricestringrequired

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

Project unit price per tonne CO2

Unit: order currency

offset_coststringrequired

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

The net offset cost being purchased.

Unit: order currency

statusstringrequired

Describes whether credits for a project have been allocated to an order or retired

allocated

retired

certificatestringrequirednullable

Carbon credits PDF certificate URL.

This property is set when an order has state 'complete'

The property is set (and the certificate is available) regardless of the Sustainability page configuration.

The URL requires API authentication and cannot be accessed anonymously.

public_certificate_urlstringrequirednullable

The Carbon credits certificate public URL.

metadataobjectrequired

An arbitrary dictionary (key-value pairs) to store application-specific information.

Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.

offset_link_idstringrequirednullable

The offset link identifier, if the order was placed through an offset link

emailstringrequirednullable

End-user email.

This property is currently populated on orders placed through offset links.

oneOf
By quantity

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 an order by idempotency key

HTTP GET to /v1/orders/by-idempotency-key/{idempotency_key}

Sample request

Query parameters

idempotency_keystringrequired

The order's idempotency key.

Order idempotency keys must be unique per account.

Response

An Order represents a carbon credit purchase.

Orders are placed against one or multiple project bundles. Credits are allocated to the Order from any of the projects that belong to the bundles. These are then retired.

An Order transitions through multiple statuses throughout its lifetime as Lune fulfills the Order.

As soon as an Order has a credit retired, the Order's certificate can be downloaded.

idstringrequired

The order's unique identifier

idempotency_keystringrequirednullable

Account-unique identifier provided by the client.

idempotency_key has two purposes:

Clients can safely retry order requests without accidentally performing the same operation twice. The current state of the original order is returned.
Clients can use idempotency_key to reconcile orders with other entities on their system.

typestringrequired

Identifies whether the order has been placed by quantity (kg CO2) or value (monetary amount)

quantity

value

statusstringrequired

Order status

received

placed

paid

retiring

cancelled

currencystringrequired

Order currency code

offset_coststringrequirednullable

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

The net offset cost being purchased. May be lower than requested_value.

This property is set when bundles are assigned to the order. Unit: order currency

total_coststringrequirednullable

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

The total cost for the order inclusive of fees.

Unit: order currency

commissionstringrequirednullable

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

Lune's fee.

This property is set when bundles are assigned to the order. Unit: order currency

quantitystringrequirednullable

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

Quantity of CO2 offsets purchased in tonnes.

payment_methodstringrequirednullable

How the order will be paid. When card, Lune will attempt to charge the card and pay this order. When invoice, Lune will email an invoice with payment instructions.

invoice

card

created_atstring (date-time)required

Order creation timestamp

bundlesarrayrequirednullable

bundles are set when the order's status is placed, paid, retiring or complete.

The bundles associated with the order including their relative quantity and cost breakdown.

object

bundle_idstringrequired

The bundle's unique identifier

bundle_namestringrequired

The bundle's name

primary_imagestring

A bundle's image URL

quantitystringrequired

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

Quantity for the specific bundle (tonnes CO2)

unit_pricestringrequired

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

Bundle unit price per tonne CO2

Unit: order currency

gross_unit_pricestringrequired

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

Bundle unit price per tonne CO2 inclusive of fees.

Unit: order currency

offset_coststringrequired

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

The bundle's net offset cost being purchased.

Unit: order currency

insufficient_available_quantitybooleanrequirednullable

If true, there is no inventory necessary to fully satisfy the order for this bundle.

projectsarrayrequirednullable

Projects are set when the order's status is retiring or complete.

The projects associated with the order including their relative quantity and cost breakdown.

Orders are placed against bundles, not projects. Projects in a bundle may change based on supply.

This property is set as soon as we can guarantee project supply.

object

project_idstringrequired

The project's unique identifier

project_namestringrequired

The project's name

project_typestringrequired

The project's offset type, eg Forest conservation, Afforestation, Direct Air Capture

project_slugstringrequired

The project's unique slug

project_logostring

URL to the project's logo

quantitystringrequired

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

Carbon offset purchased (tonnes CO2)

unit_pricestringrequired

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

Project unit price per tonne CO2

Unit: order currency

offset_coststringrequired

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

The net offset cost being purchased.

Unit: order currency

statusstringrequired

Describes whether credits for a project have been allocated to an order or retired

allocated

retired

certificatestringrequirednullable

Carbon credits PDF certificate URL.

This property is set when an order has state 'complete'

The property is set (and the certificate is available) regardless of the Sustainability page configuration.

The URL requires API authentication and cannot be accessed anonymously.

public_certificate_urlstringrequirednullable

The Carbon credits certificate public URL.

metadataobjectrequired

An arbitrary dictionary (key-value pairs) to store application-specific information.

Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.

offset_link_idstringrequirednullable

The offset link identifier, if the order was placed through an offset link

emailstringrequirednullable

End-user email.

This property is currently populated on orders placed through offset links.

oneOf
By quantity

Errors

This API operation can return the following errors:

HTTP status codeError code

404

429

Get an order

HTTP GET to /v1/orders/{id}

Sample request

Query parameters

idstringrequired

The order's unique identifier

Response

An Order represents a carbon credit purchase.

Orders are placed against one or multiple project bundles. Credits are allocated to the Order from any of the projects that belong to the bundles. These are then retired.

An Order transitions through multiple statuses throughout its lifetime as Lune fulfills the Order.

As soon as an Order has a credit retired, the Order's certificate can be downloaded.

idstringrequired

The order's unique identifier

idempotency_keystringrequirednullable

Account-unique identifier provided by the client.

idempotency_key has two purposes:

Clients can safely retry order requests without accidentally performing the same operation twice. The current state of the original order is returned.
Clients can use idempotency_key to reconcile orders with other entities on their system.

typestringrequired

Identifies whether the order has been placed by quantity (kg CO2) or value (monetary amount)

quantity

value

statusstringrequired

Order status

received

placed

paid

retiring

cancelled

currencystringrequired

Order currency code

offset_coststringrequirednullable

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

The net offset cost being purchased. May be lower than requested_value.

This property is set when bundles are assigned to the order. Unit: order currency

total_coststringrequirednullable

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

The total cost for the order inclusive of fees.

Unit: order currency

commissionstringrequirednullable

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

Lune's fee.

This property is set when bundles are assigned to the order. Unit: order currency

quantitystringrequirednullable

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

Quantity of CO2 offsets purchased in tonnes.

payment_methodstringrequirednullable

How the order will be paid. When card, Lune will attempt to charge the card and pay this order. When invoice, Lune will email an invoice with payment instructions.

invoice

card

created_atstring (date-time)required

Order creation timestamp

bundlesarrayrequirednullable

bundles are set when the order's status is placed, paid, retiring or complete.

The bundles associated with the order including their relative quantity and cost breakdown.

object

bundle_idstringrequired

The bundle's unique identifier

bundle_namestringrequired

The bundle's name

primary_imagestring

A bundle's image URL

quantitystringrequired

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

Quantity for the specific bundle (tonnes CO2)

unit_pricestringrequired

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

Bundle unit price per tonne CO2

Unit: order currency

gross_unit_pricestringrequired

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

Bundle unit price per tonne CO2 inclusive of fees.

Unit: order currency

offset_coststringrequired

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

The bundle's net offset cost being purchased.

Unit: order currency

insufficient_available_quantitybooleanrequirednullable

If true, there is no inventory necessary to fully satisfy the order for this bundle.

projectsarrayrequirednullable

Projects are set when the order's status is retiring or complete.

The projects associated with the order including their relative quantity and cost breakdown.

Orders are placed against bundles, not projects. Projects in a bundle may change based on supply.

This property is set as soon as we can guarantee project supply.

object

project_idstringrequired

The project's unique identifier

project_namestringrequired

The project's name

project_typestringrequired

The project's offset type, eg Forest conservation, Afforestation, Direct Air Capture

project_slugstringrequired

The project's unique slug

project_logostring

URL to the project's logo

quantitystringrequired

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

Carbon offset purchased (tonnes CO2)

unit_pricestringrequired

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

Project unit price per tonne CO2

Unit: order currency

offset_coststringrequired

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

The net offset cost being purchased.

Unit: order currency

statusstringrequired

Describes whether credits for a project have been allocated to an order or retired

allocated

retired

certificatestringrequirednullable

Carbon credits PDF certificate URL.

This property is set when an order has state 'complete'

The property is set (and the certificate is available) regardless of the Sustainability page configuration.

The URL requires API authentication and cannot be accessed anonymously.

public_certificate_urlstringrequirednullable

The Carbon credits certificate public URL.

metadataobjectrequired

An arbitrary dictionary (key-value pairs) to store application-specific information.

Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.

offset_link_idstringrequirednullable

The offset link identifier, if the order was placed through an offset link

emailstringrequirednullable

End-user email.

This property is currently populated on orders placed through offset links.

oneOf
By quantity

Errors

This API operation can return the following errors:

HTTP status codeError code

404

429

Create an order by mass

Request body

Response

idstring.css-1paqw6e{margin:0;font-family:Helvetica Neue,Arial,sans-serif;font-size:14px;font-style:normal;font-weight:400;line-height:17px;letter-spacing:0em;text-align:left;color:#212121;color:#D32F2F;margin-right:4px;}required

idempotency_keystringrequired.css-1hiz70q{margin:0;font-family:Helvetica Neue,Arial,sans-serif;font-size:14px;font-style:normal;font-weight:400;line-height:17px;letter-spacing:0em;text-align:left;color:#212121;color:#2864D9;}nullable

typestringrequired

statusstringrequired

currencystringrequired

offset_coststringrequirednullable

total_coststringrequirednullable

commissionstringrequirednullable

quantitystringrequirednullable

payment_methodstringrequirednullable

created_atstring (date-time)required

bundlesarrayrequirednullable

object

bundle_idstringrequired

bundle_namestringrequired

primary_imagestring

quantitystringrequired

unit_pricestringrequired

gross_unit_pricestringrequired

offset_coststringrequired

insufficient_available_quantitybooleanrequirednullable

projectsarrayrequirednullable

object

project_idstringrequired

project_namestringrequired

project_typestringrequired

project_slugstringrequired

project_logostring

quantitystringrequired

unit_pricestringrequired

offset_coststringrequired

statusstringrequired

certificatestringrequirednullable

public_certificate_urlstringrequirednullable

metadataobjectrequired

offset_link_idstringrequirednullable

emailstringrequirednullable

requested_quantitystringrequired

requested_valueoneOfrequired@-webkit-keyframes mui-auto-fill{from{display:block;}}@keyframes mui-auto-fill{from{display:block;}}@-webkit-keyframes mui-auto-fill-cancel{from{display:block;}}@keyframes mui-auto-fill-cancel{from{display:block;}}Null

estimate_idoneOfrequired@-webkit-keyframes mui-auto-fill{from{display:block;}}@keyframes mui-auto-fill{from{display:block;}}@-webkit-keyframes mui-auto-fill-cancel{from{display:block;}}@keyframes mui-auto-fill-cancel{from{display:block;}}Null

Errors

Create an order by value

Request body

valuestringrequired

idempotency_keystring

bundle_selectionarray

object

bundle_idstringrequired

percentageoneOf@-webkit-keyframes mui-auto-fill{from{display:block;}}@keyframes mui-auto-fill{from{display:block;}}@-webkit-keyframes mui-auto-fill-cancel{from{display:block;}}@keyframes mui-auto-fill-cancel{from{display:block;}}Selection percentage as integer

metadataobject

quantity_truncstring

Response

idstringrequired

idempotency_keystringrequirednullable

typestringrequired

statusstringrequired

currencystringrequired

offset_coststringrequirednullable

total_coststringrequirednullable

commissionstringrequirednullable

quantitystringrequirednullable

payment_methodstringrequirednullable

created_atstring (date-time)required

bundlesarrayrequirednullable

object

bundle_idstringrequired

bundle_namestringrequired

primary_imagestring

quantitystringrequired

unit_pricestringrequired

gross_unit_pricestringrequired

offset_coststringrequired

insufficient_available_quantitybooleanrequirednullable

projectsarrayrequirednullable

object

project_idstringrequired

idstringrequired

idempotency_keystringrequirednullable

requested_valueoneOfrequired
Null

estimate_idoneOfrequired
Null

percentageoneOf
Selection percentage as integer

requested_quantityoneOfrequired
Null

estimate_idoneOfrequired
Null

percentageoneOf
Selection percentage as integer