# PostPrices

From **Stripe API**.

`POST /v1/prices`

<p>Creates a new price for an existing product. The price can be recurring or one-time.</p>

## Request body

- Required: true
### `application/x-www-form-urlencoded`

- Type: `object`

```json
{"additionalProperties":false,"properties":{"active":{"description":"Whether the price can be used for new purchases. Defaults to `true`.","type":"boolean"},"billing_scheme":{"description":"Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `unit_amount` or `unit_amount_decimal`) will be charged per unit in `quantity` (for prices with `usage_type=licensed`), or per unit of total usage (for prices with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.","enum":["per_unit","tiered"],"type":"string"},"currency":{"description":"Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).","type":"string"},"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":{"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"},"nickname":{"description":"A brief description of the price, hidden from customers.","maxLength":5000,"type":"string"},"product":{"description":"The ID of the product that this price will belong to.","maxLength":5000,"type":"string"},"product_data":{"description":"These fields can be used to create a new product that this price will belong to.","properties":{"active":{"type":"boolean"},"id":{"maxLength":5000,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"name":{"maxLength":5000,"type":"string"},"statement_descriptor":{"maxLength":22,"type":"string"},"tax_code":{"maxLength":5000,"type":"string"},"unit_label":{"maxLength":12,"type":"string"}},"required":["name"],"title":"inline_product_params","type":"object"},"recurring":{"description":"The recurring components of a price such as `interval` and `usage_type`.","properties":{"aggregate_usage":{"enum":["last_during_period","last_ever","max","sum"],"type":"string"},"interval":{"enum":["day","month","week","year"],"type":"string"},"interval_count":{"type":"integer"},"usage_type":{"enum":["licensed","metered"],"type":"string"}},"required":["interval"],"title":"recurring","type":"object"},"tax_behavior":{"description":"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"},"tiers":{"description":"Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.","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"},"tiers_mode":{"description":"Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price, in `graduated` tiering pricing can successively change as the quantity grows.","enum":["graduated","volume"],"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"},"transform_quantity":{"description":"Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`.","properties":{"divide_by":{"type":"integer"},"round":{"enum":["down","up"],"type":"string"}},"required":["divide_by","round"],"title":"transform_usage_param","type":"object"},"unit_amount":{"description":"A positive integer in %s (or 0 for a free price) representing how much to charge.","type":"integer"},"unit_amount_decimal":{"description":"Same as `unit_amount`, but accepts a decimal value in %s with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.","format":"decimal","type":"string"}},"required":["currency"],"type":"object"}
```

## Security

### `basicAuth`

- Type: `http`
- Request header: `Authorization`
- Scheme: `basic`
Send credentials in the `Authorization` request header using the `Basic` scheme.

Basic HTTP authentication. Allowed headers-- Authorization: Basic <api_key> | Authorization: Basic <base64 hash of `api_key:`>

### `bearerAuth`

- Type: `http`
- Request header: `Authorization`
- Scheme: `bearer`
- Bearer format: `auth-scheme`
Send the token in the `Authorization` request header using the `Bearer` scheme.

Bearer HTTP authentication. Allowed headers-- Authorization: Bearer <api_key>

## Responses

### `200`

Successful response.

### `application/json`

- Type: `object`

Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products.
[Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme.

For example, you might have a single "gold" product that has prices for $10/month, $100/year, and €9 once.

Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription), [create an invoice](https://stripe.com/docs/billing/invoices/create), and more about [products and prices](https://stripe.com/docs/billing/prices-guide).

```json
{"description":"Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products.\n[Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme.\n\nFor example, you might have a single \"gold\" product that has prices for $10/month, $100/year, and €9 once.\n\nRelated guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription), [create an invoice](https://stripe.com/docs/billing/invoices/create), and more about [products and prices](https://stripe.com/docs/billing/prices-guide).","properties":{"active":{"description":"Whether the price can be used for new purchases.","type":"boolean"},"billing_scheme":{"description":"Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `unit_amount` or `unit_amount_decimal`) will be charged per unit in `quantity` (for prices with `usage_type=licensed`), or per unit of total usage (for prices with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.","enum":["per_unit","tiered"],"type":"string"},"created":{"description":"Time at which the object was created. Measured in seconds since the Unix epoch.","format":"unix-time","type":"integer"},"currency":{"description":"Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).","type":"string"},"id":{"description":"Unique identifier for the object.","maxLength":5000,"type":"string"},"livemode":{"description":"Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.","type":"boolean"},"lookup_key":{"description":"A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.","maxLength":5000,"nullable":true,"type":"string"},"metadata":{"additionalProperties":{"maxLength":500,"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.","type":"object"},"nickname":{"description":"A brief description of the price, hidden from customers.","maxLength":5000,"nullable":true,"type":"string"},"object":{"description":"String representing the object's type. Objects of the same type share the same value.","enum":["price"],"type":"string"},"product":{"anyOf":[{"maxLength":5000,"type":"string"},{"$ref":"#/components/schemas/product"},{"$ref":"#/components/schemas/deleted_product"}],"description":"The ID of the product this price is associated with.","x-expansionResources":{"oneOf":[{"$ref":"#/components/schemas/product"},{"$ref":"#/components/schemas/deleted_product"}]}},"recurring":{"anyOf":[{"$ref":"#/components/schemas/recurring"}],"description":"The recurring components of a price such as `interval` and `usage_type`.","nullable":true},"tax_behavior":{"description":"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"],"nullable":true,"type":"string"},"tiers":{"description":"Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.","items":{"$ref":"#/components/schemas/price_tier"},"type":"array"},"tiers_mode":{"description":"Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows.","enum":["graduated","volume"],"nullable":true,"type":"string"},"transform_quantity":{"anyOf":[{"$ref":"#/components/schemas/transform_quantity"}],"description":"Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`.","nullable":true},"type":{"description":"One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.","enum":["one_time","recurring"],"type":"string"},"unit_amount":{"description":"The unit amount in %s to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.","nullable":true,"type":"integer"},"unit_amount_decimal":{"description":"The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`.","format":"decimal","nullable":true,"type":"string"}},"required":["active","billing_scheme","created","currency","id","livemode","metadata","object","product","type"],"title":"Price","type":"object","x-expandableFields":["product","recurring","tiers","transform_quantity"],"x-resourceId":"price"}
```

### `default`

Error response.

### `application/json`

- Type: `object`

An error response from the Stripe API

```json
{"description":"An error response from the Stripe API","properties":{"error":{"$ref":"#/components/schemas/api_errors"}},"required":["error"],"type":"object"}
```

## Request examples

### cURL

```shell
curl --request POST \
  --url https://api.stripe.com/v1/prices \
  --header 'content-type: application/x-www-form-urlencoded' \
  --data '{
  "active": true,
  "billing_scheme": "string",
  "currency": "string",
  "expand": [
    "string"
  ],
  "lookup_key": "string",
  "metadata": {},
  "nickname": "string",
  "product": "string",
  "product_data": {
    "active": true,
    "id": "string",
    "metadata": {},
    "name": "string",
    "statement_descriptor": "string",
    "tax_code": "string",
    "unit_label": "string"
  },
  "recurring": {
    "aggregate_usage": "string",
    "interval": "string",
    "interval_count": 1,
    "usage_type": "string"
  },
  "tax_behavior": "string",
  "tiers": [
    {
      "flat_amount": 1,
      "flat_amount_decimal": "string",
      "unit_amount": 1,
      "unit_amount_decimal": "string",
      "up_to": "string"
    }
  ],
  "tiers_mode": "string",
  "transfer_lookup_key": true,
  "transform_quantity": {
    "divide_by": 1,
    "round": "string"
  },
  "unit_amount": 1,
  "unit_amount_decimal": "string"
}'
```
