Update a price

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

SecuritybearerAuth
Request
path Parameters
price_id
required
string

Price Id

query Parameters
fields[]
Array of strings

Allows you to specify which fields are returned in the response.

Accepted values custom_fields, created_by_id, updated_by_id, created_time, id, updated_time, tiers, charge_model, charge_type, name, description, revenue_recognition_rule, stacked_discount, recognized_revenue_accounting_code, deferred_revenue_accounting_code, accounting_code, recurring, start_event, tax_code, tax_inclusive, taxable, unit_of_measure, quantity, min_quantity, max_quantity, price_base_interval, discount_level, overage, plan_id, tiers_mode, apply_discount_to, prepayment, drawdown, discount_amounts, unit_amounts, discount_percent, amounts

Example: fields[]=id,created_time
expand[]
Array of strings

Allows you to expand responses by including related object information in a single call. See the Expand responses section of the Quickstart API Tutorials for detailed instructions.

filter[]
Array of strings

A case-sensitive filter on the list. See the Filter lists section of the Quickstart API Tutorial for detailed instructions.
Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the "Retrieve a billing document" operation, you can use the filter[] parameter on the related objects such as filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63

page_size
integer [ 1 .. 99 ]

The maximum number of results to return in a single page. If the specified page_size is less than 1 or greater than 99, Zuora will return a 400 error.

header Parameters
zuora-track-id
string

A custom identifier for tracking API requests. If you set a value for this header, Zuora returns the same value in the response header. This header enables you to track your API calls to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), or quote (').

async
boolean
Default: false

Making asynchronous requests allows you to scale your applications more efficiently by leveraging Zuora's infrastructure to enqueue and execute requests for you without blocking. These requests also use built-in retry semantics, which makes them much less likely to fail for non-deterministic reasons, even in extreme high-throughput scenarios. Meanwhile, when you send a request to one of these endpoints, you can expect to receive a response in less than 150 milliseconds and these calls are unlikely to trigger rate limit errors. If set to true, Zuora returns a 202 Accepted response, and the response body contains only a request ID.

zuora-entity-ids
string

An entity ID. If you have Multi-entity enabled and the authorization token is valid for more than one entity, you must use this header to specify which entity to perform the operation on. If the authorization token is only valid for a single entity or you do not have Multi-entity enabled, you do not need to set this header.

idempotency-key
string

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. This idempotency key should be a unique value, and the Zuora server identifies subsequent retries of the same request using this value. For more information, see Idempotent Requests.

accept-encoding
string

Include a accept-encoding: gzip header to compress responses, which can reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes. For more information about this header, see Request and Response Compression.

content-encoding
string

Include a content-encoding: gzip header to compress a request. Upload a gzipped file for the payload if you specify this header. For more information, see Request and Response Compression.

Request Body schema: application/json
required
object (CustomFields)

Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format.

name
string

The name of the price.

description
string

An arbitrary string attached to the object. Often useful for displaying to users.

recognized_revenue_accounting_code
string <= 100 characters

An active accounting code in your Zuora chart of accounts.

deferred_revenue_accounting_code
string <= 100 characters

An active accounting code in your Zuora chart of accounts.

object (Recurring)

The recurring components of a price such as interval and usage.

start_event
string

Specifies when to start billing your customer.

Enum: "contract_effective" "service_activation" "customer_acceptance" "specific_date"
tiers_mode
string
Deprecated

Specifies the mode for tiered prices.

Enum: "graduated" "volume" "high_watermark_volume" "high_watermark_graduated" "graduated_with_overage"
apply_discount_to
Array of strings

Any combination of one_time, recurring and plan.

Items Enum: "one_time" "recurring" "usage"
Array of objects (Tier)

Price information for different tiers. When creating or updating tiered prices, you must specify this field and the tiers_mode field.

tax_code
string

A tax code identifier. If a tax_code of a price is not provided when you create or update a price, Zuora will treat the charged amount as non-taxable. If this code is provide, Zuora considers that this price is taxable and the charged amount will be handled accordingly.

tax_inclusive
boolean

If this field is set to true, it indicates that amounts are inclusive of tax.

unit_of_measure
string

A configured unit of measure. This field is required for per-unit prices.

quantity
number

Quantity of the product to which your customers subscribe.

min_quantity
number

The minimum quantity for a price. Specify this field and the max_quantity field to create a range of quantities allowed in a price.

max_quantity
number

The maximum quantity for a price. Specify this field and the min_quantity field to create a range of quantities allowed in a price.

discount_level
string

Specifies at what level a discount should be applied: account, subscription, or plan.

Enum: "account" "subscription" "plan"
revenue_recognition_rule
string

Determines when to recognize the revenue for this charge. You can choose to recognize upon invoicing or daily over time.

Enum: "on_invoice" "daily_over_time"
stacked_discount
boolean

This field is only applicable for the Percentage Discount price. This field indicates whether the discount is to be calculated as stacked discount. Possible values are as follows:

  • true: This is a stacked discount, which should be calculated by stacking with other discounts.
  • false: This is not a stacked discount, which should be calculated in sequence with other discounts.
For more information, see Stacked discounts

object (money)
object (money)
object (money)
discount_percent
number

Discount percent. Specify this field if you offer a percentage-based discount.

price_base_interval
string

Specifies the base interval of a price. If not provided, this field defaults to billing_period.

Enum: "month" "billing_period" "week"
object (Overage)
Deprecated

An object defining how overage charges are calculated.

object (Revenue)

Accounting configuration if you have Zuora Revenue enabled.

accounting_code
string

An active accounting code defined in Finance Settings > Configure Accounting Codes in your Zuora tenant.

object (Prepayment)
object (Drawdown)
taxable
boolean
Responses
200

Default Response

400

Bad Request

401

Unauthorized

404

Not Found

405

Method Not Allowed

429

Too Many Requests

500

Internal Server Error

502

Bad Gateway

503

Service Unavailable

504

Gateway Timeout

patch/prices/{price_id}
Request samples
application/json
{
  • "name": "SeedlingPlan",
  • "description": "Patch plan",
  • "start_event": "contract_effective",
  • "recognized_revenue_accounting_code": "Subscription Revenue",
  • "deferred_revenue_accounting_code": "Subscription Revenue",
  • "tax_inclusive": false,
  • "quantity": 1,
  • "min_quantity": 0,
  • "unit_of_measure": "Bottle",
  • "max_quantity": 0,
  • "recurring": {
    },
  • "discount_level": "plan",
  • "apply_discount_to": [
    ],
  • "discount_percent": 50,
  • "price_base_interval": "billing_period",
  • "custom_fields": {
    }
}
Response samples
application/json
{
  • "id": "8ad0877b7fb4e59b017fb7c23b746fce",
  • "updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
  • "updated_time": "2022-08-02T09:17:56-07:00",
  • "created_by_id": "2c92c0946a6dffc0016a7faab604299b",
  • "created_time": "2022-03-23T10:10:34-07:00",
  • "custom_fields": {
    },
  • "name": "test",
  • "description": "Test Description",
  • "recurring": {
    },
  • "start_event": "contract_effective",
  • "tax_inclusive": false,
  • "quantity": 0,
  • "discount_level": "plan",
  • "discount_percent": 50,
  • "price_base_interval": "billing_period",
  • "plan_id": "8ad09f8a7e25bda3017e25dd7743705f",
  • "charge_type": "recurring",
  • "charge_model": "discount_percentage"
}