Update an order 

Climate
Climate Order
Update an order

Updates the specified order by setting the values of the parameters passed.

Parameters

  • orderstringRequired

    Unique identifier of the order.

  • 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.

  • 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.

Returns

The updated Climate order object.

POST /v1/climate/orders/:id
curl https://api.stripe.com/v1/climate/orders/climorder_1aTnU0B63jkB3XAQKUbA5yyl \
-u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
-d "metadata[order_id]"=6735
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": {
"order_id": "6735"
},
"metric_tons": "0.01",
"product": "climsku_frontier_offtake_portfolio_2027",
"product_substituted_at": null,
"status": "confirmed"
}