A Product represents the core entity that partners sell through the platform. It serves as the foundation for creating offers, which are the final entities exposed for purchase. Products define the base pricing, access period, and characteristics of what is being sold.
Product Schema
Field
Description
Type
id
Unique identifier (UUID)
String
name
The name of the product
String
availability
Product availability status. Can be enabled or disabled
String
full_amount_cents
Full price in cents
Integer
full_amount_currency
Currency code for the product amount (e.g., BRL for Brazilian Real)
String
description
Detailed description of the product
String
duration_in_hours
Total duration in hours (typically for courses or time-based content)
Integer
access_period
Type of access customers have. Can be days, period, lifetime, or undefined_period
String
duration_in_days
Number of days of access (only present when access_period is days)
Integer
start_date
Access start date in ISO8601 format (only present when access_period is period)
String
end_date
Access end date in ISO8601 format (only present when access_period is period)
String
meta_pixel_code
Meta (Facebook) pixel tracking code for analytics
String
google_pixel_code
Google Analytics pixel tracking code
String
banner_url
URL to the product banner image
String
metadata
Additional custom metadata stored as key-value pairs
Object
created_at
Indicates when the record was created in ISO8601 format
String
updated_at
Indicates when the record was last updated in ISO8601 format
String
formatted_access_period
Human-readable description of the access period
String
company_id
Identifier of the company that owns this product
String
company
Company object containing company details
Object
kind
Kind object indicating the product category or type
Object
shift
Shift object containing class schedule information (for educational products)
Object
offers
Array of offer objects associated with this product
Array
splits
Array of split configurations for revenue sharing
Array
Access Period Values
Value
Description
days
Access is granted for a specific number of days. The duration_in_days field specifies how many
period
Access is granted for a specific date range. The start_date and end_date fields define the period
lifetime
Access is granted permanently with no expiration
undefined_period
Access period is not defined or determined at product level