PostClimateOrdersRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/stripe/main/json-schema/stripe-post-climate-orders-request-schema.json",
  "title": "PostClimateOrdersRequest",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/stripe-climate-api-openapi.yml#/components/schemas/PostClimateOrdersRequest",
  "type": "object",
  "required": [
    "product"
  ],
  "properties": {
    "amount": {
      "description": "Requested amount of carbon removal units. Either this or `metric_tons` must be specified.",
      "type": "integer"
    },
    "beneficiary": {
      "description": "Publicly sharable reference for the end beneficiary of carbon removal. Assumed to be the Stripe account if not set.",
      "properties": {
        "public_name": {
          "maxLength": 5000,
          "type": "string"
        }
      },
      "required": [
        "public_name"
      ],
      "title": "beneficiary_params",
      "type": "object"
    },
    "currency": {
      "description": "Request currency for the order as a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a supported [settlement currency for your account](https://stripe.com/docs/currencies). If omitted, the account's default currency will be used.",
      "maxLength": 5000,
      "type": "string"
    },
    "expand": {
      "description": "Specifies which fields in the response should be expanded.",
      "items": {
        "maxLength": 5000,
        "type": "string"
      },
      "type": "array"
    },
    "metadata": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.",
      "type": "object"
    },
    "metric_tons": {
      "description": "Requested number of tons for the order. Either this or `amount` must be specified.",
      "format": "decimal",
      "type": "string"
    },
    "product": {
      "description": "Unique identifier of the Climate product.",
      "maxLength": 5000,
      "type": "string"
    }
  }
}