Climate Orders

Orders represent your intent to purchase a particular Climate product. When you create an order, the payment is deducted from your merchant balance.

Was this section helpful? Yes No

Create an order

POST / v1 / climate / orders

Update an order

POST / v1 / climate / orders /:id

Retrieve an order

GET / v1 / climate / orders /:id

List orders

GET / v1 / climate / orders

Cancel an order

POST / v1 / climate / orders /:id / cancel

The Climate order object

Attributes

id string Unique identifier for the object.
object string, value is "climate.order" String representing the object’s type. Objects of the same type share the same value.
amount _ fees integer Total amount of Frontier ’s service fees in the currency’s smallest unit.
amount _ subtotal integer Total amount of the carbon removal in the currency’s smallest unit.
amount _ total integer Total amount of the order including fees in the currency’s smallest unit.
beneficiary nullable object Publicly sharable reference for the end beneficiary of carbon removal. Assumed to be the Stripe account if not set.
canceled _ at nullable timestamp Time at which the order was canceled. Measured in seconds since the Unix epoch.
cancellation _ reason nullable enum Reason for the cancellation of this order. Possible enum values expired Order was not confirmed and expired automatically product_unavailable Order could not be fulfilled because the product is no longer available requested Order was canceled by a cancellation request
certificate nullable string For delivered orders, a URL to a delivery certificate for the order.
confirmed _ at nullable timestamp Time at which the order was confirmed. Measured in seconds since the Unix epoch.
created timestamp Time at which the object was created. Measured in seconds since the Unix epoch.
currency string Three-letter ISO currency code, in lowercase, representing the currency for this order.
delayed _ at nullable timestamp Time at which the order’s expected_delivery_year was delayed. Measured in seconds since the Unix epoch.
delivered _ at nullable timestamp Time at which the order was delivered. Measured in seconds since the Unix epoch.
delivery _ details array of objects Details about the delivery of carbon removal for this order.
expected _ delivery _ year integer The year this order is expected to be delivered. If the year is in the past, the order is a spot purchase and will be delivered within 30 days of purchase.
livemode boolean Has the value true if the object exists in live mode or the value false if the object exists in test mode.
metadata map Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
metric _ tons decimal string Quantity of carbon removal that is included in this order.
product string Expandable Unique ID for the Climate Product this order is purchasing.
product _ substituted _ at nullable timestamp Time at which the order’s product was substituted for a different product. Measured in seconds since the Unix epoch.
status enum The current status of this order. Possible enum values awaiting_funds Status when an order has been attached to a funding_source and is awaiting it’s settlement canceled Status when an order has been canceled confirmed Status when an order has been successfully confirmed and payment has been made delivered Status when an order has been delivered

The Climate order object

{ "id": "climorder_1aTnU0B63jkB3XAQKUbA5yyl", "object": "climate.order", "amount_fees": 17, "amount_subtotal": 550, "amount_total": 567, "beneficiary": { "public_name": "{{YOUR_BUSINESS_NAME}}" }, "canceled_at": null, "cancellation_reason": null, "certificate": null, "confirmed_at": 1881439205, "created": 1881439205, "currency": "usd", "delayed_at": null, "delivered_at": null, "delivery_details": [], "expected_delivery_year": 2027, "livemode": false, "metadata": {}, "metric_tons": "0.01", "product": "climsku_frontier_offtake_portfolio_2027", "product_substituted_at": null, "status": "confirmed"}

Create an order

POST / v1 / climate / orders

Creates a Climate order object for a given Climate product. The order will be processed immediately after creation and payment will be deducted your Stripe balance.

Parameters

product string Required Unique identifier of the Climate product.
amount integer Requested amount of carbon removal units. Either this or metric_tons must be specified.
beneficiary object Publicly sharable reference for the end beneficiary of carbon removal. Assumed to be the Stripe account if not set.
currency string Request currency for the order as a three-letter ISO currency code, in lowercase. Must be a supported settlement currency for your account. If omitted, the account’s default currency will be used.
metadata map Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
metric _ tons string Requested number of tons for the order. Either this or amount must be specified.

Returns

The new Climate order object.

Response

{ "id": "climorder_1aTnU0B63jkB3XAQKUbA5yyl", "object": "climate.order", "amount_fees": 17, "amount_subtotal": 550, "amount_total": 567, "beneficiary": { "public_name": "{{YOUR_BUSINESS_NAME}}" }, "canceled_at": null, "cancellation_reason": null, "certificate": null, "confirmed_at": 1881439205, "created": 1881439205, "currency": "usd", "delayed_at": null, "delivered_at": null, "delivery_details": [], "expected_delivery_year": 2027, "livemode": false, "metadata": {}, "metric_tons": "0.01", "product": "climsku_frontier_offtake_portfolio_2027", "product_substituted_at": null, "status": "confirmed"}