Create an order by mass
HTTPPOST to /v1/orders/by-massRequest body
oneOfTotal mass and per-bundle percentages
Total mass and per-bundle percentages
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_keyto reconcile orders with other entities on their system.
typestringrequired
Identifies whether the order has been placed by quantity (kg CO2) or value (monetary amount)
quantityvaluestatusstringrequired
Order status
receivedplacedpaidretiringcancelledcurrencystringrequired
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.
invoicecardcreated_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
allocatedretiredcertificatestringrequirednullable
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_valueoneOfrequiredNull
Null
Requested value of CO2 offsets to purchase in the account's currency.
estimate_idoneOfrequiredNull
Null
The emission calculation unique identifier
Errors
This API operation can return the following errors:400api_version_invalid400bundle_selection_ratios_invalid400bundle_selection_bundle_invalid400order_value_invalid400bundle_id_invalid400id_invalid400distance_invalid400test_account_name_update_disallowed400bundle_selection_ratios_invalid_format400address_not_foundCreate an order by value
HTTPPOST to /v1/orders/by-valueRequest 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_keyto 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
percentageoneOfSelection percentage as integer
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.
gkgtResponse
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_keyto reconcile orders with other entities on their system.
typestringrequired
Identifies whether the order has been placed by quantity (kg CO2) or value (monetary amount)
quantityvaluestatusstringrequired
Order status
receivedplacedpaidretiringcancelledcurrencystringrequired
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.
invoicecardcreated_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
allocatedretiredcertificatestringrequirednullable
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_valuestringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
Requested value of CO2 offsets to purchase in the account's currency.
requested_quantityoneOfrequiredNull
Null
Requested quantity of CO2 offsets to purchase in tonnes.
estimate_idoneOfrequiredNull
Null
The emission calculation unique identifier
Errors
This API operation can return the following errors:400api_version_invalid400bundle_selection_ratios_invalid400bundle_selection_bundle_invalid400order_value_invalid400bundle_id_invalid400id_invalid400distance_invalid400test_account_name_update_disallowed400bundle_selection_ratios_invalid_format400address_not_foundCreate an order by estimate id
HTTPPOST to /v1/orders/by-estimateRequest 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_keyto 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
percentageoneOfSelection percentage as integer
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.
gkgtResponse
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_keyto reconcile orders with other entities on their system.
typestringrequired
Identifies whether the order has been placed by quantity (kg CO2) or value (monetary amount)
quantityvaluestatusstringrequired
Order status
receivedplacedpaidretiringcancelledcurrencystringrequired
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.
invoicecardcreated_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
allocatedretiredcertificatestringrequirednullable
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.
estimate_idstringrequired
The emission calculation unique identifier
requested_valueoneOfrequiredNull
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:400api_version_invalid400bundle_selection_ratios_invalid400bundle_selection_bundle_invalid400order_value_invalid400bundle_id_invalid400id_invalid400distance_invalid400test_account_name_update_disallowed400bundle_selection_ratios_invalid_format400address_not_foundList orders
HTTPGET to /v1/ordersReturns 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_keyto reconcile orders with other entities on their system.
typestringrequired
Identifies whether the order has been placed by quantity (kg CO2) or value (monetary amount)
quantityvaluestatusstringrequired
Order status
receivedplacedpaidretiringcancelledcurrencystringrequired
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.
invoicecardcreated_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
allocatedretiredcertificatestringrequirednullable
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.
oneOfBy quantity
By quantity
Errors
This API operation can return the following errors:400api_version_invalid400bundle_selection_ratios_invalid400bundle_selection_bundle_invalid400order_value_invalid400bundle_id_invalid400id_invalid400distance_invalid400test_account_name_update_disallowed400bundle_selection_ratios_invalid_format400address_not_foundGet an order by idempotency key
HTTPGET to /v1/orders/by-idempotency-key/{idempotency_key}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_keyto reconcile orders with other entities on their system.
typestringrequired
Identifies whether the order has been placed by quantity (kg CO2) or value (monetary amount)
quantityvaluestatusstringrequired
Order status
receivedplacedpaidretiringcancelledcurrencystringrequired
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.
invoicecardcreated_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
allocatedretiredcertificatestringrequirednullable
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.
oneOfBy quantity
By quantity
Errors
This API operation can return the following errors:404429Get an order
HTTPGET to /v1/orders/{id}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_keyto reconcile orders with other entities on their system.
typestringrequired
Identifies whether the order has been placed by quantity (kg CO2) or value (monetary amount)
quantityvaluestatusstringrequired
Order status
receivedplacedpaidretiringcancelledcurrencystringrequired
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.
invoicecardcreated_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
allocatedretiredcertificatestringrequirednullable
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.
oneOfBy quantity
By quantity
Errors
This API operation can return the following errors:404429