Class OrderCreateParams


public class OrderCreateParams extends ApiRequestParams
  • Method Details

    • builder

      public static OrderCreateParams.Builder builder()
    • getAmount

      public Long getAmount()
      Requested amount of carbon removal units. Either this or metric_tons must be specified.
    • getBeneficiary

      public OrderCreateParams.Beneficiary getBeneficiary()
      Publicly sharable reference for the end beneficiary of carbon removal. Assumed to be the Stripe account if not set.
    • getCurrency

      public String getCurrency()
      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.
    • getExpand

      public List<String> getExpand()
      Specifies which fields in the response should be expanded.
    • getExtraParams

      public Map<String,Object> getExtraParams()
      Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's @SerializedName value. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance.
    • getMetadata

      public Map<String,String> getMetadata()
      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.
    • getMetricTons

      public BigDecimal getMetricTons()
      Requested number of tons for the order. Either this or amount must be specified.
    • getProduct

      public String getProduct()
      Required. Unique identifier of the Climate product.