Subscription Platform
Combined subscription information from multiple products and payment platforms; see bug 1703340
active_subscriptions
Active Subscriptions
subscription_platform.active_subscriptions
Please provide a description for the query
| Column | Description | Type | Nullable |
|---|---|---|---|
| active_date | Date | Yes | |
| plan_id | String | Yes | |
| country | String | Yes | |
| country_name | String | Yes | |
| provider | String | Yes | |
| plan_amount | Integer | Yes | |
| plan_currency | String | Yes | |
| plan_interval | String | Yes | |
| plan_interval_count | Integer | Yes | |
| product_id | String | Yes | |
| product_name | String | Yes | |
| pricing_plan | String | Yes | |
| promotion_codes | String | No | |
| promotion_discounts_amount | Integer | Yes | |
| count | Integer | Yes |
| Project | Dataset | Table |
|---|---|---|
| moz-fx-data-shared-prod | subscription_platform_derived | active_subscriptions_v1 |
Source Directory | View Definition | Metadata File
apple_subscriptions
Apple Subscriptions
subscription_platform.apple_subscriptions
Please provide a description for the query
| Column | Description | Type | Nullable |
|---|---|---|---|
| customer_id | String | Yes | |
| subscription_id | String | Yes | |
| original_subscription_id | String | Yes | |
| plan_id | String | Yes | |
| status | String | Yes | |
| event_timestamp | Timestamp | Yes | |
| subscription_start_date | Timestamp | Yes | |
| created | Timestamp | Yes | |
| trial_start | Timestamp | Yes | |
| trial_end | Timestamp | Yes | |
| cancel_at_period_end | Boolean | Yes | |
| ended_at | Timestamp | Yes | |
| ended_reason | String | Yes | |
| fxa_uid | String | Yes | |
| provider | String | Yes | |
| plan_interval | String | Yes | |
| plan_interval_count | Integer | Yes | |
| plan_interval_timezone | String | Yes | |
| product_id | String | Yes | |
| in_billing_grace_period | Boolean | Yes | |
| billing_grace_period | Interval | Yes | |
| promotion_codes | String | No |
| Project | Dataset | Table |
|---|---|---|
| moz-fx-data-shared-prod | subscription_platform_derived | apple_subscriptions_v1 |
Source Directory | View Definition | Metadata File
daily_active_logical_subscriptions
Daily Active Logical Subscriptions
subscription_platform.daily_active_logical_subscriptions
Please provide a description for the query
| Column | Description | Type | Nullable |
|---|---|---|---|
| id | String | Yes | |
| date | Date | Yes | |
| logical_subscriptions_history_id | String | Yes | |
| subscription | Record | Yes | |
| was_active_at_day_start | Boolean | Yes | |
| was_active_at_day_end | Boolean | Yes |
| Project | Dataset | Table |
|---|---|---|
| moz-fx-data-shared-prod | subscription_platform_derived | daily_active_logical_subscriptions_v1 |
Source Directory | View Definition | Metadata File
logical_subscription_events
Logical Subscription Events
subscription_platform.logical_subscription_events
Please provide a description for the query
| Column | Description | Type | Nullable |
|---|---|---|---|
| id | String | Yes | |
| timestamp | Timestamp | Yes | |
| type | String | Yes | |
| reason | String | Yes | |
| logical_subscriptions_history_id | String | Yes | |
| subscription | Record | Yes | |
| old_subscription | Record | Yes |
| Project | Dataset | Table |
|---|---|---|
| moz-fx-data-shared-prod | subscription_platform_derived | logical_subscription_events_v1 |
Source Directory | View Definition | Metadata File
logical_subscriptions
Logical Subscriptions
subscription_platform.logical_subscriptions
Please provide a description for the query
| Project | Dataset | Table |
|---|---|---|
| moz-fx-data-shared-prod | subscription_platform_derived | logical_subscriptions_history_v1 |
Source Directory | View Definition | Metadata File
monthly_active_logical_subscriptions
Monthly Active Logical Subscriptions
subscription_platform.monthly_active_logical_subscriptions
Please provide a description for the query
| Column | Description | Type | Nullable |
|---|---|---|---|
| id | String | Yes | |
| month_start_date | Date | Yes | |
| month_end_date | Date | Yes | |
| logical_subscriptions_history_id | String | Yes | |
| subscription | Record | Yes | |
| was_active_at_month_start | Boolean | Yes | |
| was_active_at_month_end | Boolean | Yes |
| Project | Dataset | Table |
|---|---|---|
| moz-fx-data-shared-prod | subscription_platform_derived | monthly_active_logical_subscriptions_v1 |
Source Directory | View Definition | Metadata File
nonprod_apple_subscriptions
Nonprod Apple Subscriptions
subscription_platform.nonprod_apple_subscriptions
Please provide a description for the query
| Column | Description | Type | Nullable |
|---|---|---|---|
| customer_id | String | Yes | |
| subscription_id | String | Yes | |
| original_subscription_id | String | Yes | |
| plan_id | String | Yes | |
| status | String | Yes | |
| event_timestamp | Timestamp | Yes | |
| subscription_start_date | Timestamp | Yes | |
| created | Timestamp | Yes | |
| trial_start | Timestamp | Yes | |
| trial_end | Timestamp | Yes | |
| cancel_at_period_end | Boolean | Yes | |
| ended_at | Timestamp | Yes | |
| ended_reason | String | Yes | |
| fxa_uid | String | Yes | |
| provider | String | Yes | |
| plan_interval | String | Yes | |
| plan_interval_count | Integer | Yes | |
| plan_interval_timezone | String | Yes | |
| product_id | String | Yes | |
| in_billing_grace_period | Boolean | Yes | |
| billing_grace_period | Interval | Yes | |
| promotion_codes | String | No |
| Project | Dataset | Table |
|---|---|---|
| moz-fx-data-shared-prod | subscription_platform_derived | nonprod_apple_subscriptions_v1 |
Source Directory | View Definition | Metadata File
nonprod_stripe_subscriptions
Nonprod Stripe Subscriptions
subscription_platform.nonprod_stripe_subscriptions
Please provide a description for the query
| Column | Description | Type | Nullable |
|---|---|---|---|
| customer_id | String | Yes | |
| fxa_uid | String | Yes | |
| subscription_id | String | Yes | |
| subscription_item_id | String | Yes | |
| event_timestamp | Timestamp | Yes | |
| created | Timestamp | Yes | |
| trial_start | Timestamp | Yes | |
| trial_end | Timestamp | Yes | |
| subscription_start_date | Timestamp | Yes | |
| cancel_at | Timestamp | Yes | |
| cancel_at_period_end | Boolean | Yes | |
| canceled_at | Timestamp | Yes | |
| canceled_for_customer_at | String | Yes | |
| ended_at | Timestamp | Yes | |
| status | String | Yes | |
| product_id | String | Yes | |
| product_name | String | Yes | |
| product_capabilities | String | No | |
| plan_id | String | Yes | |
| plan_started_at | Timestamp | Yes | |
| plan_ended_at | Timestamp | Yes | |
| plan_name | String | Yes | |
| plan_capabilities | String | No | |
| plan_amount | Integer | Yes | |
| billing_scheme | String | Yes | |
| plan_currency | String | Yes | |
| plan_interval | String | Yes | |
| plan_interval_count | Integer | Yes | |
| plan_interval_timezone | String | Yes | |
| provider | String | Yes | |
| country | String | Yes | |
| promotion_codes | String | No | |
| promotion_discounts_amount | Integer | Yes |
| Project | Dataset | Table |
|---|---|---|
| moz-fx-data-shared-prod | subscription_platform_derived | nonprod_stripe_subscriptions_v1 |
Source Directory | View Definition | Metadata File
nonprod_stripe_subscriptions_history
Nonprod Stripe Subscriptions History
subscription_platform.nonprod_stripe_subscriptions_history
Please provide a description for the query
| Column | Description | Type | Nullable |
|---|---|---|---|
| customer_id | String | Yes | |
| fxa_uid | String | Yes | |
| subscription_id | String | Yes | |
| subscription_item_id | String | Yes | |
| synced_at | Timestamp | Yes | |
| valid_from | Timestamp | Yes | |
| valid_to | Timestamp | Yes | |
| created | Timestamp | Yes | |
| trial_start | Timestamp | Yes | |
| trial_end | Timestamp | Yes | |
| subscription_start_date | Timestamp | Yes | |
| cancel_at | Timestamp | Yes | |
| cancel_at_period_end | Boolean | Yes | |
| canceled_at | Timestamp | Yes | |
| canceled_for_customer_at | String | Yes | |
| ended_at | Timestamp | Yes | |
| status | String | Yes | |
| product_id | String | Yes | |
| product_name | String | Yes | |
| product_capabilities | String | No | |
| plan_id | String | Yes | |
| plan_started_at | Timestamp | Yes | |
| plan_ended_at | Timestamp | Yes | |
| plan_name | String | Yes | |
| plan_capabilities | String | No | |
| plan_amount | Integer | Yes | |
| billing_scheme | String | Yes | |
| plan_currency | String | Yes | |
| plan_interval | String | Yes | |
| plan_interval_count | Integer | Yes | |
| plan_interval_timezone | String | Yes | |
| provider | String | Yes | |
| country | String | Yes | |
| promotion_codes | String | No | |
| promotion_discounts_amount | Integer | Yes |
| Project | Dataset | Table |
|---|---|---|
| moz-fx-data-shared-prod | subscription_platform_derived | nonprod_stripe_subscriptions_history_v1 |
Source Directory | View Definition | Metadata File
stripe_plans
Stripe Plans
subscription_platform.stripe_plans
Please provide a description for the query
| Column | Description | Type | Nullable |
|---|---|---|---|
| id | Unique identifier for the plan. | String | Yes |
| product_id | ID of the product whose pricing this plan determines. | String | Yes |
| created | Time at which the plan was created. | Timestamp | Yes |
| is_deleted | Whether the plan is deleted. | Boolean | Yes |
| active | Whether the plan can be used for new purchases. | Boolean | Yes |
| aggregate_usage | Specifies a usage aggregation strategy for plans of `usage_type` = "metered". Allowed values are "sum" for summing up all usage during a period, "last_during_period" for using the last usage record reported within a period, "last_ever" for using the last usage record ever (across period bounds) or "max" which uses the usage record with the maximum reported usage during a period. | String | Yes |
| amount | The unit amount in cents to be charged, represented as a whole integer if possible. Only set if `billing_scheme` = "per_unit". | Integer | Yes |
| billing_scheme | Describes how to compute the price per period. Either "per_unit" or "tiered". "per_unit" indicates that the fixed amount (specified in `amount`) will be charged per unit in `quantity` (for plans with `usage_type` = "licensed"), or per unit of total usage (for plans with `usage_type` = "metered"). "tiered" indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes. | String | Yes |
| currency | Three-letter ISO currency code, in lowercase. | String | Yes |
| interval | The frequency at which a subscription is billed. One of "day", "week", "month", or "year". | String | Yes |
| interval_count | The number of intervals (specified in the `interval` attribute) between subscription billings. | Integer | Yes |
| metadata | Set of key-value pairs attached to the plan, stored as a JSON object. | Json | Yes |
| nickname | A brief description of the plan, hidden from customers. | String | Yes |
| tiers_mode | Defines if the tiering price should be "graduated" or "volume". In volume-based tiering, the maximum quantity within a period determines the per unit price. In graduated tiering, pricing can change as the quantity grows. | String | Yes |
| trial_period_days | Default number of trial days when subscribing a customer to this plan using `trial_from_plan=true`. | Integer | Yes |
| usage_type | Configures how the quantity per period should be determined. Can be either "metered" or "licensed". "licensed" automatically bills the `quantity` set when adding it to a subscription. "metered" aggregates the total usage based on usage records. Defaults to "licensed". | String | Yes |
| Project | Dataset | Table |
|---|---|---|
| moz-fx-data-shared-prod | subscription_platform_derived | stripe_plans_v1 |
Source Directory | View Definition | Metadata File
stripe_products
Stripe Products
subscription_platform.stripe_products
Please provide a description for the query
| Column | Description | Type | Nullable |
|---|---|---|---|
| id | Unique identifier for the product. | String | Yes |
| created | Time at which the product was created. | Timestamp | Yes |
| updated | Time at which the product was last updated. | Timestamp | Yes |
| is_deleted | Whether the product is deleted. | Boolean | Yes |
| active | Whether the product is currently available for purchase. | Boolean | Yes |
| description | The product's description, meant to be displayable to the customer. | String | Yes |
| metadata | Set of key-value pairs attached to the product, stored as a JSON object. | Json | Yes |
| name | The product's name, meant to be displayable to the customer. | String | Yes |
| statement_descriptor | Extra information about a product which will appear on your customer's credit card statement. | String | Yes |
| Project | Dataset | Table |
|---|---|---|
| moz-fx-data-shared-prod | subscription_platform_derived | stripe_products_v1 |
Source Directory | View Definition | Metadata File
stripe_subscriptions
Stripe Subscriptions
subscription_platform.stripe_subscriptions
Please provide a description for the query
| Column | Description | Type | Nullable |
|---|---|---|---|
| customer_id | String | Yes | |
| fxa_uid | String | Yes | |
| subscription_id | String | Yes | |
| subscription_item_id | String | Yes | |
| event_timestamp | Timestamp | Yes | |
| created | Timestamp | Yes | |
| trial_start | Timestamp | Yes | |
| trial_end | Timestamp | Yes | |
| subscription_start_date | Timestamp | Yes | |
| cancel_at | Timestamp | Yes | |
| cancel_at_period_end | Boolean | Yes | |
| canceled_at | Timestamp | Yes | |
| canceled_for_customer_at | String | Yes | |
| ended_at | Timestamp | Yes | |
| status | String | Yes | |
| product_id | String | Yes | |
| product_name | String | Yes | |
| product_capabilities | String | No | |
| plan_id | String | Yes | |
| plan_started_at | Timestamp | Yes | |
| plan_ended_at | Timestamp | Yes | |
| plan_name | String | Yes | |
| plan_capabilities | String | No | |
| plan_amount | Integer | Yes | |
| billing_scheme | String | Yes | |
| plan_currency | String | Yes | |
| plan_interval | String | Yes | |
| plan_interval_count | Integer | Yes | |
| plan_interval_timezone | String | Yes | |
| provider | String | Yes | |
| country | String | Yes | |
| promotion_codes | String | No | |
| promotion_discounts_amount | Integer | Yes |
| Project | Dataset | Table |
|---|---|---|
| moz-fx-data-shared-prod | subscription_platform_derived | stripe_subscriptions_v1 |
Source Directory | View Definition | Metadata File
stripe_subscriptions_history
Stripe Subscriptions History
subscription_platform.stripe_subscriptions_history
Please provide a description for the query
| Column | Description | Type | Nullable |
|---|---|---|---|
| customer_id | String | Yes | |
| fxa_uid | String | Yes | |
| subscription_id | String | Yes | |
| subscription_item_id | String | Yes | |
| synced_at | Timestamp | Yes | |
| valid_from | Timestamp | Yes | |
| valid_to | Timestamp | Yes | |
| created | Timestamp | Yes | |
| trial_start | Timestamp | Yes | |
| trial_end | Timestamp | Yes | |
| subscription_start_date | Timestamp | Yes | |
| cancel_at | Timestamp | Yes | |
| cancel_at_period_end | Boolean | Yes | |
| canceled_at | Timestamp | Yes | |
| canceled_for_customer_at | String | Yes | |
| ended_at | Timestamp | Yes | |
| status | String | Yes | |
| product_id | String | Yes | |
| product_name | String | Yes | |
| product_capabilities | String | No | |
| plan_id | String | Yes | |
| plan_started_at | Timestamp | Yes | |
| plan_ended_at | Timestamp | Yes | |
| plan_name | String | Yes | |
| plan_capabilities | String | No | |
| plan_amount | Integer | Yes | |
| billing_scheme | String | Yes | |
| plan_currency | String | Yes | |
| plan_interval | String | Yes | |
| plan_interval_count | Integer | Yes | |
| plan_interval_timezone | String | Yes | |
| provider | String | Yes | |
| country | String | Yes | |
| promotion_codes | String | No | |
| promotion_discounts_amount | Integer | Yes |
| Project | Dataset | Table |
|---|---|---|
| moz-fx-data-shared-prod | subscription_platform_derived | stripe_subscriptions_history_v1 |
Source Directory | View Definition | Metadata File