The Climate order object 

Attributes

• idstring

  Unique identifier for the object.

• objectstring

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

• amount_feesinteger

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

• amount_subtotalinteger

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

• amount_totalinteger

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

• beneficiarynullable object

  Publicly sharable reference for the end beneficiary of carbon removal. Assumed to be the Stripe account if not set.

  Hide child attributes

  • beneficiary.public_namestring

    Publicly displayable name for the end beneficiary of carbon removal.

• canceled_atnullable timestamp

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

• cancellation_reasonnullable enum

  Reason for the cancellation of this order.

  Possible enum values

  expired Order was not confirmed and expired automatically

  product_unavailable Order could not be fulfilled because the product is no longer available

  requested Order was canceled by a cancellation request

• certificatenullable string

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

• confirmed_atnullable timestamp

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

• createdtimestamp

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

• currencystring

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

• delayed_atnullable timestamp

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

• delivered_atnullable timestamp

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

• delivery_detailsarray of objects

  Details about the delivery of carbon removal for this order.

  Hide child attributes

  • delivery_details.delivered_attimestamp

    Time at which the delivery occurred. Measured in seconds since the Unix epoch.

  • delivery_details.locationnullable object

    Specific location of this delivery.

    Hide child attributes

    • delivery_details.location.citynullable string

      The city where the supplier is located.

    • delivery_details.location.countrystring

      Two-letter ISO code representing the country where the supplier is located.

    • delivery_details.location.latitudenullable float

      The geographic latitude where the supplier is located.

    • delivery_details.location.longitudenullable float

      The geographic longitude where the supplier is located.

    • delivery_details.location.regionnullable string

      The state/county/province/region where the supplier is located.

  • delivery_details.metric_tonsstring

    Quantity of carbon removal supplied by this delivery.

  • delivery_details.registry_urlnullable string

    Once retired, a URL to the registry entry for the tons from this delivery.

  • delivery_details.supplierobject

    ID of the Supplier responsible for this delivery.

    Hide child attributes

    • delivery_details.supplier.idstring

      Unique identifier for the object.

    • delivery_details.supplier.objectstring

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

    • delivery_details.supplier.info_urlstring

      Link to a webpage to learn more about the supplier.

    • delivery_details.supplier.livemodeboolean

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

    • delivery_details.supplier.locationsarray of objects

      The locations in which this supplier operates.

      Hide child attributes

      • delivery_details.supplier.locations.citynullable string

        The city where the supplier is located.

      • delivery_details.supplier.locations.countrystring

        Two-letter ISO code representing the country where the supplier is located.

      • delivery_details.supplier.locations.latitudenullable float

        The geographic latitude where the supplier is located.

      • delivery_details.supplier.locations.longitudenullable float

        The geographic longitude where the supplier is located.

      • delivery_details.supplier.locations.regionnullable string

        The state/county/province/region where the supplier is located.

    • delivery_details.supplier.namestring

      Name of this carbon removal supplier.

    • delivery_details.supplier.removal_pathwayenum

      The scientific pathway used for carbon removal.

      Possible enum values

      biomass_carbon_removal_and_storage Biomass carbon removal and storage

      direct_air_capture Direct air capture

      enhanced_weathering Enhanced weathering

• expected_delivery_yearinteger

  The year this order is expected to be delivered.

• livemodeboolean

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

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

• metric_tonsdecimal string

  Quantity of carbon removal that is included in this order.

• productstringExpandable

  Unique ID for the Climate Product this order is purchasing.

• product_substituted_atnullable timestamp

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

• statusenum

  The current status of this order.

  Possible enum values

  awaiting_funds Status when an order has been attached to a funding_source and is awaiting it’s settlement

  canceled Status when an order has been canceled

  confirmed Status when an order has been successfully confirmed and payment has been made

  delivered Status when an order has been delivered