Create an order 

Climate
Climate Order
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.

    • beneficiary.public_namestringRequired

      Publicly displayable name for the end beneficiary of carbon removal.

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