POST /v1/prices/{price}

Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.

Servers

Path parameters

Name Type Required Description
price String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"

Request body fields

Name Type Required Description
transfer_lookup_key Boolean No

If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.

active Boolean No

Whether the price can be used for new purchases. Defaults to true.

nickname String No

A brief description of the price, hidden from customers.

expand[] Array No

Specifies which fields in the response should be expanded.

currency_options No

Prices defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.

metadata No

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.

lookup_key String No

A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.

tax_behavior String No

Only required if a default tax behavior 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.

Possible values:

  • "inclusive"
  • "unspecified"
  • "exclusive"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.