Climate Order

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

Endpoints

POST/v1/climate/orders

POST/v1/climate/orders/:id

GET/v1/climate/orders/:id

GET/v1/climate/orders

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

The Climate order object

Attributes

idstring
Unique identifier for the object.

objectstring
String representing the object’s type. Objects of the same type share the same value.

amount_feesinteger
Total amount of Frontier’s service fees in the currency’s smallest unit.

amount_subtotalinteger
Total amount of the carbon removal in the currency’s smallest unit.

amount_totalinteger
Total amount of the order including fees in the currency’s smallest unit.

beneficiarynullable object
Publicly sharable reference for the end beneficiary of carbon removal. Assumed to be the Stripe account if not set.

canceled_atnullable timestamp
Time at which the order was canceled. Measured in seconds since the Unix epoch.

cancellation_reasonnullable 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

certificatenullable string
For delivered orders, a URL to a delivery certificate for the order.

confirmed_atnullable timestamp
Time at which the order was confirmed. Measured in seconds since the Unix epoch.

createdtimestamp
Time at which the object was created. Measured in seconds since the Unix epoch.

currencystring
Three-letter ISO currency code, in lowercase, representing the currency for this order.

delayed_atnullable timestamp
Time at which the order’s expected_delivery_year was delayed. Measured in seconds since the Unix epoch.

delivered_atnullable timestamp
Time at which the order was delivered. Measured in seconds since the Unix epoch.

delivery_detailsarray of objects
Details about the delivery of carbon removal for this order.

expected_delivery_yearinteger
The year this order is expected to be delivered.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

metadataobject
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_tonsdecimal string
Quantity of carbon removal that is included in this order.

productstringExpandable
Unique ID for the Climate Product this order is purchasing.

product_substituted_atnullable timestamp
Time at which the order’s product was substituted for a different product. Measured in seconds since the Unix epoch.

statusenum

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

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

productstringRequired
Unique identifier of the Climate product.

amountinteger
Requested amount of carbon removal units. Either this or metric_tons must be specified.

beneficiaryobject
Publicly sharable reference for the end beneficiary of carbon removal. Assumed to be the Stripe account if not set.

currencystring
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.

metadataobject
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_tonsstring
Requested number of tons for the order. Either this or amount must be specified.

Returns

The new Climate order object.

POST /v1/climate/orders

Server-side language

curl https://api.stripe.com/v1/climate/orders \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d metric_tons="0.01" \
  -d product=climsku_frontier_offtake_portfolio_2027

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

Updates the specified order by setting the values of the parameters passed.

Parameters

orderstringRequired
Unique identifier of the order.

beneficiaryobject
Publicly sharable reference for the end beneficiary of carbon removal. Assumed to be the Stripe account if not set.

metadataobject
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.

POST /v1/climate/orders/:id

Server-side language

curl https://api.stripe.com/v1/climate/orders/climorder_1aTnU0B63jkB3XAQKUbA5yyl \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d "metadata[order_id]"=6735

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

Retrieves the details of a Climate order object with the given ID.

Parameters

orderstringRequired
Unique identifier of the order.

Returns

Returns a Climate order object if a valid identifier was provided. Throws an error otherwise.

GET /v1/climate/orders/:id

Server-side language

curl https://api.stripe.com/v1/climate/orders/climorder_1aTnU0B63jkB3XAQKUbA5yyl \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"

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"
}

Climate Order

The Climate order object

Attributes

idstring

objectstring

amount_feesinteger

amount_subtotalinteger

amount_totalinteger

beneficiarynullable object

canceled_atnullable timestamp

cancellation_reasonnullable enum

certificatenullable string

confirmed_atnullable timestamp

createdtimestamp

currencystring

delayed_atnullable timestamp

delivered_atnullable timestamp

delivery_detailsarray of objects

expected_delivery_yearinteger

livemodeboolean

metadataobject

metric_tonsdecimal string

productstringExpandable

product_substituted_atnullable timestamp

statusenum

Create an order

Parameters

productstringRequired

amountinteger

beneficiaryobject

currencystring

metadataobject

metric_tonsstring

Returns

Update an order

Parameters

orderstringRequired

beneficiaryobject

metadataobject

Returns

Retrieve an order

Parameters

orderstringRequired

Returns