Define subscription and membership products for your business.
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.
How It Works
- Create a product - Define what you're selling (name, description, settings)
- Add plans - Configure pricing options for the product
- Make available - Set visibility and geographic restrictions
- Sell subscriptions - Customers subscribe to product plans
Example: A magazine publisher creates a product called "Print + Digital Bundle" marked as shippable, adds monthly and annual plans, and restricts availability to US and Canada.
API Endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | /api/v1/core/products | List all products |
POST | /api/v1/core/products | Create a product |
GET | /api/v1/core/products/{id} | Get a product |
PUT | /api/v1/core/products/{id} | Update a product |
DELETE | /api/v1/core/products/{id} | Delete a product |
Product Object
| Attribute | Type | Description |
|---|---|---|
id | integer | Unique identifier for the product |
name | string | Public product name displayed to customers |
name_internal | string | Internal reference name (not visible to customers) |
description | string | Product description for customer-facing display |
active | boolean | Whether the product is available for purchase |
is_hidden | boolean | Whether the product is visible on your site |
is_imported | boolean | Whether product was imported |
shippable | boolean | Whether the product requires shipping |
address_required | integer | Whether a shipping address is required |
countries | array | Geographic availability (empty for all countries) |
entitlements | array | Access permissions granted by this product |
image | string | URL to product image |
language | string | Product language code |
statement_descriptor | string | Text appearing on customer statements |
unit_label | string | Label for units (e.g., "issues", "seats") |
package_dimensions | object | Shipping package dimensions |
old_provider_id | string | External system reference ID |
import_unique_id | string | Unique ID for import tracking |
plans | array | Array of associated plans |
Related Endpoints
- Plans - Pricing options for products
- Subscriptions - Customer subscriptions
- E-commerce Products - One-time purchase products