Billing Data Model and Relationships Flashcards

A comprehensive set of vocabulary flashcards covering the hierarchy, relationships, and field definitions of a subscription billing data model.

Product Rate Plan

A template object in the Product Catalog that defines how a product is priced.

Rate Plan

An INSTANCE object that serves as a customer-specific copy of a Product Rate Plan, created when added to a subscription.

Account

The billing entity or customer object that holds billing/payment documents, stores payment methods, and acts as the parent to Subscriptions and Invoices.

Subscription

A billing contract that captures what products/services a customer bought, the billing frequency, contract length, and pricing terms.

Invoice Item

A line item on an invoice representing individual charges generated from Rate Plan Charges during a billing run.

ProductRatePlanId

The foreign key field used to link a Rate Plan (Instance) back to its Product Rate Plan (Template) source.

ProductRatePlanChargeId

The foreign key field that links a Rate Plan Charge (Instance) to its original Product Rate Plan Charge (Template).

OriginalChargeId

A field on the Rate Plan Charge that is protected from amendment changes.

ChargeId

A foreign key in Usage and Invoice Item that points to the original Rate Plan Charge ID and is recommended for stable queries.

Amendment

An object used to modify a subscription, linked via "SubscriptionId" to the version being changed.

IsLatestVersion

A boolean field indicating whether a subscription record is the current active version ($true$) or a historical version ($false$).

Product Rate Plan Charge Tier

A template level object (Level 4 in the catalog hierarchy) used specifically for volume, tiered, or tiered-with-overage pricing models.

Template

A classification for objects with a "Product" prefix used to define pricing structures before they are sold to customers.

Instance

A classification for objects without a "Product" prefix that represent actual customer data copies of catalog templates.

Catalog Hierarchy

A 4-level template structure consisting of Product (Level 1), Product Rate Plan (Level 2), Product Rate Plan Charge (Level 3), and Product Rate Plan Charge Tier (Level 4).

RatePlanChargeId

The field in an Invoice Item that points to the current Rate Plan Charge ID, which may change after an amendment.

Subscription Version

An integer ($1, 2, 3, \text{...}$) that increments with each amendment to show the historical sequence of a subscription.