Get Plan & Usage information for all products

1 min

GET

https://api.optimizely.com/v2/plan

Get Plan & Usage information for all products, only accessible for Administrators on the account

Responses

200

Return Plan & Usage information

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

401Invalid credentials

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

403

You do not have permission to access Plan & Usage information

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

defaultUnexpected error

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

curl

curl --request GET \
     --url https://api.optimizely.com/v2/plan \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.optimizely.com/v2/plan", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.optimizely.com/v2/plan")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.optimizely.com/v2/plan"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// Return Plan &#x26; Usage information
{
  "account_id": 1234567,
  "plan_name": "Enterprise - Premium Optimizely X Web",
  "product_usages": [
    {
      "allocation_term_in_months": 6,
      "end_time": "",
      "last_update_time": "",
      "overage_cents_per_visitor": 0.001,
      "product_name": "",
      "projects": "",
      "start_time": "",
      "usage": 12345,
      "usage_allowance": 123456
    }
  ],
  "status": "",
  "unit_of_measurement": ""
}

401

// Invalid credentials
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

403

// You do not have permission to access Plan &#x26; Usage information
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

default

// Unexpected error
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}