Skip to main content
This page summarizes the core concepts in the Digital Vending Machine® (DVM™) API data model and how they relate to each other.

Summary table

ConceptDefinition
OfferA promotable product or bundle in your catalog. Has a name, availability window, one or more products (with tiers and content provider), and an optional plan.
ProductContent provider goods or services in the catalog. Has a name, one or more product tiers, and a content provider.
Product TierA tier within a product. Contains the provisioning key (productTierKey) used downstream for entitlement creation.
Offer PlanThe pricing and phase structure for an offer. Defines plan type (e.g. SUBSCRIPTION), currency, lifecycle triggers, and billing phases.
Plan PhaseA billing phase within a plan. Defines price type (FREE, DISCOUNT, FULL_PRICE), renewal frequency, duration, amount, and billing description.
Consumer OfferAn instantiated purchase of an offer for a specific consumer. Links the offer to the consumer identifier and tracks status and lifecycle.
EntitlementA consumer’s access right to a product tier. Links to provisioning keys, content provider, and tracks status, activation, and lifecycle.

Entity relationship diagram

The diagram below shows how these concepts relate. An Offer packages one or more Products; each Product has Product Tiers. An Offer is priced by an Offer Plan, which has one or more Plan Phases. When a consumer purchases an Offer, a Consumer Offer is created, which grants one or more Entitlements for the Product Tiers.