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_tonsmust 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
amountmust 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"}
Update an order
POST / v1 / climate / orders /:id
Updates the specified order by setting the values of the parameters passed.
Parameters
- order string Required Unique identifier of the order.
- beneficiary object Publicly sharable reference for the end beneficiary of carbon removal. Assumed to be the Stripe account if not set.
- 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.
Returns
The updated 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": { "order_id": "6735" }, "metric_tons": "0.01", "product": "climsku_frontier_offtake_portfolio_2027", "product_substituted_at": null, "status": "confirmed"}
Retrieve an order
GET / v1 / climate / orders /:id
Retrieves the details of a Climate order object with the given ID.
Parameters
- order string Required Unique identifier of the order.
Returns
Returns a Climate order object if a valid identifier was provided. Throws an error otherwise.
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"}