Sample - Stripe API
GET/v1/climate/orders/{order}

Get a Climate order

Retrieves the details of a Climate order by its unique identifier. Use expand to request expanded response fields when additional object details are needed.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters
orderstringrequired
The unique identifier of the Climate order, up to 5000 characters.
expandarray<string>optional
Specifies response fields to expand; each value can contain up to 5000 characters.

2 status codes
200Returns the Climate order, including its amounts, currency, delivery details, expected delivery year, status, and unique identifier.
amount_feesintegerrequired
Total amount of [Frontier](https://frontierclimate.com/)'s service fees in the currency's smallest unit.
amount_subtotalintegerrequired
Total amount of the carbon removal in the currency's smallest unit.
amount_totalintegerrequired
Total amount of the order including fees in the currency's smallest unit.
beneficiaryobjectoptional
canceled_atintegeroptional
Time at which the order was canceled. Measured in seconds since the Unix epoch.
cancellation_reasonstringoptional
Reason for the cancellation of this order.
Allowed:expiredproduct_unavailablerequested
certificatestringoptional
For delivered orders, a URL to a delivery certificate for the order.
confirmed_atintegeroptional
Time at which the order was confirmed. Measured in seconds since the Unix epoch.
createdintegerrequired
Time at which the object was created. Measured in seconds since the Unix epoch.
currencystringrequired
Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase, representing the currency for this order.
delayed_atintegeroptional
Time at which the order's expected_delivery_year was delayed. Measured in seconds since the Unix epoch.
delivered_atintegeroptional
Time at which the order was delivered. Measured in seconds since the Unix epoch.
delivery_detailsarray<ClimateRemovalsOrderDeliveries>required
Details about the delivery of carbon removal for this order.
expected_delivery_yearintegerrequired
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.
idstringrequired
Unique identifier for the object.
livemodebooleanrequired
Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
metadataobjectrequired
Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
metric_tonsstringrequired
Quantity of carbon removal that is included in this order.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:climate.order
productstringrequired
Unique ID for the Climate `Product` this order is purchasing.
product_substituted_atintegeroptional
Time at which the order's product was substituted for a different product. Measured in seconds since the Unix epoch.
statusstringrequired
The current status of this order.
Allowed:awaiting_fundscanceledconfirmeddeliveredopen
defaultError response.
errorobjectrequired

Error handling

order must identify the Climate order you want to retrieve and must not exceed 5000 characters. Each expand value must be a string of no more than 5000 characters.