Products

Products are offerings that can be sold to customers either as one-time purchases or as recurring subscriptions. These products could include physical items, digital goods, or services that are delivered over a period of time. Chargebee's API allows developers to interact with and manipulate product data, enabling businesses to seamlessly integrate their product offerings into their subscription management workflows.

Sample ProductJSON

API Index URL

https://[site].chargebee.com/api/v2/products

Products attributes

required, string, max chars=100

The immutable unique identifier of the product.

name

required, string, max chars=100

A unique display name for the product. This is visible only in Chargebee.

external_name

required, string, max chars=100

This is a unique name appears for each product to the end user.

description

optional, string, max chars=500

Description of the product.

has_variant

required, boolean, default=true

Whether the product has variants or not.

status

required, enumerated string, default=active

Status of the product.

Enum Values

active

The active products are visible on the storefront, subscription, or checkout.

inactive

The inactive products are not visible on the storefront, subscription, or checkout.

shippable

required, boolean, default=true

Whether a product is shippable or not.

sku

optional, string, max chars=100

A unique identifier code a seller assigns to each product or item. Retailers and merchants use SKUs to keep track of inventory and sales data and help organize products within a store or warehouse. SKUs can include a combination of letters, numbers, and symbols and can vary in length depending on the seller's needs.

created_at

required, timestamp(UTC) in seconds

Timestamp when the product was created.

resource_version

optional, long

Version number of this resource. The resource_version is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.

updated_at

optional, timestamp(UTC) in seconds

Timestamp indicating when this product was last updated

deleted

required, boolean, default=false

Determines if the product is deleted or not. If the value is true then the product has been deleted else it exists. Once the product is deleted, you can reuse the product id and name .

metadata

optional, jsonobject

A collection of key-value pairs that provides extra information about the product.

Note: There's a character limit of 65,535.

Learn more .

options

Array of option list which helps in the product variant creation.