Cancel an order

Cancels a Climate order. You can cancel an order within 30 days 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

  • orderstringRequired

    Unique identifier of the order.

Returns

The canceled Climate order object.

POST /v1/climate/orders/:id/cancel
curl -X POST https://api.stripe.com/v1/climate/orders/climorder_1aTnU0B63jkB3XAQKUbA5yyl/cancel \
-u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:"
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"
}

Climate Product

A Climate product represents a type of carbon removal unit available for reservation. You can retrieve it to see the current price and availability.

Forwarding RequestPreview feature

Instructs Stripe to make a request on your behalf using the destination URL. The destination URL is activated by Stripe at the time of onboarding. Stripe verifies requests with your credentials provided during onboarding, and injects card details from the payment_method into the request.

Stripe redacts all sensitive fields and headers, including authentication credentials and card numbers, before storing the request and response data in the forwarding Request object, which are subject to a 30-day retention period.

You can provide a Stripe idempotency key to make sure that requests with the same key result in only one outbound request. The Stripe idempotency key provided should be unique and different from any idempotency keys provided on the underlying third-party request.

Forwarding Requests are synchronous requests that return a response or time out according to Stripe’s limits.

Related guide: Forward card details to third-party API endpoints.

Webhook Endpoints

You can configure webhook endpoints via the API to be notified about events that happen in your Stripe account or connected accounts.

Most users configure webhooks from the dashboard, which provides a user interface for registering and testing your webhook endpoints.

Related guide: Setting up webhooks

Stripe Shell
Test mode
Welcome to the Stripe Shell! Stripe Shell is a browser-based shell with the Stripe CLI pre-installed. Log in to your Stripe account and press Control + Backtick (`) on your keyboard to start managing your Stripe resources in test mode. - View supported Stripe commands: - Find webhook events: - Listen for webhook events: - Call Stripe APIs: stripe [api resource] [operation] (e.g., )
The Stripe Shell is best experienced on desktop.
$