Overview

Products represent the items or services you offer to customers. Each product can have multiple plans with different pricing options. Products include settings for visibility, shipping requirements, and geographic availability.

API Endpoints

Method	Endpoint	Description
`GET`	`/products`	List products
`POST`	`/products`	Create product
`GET`	`/products/{id}`	Get product
`PUT`	`/products/{id}`	Update product
`DELETE`	`/products/{id}`	Delete product

Product Object

Attribute	Type	Description
`id`	integer	Unique identifier for the product
`active`	boolean	Whether the product is active (automatically set to true on creation)
`address_required`	integer	Whether a shipping address is required (0 or 1)
`description`	string	Customer-facing product description
`entitlements`	object	Access permissions granted by this product
`is_hidden`	boolean	Whether the product is hidden from public display
`is_imported`	boolean	Whether the product was imported from an external system
`language`	string	Product language locale (e.g. en_US, fr_CA)
`name`	string	Public product name displayed to customers
`name_internal`	string	Internal reference name (not visible to customers)
`package_dimensions`	object	Shipping package dimensions
`shippable`	boolean	Whether the product requires shipping
`statement_descriptor`	string	Text appearing on customer bank statements (max 22 chars)
`unit_label`	string	Label for units (e.g. issues, seats)
`countries`	array	Geographic availability by ISO country code
`image`	string	URL to product image
`old_provider_id`	string	External product ID from a previous provider
`import_unique_id`	string	Unique import identifier
`revenue_recognition_strategy`	integer	Revenue recognition strategy (internal)
`plans`	array	Associated pricing plans