Products
Choose which products to include in your Offer. When building your Offer you must specify the Product (e.g. Netflix) and the ProductTier (e.g. Standard with Ads). Both values are required.
An Offer can combine multiple products (e.g. Netflix Standard + Music Premium). Read more about multi-party bundles here if if you’re looking to launch these sorts of offers.
Use the Retrieve all products endpoint to fetch available products and their tiers:
Name
Define the name of your Offer. A good name is specific and descriptive. It helps consumers understand what they’re purchasing and supports discoverability.- Clear example
- Vague example
"Premium Streaming Bundle: Netflix Standard + Music Unlimited"Availability
The date range when the Offer is available to consumers.- availableFromTs — The date from which this Offer is available (ISO 8601 date-time)
- availableToTs — The date after which this Offer is no longer available (ISO 8601 date-time)
- Example
"availableFromTs": "2024-06-22T00:00:00Z" "availableToTs": "2025-06-22T23:59:59Z"Plan
The Plan determines the lifecycle of your Offer. It controls when billing starts, how the consumer is charged, and how the subscription progresses over time. A plan consists of:- Start trigger — When the subscription lifecycle begins (required)
- Currency — The currency the consumer will be billed in (required)
- Initial fee — Optional one-time fee charged at the start, before any recurring billing
- Phases — One or more phases that define pricing and duration (required)
Start trigger
The start trigger defines when the plan’s lifecycle begins. You must specify when billing and phase progression start.Currency
The currency the consumer will be billed in. Use ISO 4217 3-letter codes (e.g. USD, EUR, GBP). Required for every plan.Initial fee
(Optional) One-time fee charged at the start of the plan, before any recurring billing.Phases
Every Offer must have at least one phase. Use multiple phases to support subscriptions with introductory pricing or free trials.Price type
Price type
Used for analytics. Options:
Duration
Duration
The length of time the consumer is in this phase. Use ISO 8601 duration format. Omit duration for evergreen phases (no end date).
Duration must be evenly divisible by the renewal frequency. For example, if duration is P1Y, renewal frequency could be P1M, P2M, P3M, P4M, or P6M.
Renewal
Renewal
How often the consumer is billed during this phase. Use ISO 8601 duration format. If the consumer is not billed during this phase (e.g. a free trial), set this to match the phase’s duration.
Amount
Amount
The amount charged to the consumer for each renewal in this phase. Amounts are always integers — e.g. $10.99 is
1099. Use 0 for free phases.Description
Description
The billing description for this phase. For resellers using the optional Billing & Charging module, this is the
billingDescription that would appear on the consumer’s bill.
