Mayson Monorepo Documentation
    Preparing search index...

    Orders represent your intent to purchase a particular Climate product. When you create an order, the payment is deducted from your merchant balance.

    interface Order {
        id: string;
        object: "climate.order";
        amount_fees: number;
        amount_subtotal: number;
        amount_total: number;
        beneficiary?: Stripe.Climate.Order.Beneficiary;
        canceled_at: number;
        cancellation_reason: Stripe.Climate.Order.CancellationReason;
        certificate: string;
        confirmed_at: number;
        created: number;
        currency: string;
        delayed_at: number;
        delivered_at: number;
        delivery_details: Stripe.Climate.Order.DeliveryDetail[];
        expected_delivery_year: number;
        livemode: boolean;
        metadata: Metadata;
        metric_tons: string;
        product: string | Stripe.Climate.Product;
        product_substituted_at: number;
        status: Stripe.Climate.Order.Status;
    }
    Index

    Properties

    id: string

    Unique identifier for the object.

    object: "climate.order"

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

    amount_fees: number

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

    amount_subtotal: number

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

    amount_total: number

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

    canceled_at: number

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

    cancellation_reason: Stripe.Climate.Order.CancellationReason

    Reason for the cancellation of this order.

    certificate: string

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

    confirmed_at: number

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

    created: number

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

    currency: string

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

    delayed_at: number

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

    delivered_at: number

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

    delivery_details: Stripe.Climate.Order.DeliveryDetail[]

    Details about the delivery of carbon removal for this order.

    expected_delivery_year: number

    The year this order is expected to be delivered.

    livemode: boolean

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

    metadata: Metadata

    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_tons: string

    Quantity of carbon removal that is included in this order.

    product: string | Stripe.Climate.Product

    Unique ID for the Climate Product this order is purchasing.

    product_substituted_at: number

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

    The current status of this order.