List orders
GET / v1 / climate / orders
Lists all Climate order objects. The orders are returned sorted by creation date, with the most recently created orders appearing first.
Parameters
No parameters.
More parameters
- ending _ before string
- limit integer
- starting _ after string
Returns
A dictionary with a data property that contains an array of up to limit orders, starting after order starting_after. Each entry in the array is a separate order object. If no more orders are available, the resulting array is empty.
Response
Cancel an order
POST / v1 / climate / orders /:id / cancel
Cancels a Climate order. You can cancel an order within 24 hours of creation. Stripe refunds the reservation amount_subtotal, but not the amount_fees for user-triggered cancellations. Frontier might cancel reservations if suppliers fail to deliver. If Frontier cancels the reservation, Stripe provides 90 days advance notice and refunds the amount_total.
Parameters
- order string Required Unique identifier of the order.
Returns
The canceled 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": 1881439208, "cancellation_reason": "requested", "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": "canceled"}