Model: Plan

1 min

Model Parameters

Plan
- account_idinteger<int64>
  Example
  1234567
  Description
  The account ID of the account that this Plan & Usage information is associated with
  Format
  int64
- plan_namestring
  Example
  Enterprise - Premium Optimizely X Web
  Description
  The name of the plan for the current account
- product_usagesProductUsage[]
  Description
  Array of products under this account
  - allocation_term_in_monthsinteger<int64>
    Example
    6
    Description
    The current allocation term length in months. The allocation term is the time between the start_time and the end_time. For example the usage for an account with an allocation_term_in_months of 6 has started accumulating on the start_time and will reset to 0 at end_time (6 months later)
    Format
    int64
  - end_timestring<date-time>
    Description
    The end date of the current allocation term period. For monthly paying accounts, the current allocation term period means the current billing month
    Format
    date-time
  - last_update_timestring<date-time>
    Description
    The last time that the unit_of_measurement count was updated
    Format
    date-time
  - overage_cents_per_visitornumber<float>
    Example
    0.001
    Description
    (optional) The cost in cents for every visitor when the number of unit_of_measurement has exceeded the usage_allowance. This value is only set for accounts with a limited usage_allowance
    Format
    float
  - product_namestring<Optimizely X AB Testing | Classic AB Testing | Personalization | Mobile | Full Stack | Recommendations | Over The Top | Impressions>
    Description
    The product name
    Allowed
    Optimizely X AB TestingClassic AB TestingPersonalizationMobileFull StackRecommendationsOver The TopImpressions
  - projectsmap<string, integer>
    Description
    Key-value map of usage per project under this account and this product. Keys are project IDs, values are usage numbers. Only available for the Impressions metrics, otherwise omitted.
  - start_timestring<date-time>
    Description
    The start date of the current allocation term period. For monthly paying accounts, the current allocation term period means the current billing month
    Format
    date-time
  - usageinteger<int64>
    Example
    12345
    Description
    The total usage in the unit_of_measurement within the current allocation term
    Format
    int64
  - usage_allowanceinteger<int64>
    Example
    123456
    Description
    (optional) The total usage allowed in the unit_of_measurement for the current allocation term. This value is only set for accounts with a limited usage_allowance
    Format
    int64
- statusstring<trial | active | inactive>
  Description
  The status of the plan for the current account
  Allowed
  trialactiveinactive
- unit_of_measurementstring<Monthly Unique Visitors | Impressions>
  Description
  The unit by which we measure the usage of this account
  Allowed
  Monthly Unique VisitorsImpressions