PostPricesPriceRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/stripe/main/json-schema/stripe-post-prices-price-request-schema.json",
  "title": "PostPricesPriceRequest",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/stripe-prices-api-openapi.yml#/components/schemas/PostPricesPriceRequest",
  "type": "object",
  "properties": {
    "active": {
      "description": "Whether the price can be used for new purchases. Defaults to `true`.",
      "type": "boolean"
    },
    "currency_options": {
      "anyOf": [
        {
          "additionalProperties": {
            "properties": {
              "custom_unit_amount": {
                "properties": {
                  "enabled": {
                    "type": "boolean"
                  },
                  "maximum": {
                    "type": "integer"
                  },
                  "minimum": {
                    "type": "integer"
                  },
                  "preset": {
                    "type": "integer"
                  }
                },
                "required": [
                  "enabled"
                ],
                "title": "custom_unit_amount",
                "type": "object"
              },
              "tax_behavior": {
                "enum": [
                  "exclusive",
                  "inclusive",
                  "unspecified"
                ],
                "type": "string"
              },
              "tiers": {
                "items": {
                  "properties": {
                    "flat_amount": {
                      "type": "integer"
                    },
                    "flat_amount_decimal": {
                      "format": "decimal",
                      "type": "string"
                    },
                    "unit_amount": {
                      "type": "integer"
                    },
                    "unit_amount_decimal": {
                      "format": "decimal",
                      "type": "string"
                    },
                    "up_to": {
                      "anyOf": [
                        {
                          "enum": [
                            "inf"
                          ],
                          "maxLength": 5000,
                          "type": "string"
                        },
                        {
                          "type": "integer"
                        }
                      ]
                    }
                  },
                  "required": [
                    "up_to"
                  ],
                  "title": "tier",
                  "type": "object"
                },
                "type": "array"
              },
              "unit_amount": {
                "type": "integer"
              },
              "unit_amount_decimal": {
                "format": "decimal",
                "type": "string"
              }
            },
            "title": "currency_option",
            "type": "object"
          },
          "type": "object"
        },
        {
          "enum": [
            ""
          ],
          "type": "string"
        }
      ],
      "description": "Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies)."
    },
    "expand": {
      "description": "Specifies which fields in the response should be expanded.",
      "items": {
        "maxLength": 5000,
        "type": "string"
      },
      "type": "array"
    },
    "lookup_key": {
      "description": "A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.",
      "maxLength": 200,
      "type": "string"
    },
    "metadata": {
      "anyOf": [
        {
          "additionalProperties": {
            "type": "string"
          },
          "type": "object"
        },
        {
          "enum": [
            ""
          ],
          "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`."
    },
    "nickname": {
      "description": "A brief description of the price, hidden from customers.",
      "maxLength": 5000,
      "type": "string"
    },
    "tax_behavior": {
      "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
      "enum": [
        "exclusive",
        "inclusive",
        "unspecified"
      ],
      "type": "string"
    },
    "transfer_lookup_key": {
      "description": "If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.",
      "type": "boolean"
    }
  }
}