Product

From API Documentation

The Product Catalog within Zuora is used to build subscriptions. The Product object provides the list of products, along with the details of their product rate plans and product rate plan charges. Each product can have one or more product rate plans, and each rate plan can have one or more product rate plan charges. In addition, each rate plan charge can have one or more tiers. You can use this object to identify what is in the product catalog, and to identify the product rate plan ID that is necessary for the subscribe call.

Contents 1 Product Example 2 How Subscription and Product Relate to Each Other 3 Supported Calls 4 Fields

Product Example

The following is an example of a product with rate plans, rate plan charges, and rate plan charge tiers:

• The example product is a cell phone family calling plan.
• The available rate plans for the product are:
  1. A 500-minute rate plan
  2. An 800-minute rate plan
  3. A 1,000-minute rate plan
• The rate plan charges for the product for rate plans A, B, and C are:
  1. One-time fees
  2. Monthly fees
  3. Usage fees
• Three tiers for rate plan A's usage fees are:
  1. 1 to 200 minutes over the plan: 20¢ a minute.
  2. 201 to 400 minutes over: 15¢ a minute.
  3. 401+ minutes over: 10¢ a minute.

How Subscription and Product Relate to Each Other

The set of {Product, product rate plan(s), and product rate plan charge(s)} is a defined set of products a company sells (for example, a family plan with each member costing $10).

The set of {a Subscription, rate plan(s), and rate plan charge(s)} is an instance of a Product, with actual quantities specified (five family members on a family plan, for example).

Supported Calls

This object can be used with the query, create, delete, and update calls.

Fields

In addition to the following fields, zObject contributes additional fields. For information on the field types, see Field Types.

Name	Required?	Type	Allowed Operations: ● Yes ○ No	Allowable Values	Description
Category	No	string	● Create ● Query ● Update ● Delete ● Filter	DefaultCatalog	Reference to a product catalog.
CreatedById	System generated, always exists	ZNS:Id	○ Create ● Query ○ Update ○ Delete ● Filter	This field is not editable. 32 characters maximum.	Available as of version 20.0 of the API. The Zuora system automatically generates this Id of the user who created the object.
CreatedDate	System generated, always exists	dateTime	○ Create ● Query ○ Update ○ Delete ● Filter	This field is not editable.	Available as of version 20.0 of the API. The Zuora system automatically generates this, and denotes when the objects was first created.
Description	No	string	● Create ● Query ● Update ● Delete ● Filter	500 characters maximum	A description of the product.
EffectiveEndDate	Yes	dateTime	● Create ● Query ● Update ● Delete ● Filter	A valid dateTime value	The date on which the product expires or is no longer valid.
EffectiveStartDate	Yes	dateTime	● Create ● Query ● Update ● Delete ● Filter	A valid dateTime value	The date on which the product becomes available.
Name	Yes	string	● Create ● Query ● Update ● Delete ● Filter	100 characters maximum	The name of the product; e.g., Family Plan. Must be unique across products, no two products can have the same name.
SKU	Yes	string	● Create ● Query ● Update ● Delete ● Filter	50 characters maximum	Must be unique in the system; no two products can have the same SKU.
UpdatedById	System generated, always exists	ZNS:Id	○ Create ● Query ○ Update ○ Delete ● Filter	This field is not editable. 32 characters maximum.	Available as of version 20.0 of the API. The Zuora system automatically generates this Id of the user who last updated the object.
UpdatedDate	System generated, always exists	dateTime	○ Create ● Query ○ Update ○ Delete ● Filter	This field is not editable.	Available as of version 20.0 of the API. The Zuora system automatically generates this, and denotes when the objects was last updated.