Stripe: Cancel an order
Stripe climate.postClimateOrdersOrderCancel: arguments, response, policy and SDK examples.
← Climate operations · Get started
Operation stripe.postclimateordersordercancel
Provider route: POST /v1/climate/orders/{order}/cancel. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/stripe with npm, or alter-sdk-stripe with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { StripeIntegration } from "@alter-ai/stripe";
async function execute(input: Parameters<StripeIntegration["climate"]["postClimateOrdersOrderCancel"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new StripeIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.climate.postClimateOrdersOrderCancel(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_stripe import StripeIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = StripeIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.climate.post_climate_orders_order_cancel(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.order | string | Required within parent | Maximum length: 5000 |
headers | object | Optional | Additional keys: not allowed |
headers.Idempotency-Key | string | Optional | Minimum length: 1 Maximum length: 255 |
body | object | Optional | Additional keys: not allowed |
body.expand | array | Optional | Specifies which fields in the response should be expanded. |
body.expand[] | string | Each item | Maximum length: 5000 |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Cancel an order — response body |
Referenced models: Cancel an order — response body
Schemas
Section titled “Schemas”4 more schemas are linked from the tables above, on the schema pages.
Cancel an order — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Orders represent your intent to purchase a particular Climate product. When you create an order, the payment is deducted from your merchant balance. |
amount_fees | JSON | Required within parent | |
amount_fees (anyOf 1) | integer | Alternative | Total amount of [Frontier](https://frontierclimate.com/)'s service fees in the currency's smallest unit. |
amount_fees (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
amount_subtotal | JSON | Required within parent | |
amount_subtotal (anyOf 1) | integer | Alternative | Total amount of the carbon removal in the currency's smallest unit. |
amount_subtotal (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
amount_total | JSON | Required within parent | |
amount_total (anyOf 1) | integer | Alternative | Total amount of the order including fees in the currency's smallest unit. |
amount_total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
beneficiary | Model | Optional | Expand Cancel an order — response body — beneficiary |
canceled_at | JSON | Optional | |
canceled_at (anyOf 1) | JSON | Alternative | |
canceled_at (anyOf 1) (anyOf 1) | integer | Alternative | Time at which the order was canceled. Measured in seconds since the Unix epoch. Format: unix-time |
canceled_at (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
canceled_at (anyOf 2) | null | Alternative | |
cancellation_reason | JSON | Optional | |
cancellation_reason (anyOf 1) | string | Alternative | Reason for the cancellation of this order. Known values: expired, product_unavailable, requested |
cancellation_reason (anyOf 2) | null | Alternative | |
certificate | JSON | Optional | |
certificate (anyOf 1) | string | Alternative | For delivered orders, a URL to a delivery certificate for the order. Maximum length: 5000 |
certificate (anyOf 2) | null | Alternative | |
confirmed_at | JSON | Optional | |
confirmed_at (anyOf 1) | JSON | Alternative | |
confirmed_at (anyOf 1) (anyOf 1) | integer | Alternative | Time at which the order was confirmed. Measured in seconds since the Unix epoch. Format: unix-time |
confirmed_at (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
confirmed_at (anyOf 2) | null | Alternative | |
created | JSON | Required within parent | |
created (anyOf 1) | integer | Alternative | Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time |
created (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency | string | Required within parent | Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase, representing the currency for this order. Maximum length: 5000 |
delayed_at | JSON | Optional | |
delayed_at (anyOf 1) | JSON | Alternative | |
delayed_at (anyOf 1) (anyOf 1) | integer | Alternative | Time at which the order's expected_delivery_year was delayed. Measured in seconds since the Unix epoch. Format: unix-time |
delayed_at (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
delayed_at (anyOf 2) | null | Alternative | |
delivered_at | JSON | Optional | |
delivered_at (anyOf 1) | JSON | Alternative | |
delivered_at (anyOf 1) (anyOf 1) | integer | Alternative | Time at which the order was delivered. Measured in seconds since the Unix epoch. Format: unix-time |
delivered_at (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
delivered_at (anyOf 2) | null | Alternative | |
delivery_details | array | Required within parent | Details about the delivery of carbon removal for this order. |
delivery_details[] | Model | Each item | Expand Cancel an order — response body — delivery details item |
expected_delivery_year | JSON | Required within parent | |
expected_delivery_year (anyOf 1) | integer | Alternative | 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. |
expected_delivery_year (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
livemode | boolean | Required within parent | Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. |
metadata | object | Required within parent | 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. Additional keys: see wildcard field |
metadata.* | string | Additional keys | Maximum length: 500 |
metric_tons | string | Required within parent | Quantity of carbon removal that is included in this order. Format: decimal |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: climate.order |
product | JSON | Required within parent | Unique ID for the Climate `Product` this order is purchasing. |
product (anyOf 1) | string | Alternative | Maximum length: 5000 |
product (anyOf 2) | Model | Alternative | Expand Retrieve a product — climate get Climate Products Product — response body |
product_substituted_at | JSON | Optional | |
product_substituted_at (anyOf 1) | JSON | Alternative | |
product_substituted_at (anyOf 1) (anyOf 1) | integer | Alternative | Time at which the order's product was substituted for a different product. Measured in seconds since the Unix epoch. Format: unix-time |
product_substituted_at (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
product_substituted_at (anyOf 2) | null | Alternative | |
status | string | Required within parent | The current status of this order. Known values: awaiting_funds, canceled, confirmed, delivered, open |
Referenced models: Retrieve a product — climate get Climate Products Product — response body, Cancel an order — response body — beneficiary, Cancel an order — response body — delivery details item
Retrieve a product — climate get Climate Products Product — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A Climate product represents a type of carbon removal unit available for reservation. You can retrieve it to see the current price and availability. |
created | JSON | Required within parent | |
created (anyOf 1) | integer | Alternative | Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time |
created (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
current_prices_per_metric_ton | object | Required within parent | Current prices for a metric ton of carbon removal in a currency's smallest unit. Additional keys: see wildcard field |
current_prices_per_metric_ton.* | Model | Additional keys | Expand Retrieve a product — climate get Climate Products Product — response body — current prices per metric ton value |
delivery_year | JSON | Optional | |
delivery_year (anyOf 1) | JSON | Alternative | |
delivery_year (anyOf 1) (anyOf 1) | integer | Alternative | The year in which the carbon removal is expected to be delivered. If the year is in the past, this represents spot inventory with guaranteed delivery. |
delivery_year (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
delivery_year (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique identifier for the object. For convenience, Climate product IDs are human-readable strings that start with `climsku_`. See [carbon removal inventory](https://stripe.com/docs/climate/orders/carbon-removal-inventory) for a list of available carbon removal products. Maximum length: 5000 |
livemode | boolean | Required within parent | Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. |
metric_tons_available | string | Required within parent | The quantity of metric tons available for reservation. Format: decimal |
name | string | Required within parent | The Climate product's name. Maximum length: 5000 |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: climate.product |
suppliers | array | Required within parent | The carbon removal suppliers that fulfill orders for this Climate product. |
suppliers[] | Model | Each item | Expand Retrieve a supplier — response body |
Referenced models: Retrieve a supplier — response body, Retrieve a product — climate get Climate Products Product — response body — current prices per metric ton value
Cancel an order — response body — beneficiary
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
public_name | string | Required within parent | Publicly displayable name for the end beneficiary of carbon removal. Maximum length: 5000 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: stripe.postclimateordersordercancel. Catalog operation: PostClimateOrdersOrderCancel. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Pinned headers: {"Stripe-Version": "2026-09-30.endive"}