Cancel an order

Changed on

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.

post/v1/climate/orders/{order}/cancel

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/climate/orders/{order}/cancel
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Path parameters

orderstring required

Unique identifier of the order.

Response

Successful response.

amount_feesinteger required

Total amount of Frontier's service fees in the currency's smallest unit.

amount_subtotalinteger required

Total amount of the carbon removal in the currency's smallest unit.

amount_totalinteger required

Total amount of the order including fees in the currency's smallest unit.

canceled_atinteger nullable

Time at which the order was canceled. Measured in seconds since the Unix epoch.

cancellation_reason'expired' | 'product_unavailable' | 'requested' nullable

Reason for the cancellation of this order.

certificatestring nullable

For delivered orders, a URL to a delivery certificate for the order.

confirmed_atinteger nullable

Time at which the order was confirmed. Measured in seconds since the Unix epoch.

createdinteger required

Time at which the object was created. Measured in seconds since the Unix epoch.

currencystring required

Three-letter ISO currency code, in lowercase, representing the currency for this order.

delayed_atinteger nullable

Time at which the order's expected_delivery_year was delayed. Measured in seconds since the Unix epoch.

delivered_atinteger nullable

Time at which the order was delivered. Measured in seconds since the Unix epoch.

expected_delivery_yearinteger required

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.

idstring required

Unique identifier for the object.

livemodeboolean required

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

metadataobject required

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.

metric_tonsstring decimal required

Quantity of carbon removal that is included in this order.

object'climate.order' required

String representing the object's type. Objects of the same type share the same value.

product_substituted_atinteger nullable

Time at which the order's product was substituted for a different product. Measured in seconds since the Unix epoch.

status'awaiting_funds' | 'canceled' | 'confirmed' | 'delivered' | 'open' required

The current status of this order.

Changes

  • 8b5c2f03d4cdRevision changes
    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    This list may be incomplete.

  • e24a26de4188Revision changes
    • breaking

      removed the required property //////////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    This list may be incomplete.

Some revisions have not been checked yet.