Package
interface Package {
ref_id: number;
external_id: number;
name: string;
price: string;
price_total: string;
price_retail?: string;
price_retail_total?: string;
price_recurring?: string;
price_recurring_total?: string;
qty: number;
image: string;
is_recurring: boolean;
interval?: 'day' | 'month' | null;
interval_count?: number | null;
product_variant_id?: number;
product_variant_name?: string;
product_id?: number;
product_name?: string;
product_sku?: string | null;
product_purchase_availability?: string;
product_inventory_availability?: string;
}Source: global.ts:1189
A single purchasable package (offer) within a Campaign — one buyable unit with its own pricing, product, and recurring/variant details. ref_id is the id you pass everywhere else (add-to-cart, selectors, data-next-package-id).
Properties
ref_id: number
The package id used throughout the SDK (add-to-cart, selectors, attributes).
external_id: number
The store's external/catalog id for this package.
name: string
Package display name.
price: string
Per-unit price as a formatted string.
price_total: string
Total package price (all units) as a formatted string.
price_retail: string
Per-unit retail/compare-at price, if set.
price_retail_total: string
Total retail/compare-at price, if set.
price_recurring: string
Recurring per-unit price, for subscription packages.
price_recurring_total: string
Total recurring price, for subscription packages.
qty: number
Number of product units included in the package.
image: string
Product image URL.
is_recurring: boolean
true if this is a subscription/recurring package.
interval: 'day' | 'month' | null
Billing interval for recurring packages.
interval_count: number | null
Number of intervals between billing cycles.
product_variant_id: number
Product variant id, when the package maps to a specific variant.
product_variant_name: string
Product variant display name.
product_id: number
Underlying product id.
product_name: string
Underlying product display name.
product_sku: string | null
Product SKU, or null if none.
product_purchase_availability: string
Whether the product can currently be purchased.
product_inventory_availability: string
Whether the product is currently in stock.