The Plan object represents a subscription plan in Aikeedo themes, providing access to essential plan information. This object is part of the plans array, which is globally accessible, allowing you to easily incorporate plan-specific data and functionality into your theme.

Availability

The Plan objects are available globally as part of the plans array. You can iterate through this array to access individual plan objects and their properties.

It’s a good practice to check if the plans array exists and has elements before attempting to access individual plan objects.

Properties

Each Plan object contains the following properties:

id
string
required

A unique identifier for the plan, always in UUID version 4 format (e.g., “018e73c8-c4d7-7124-b9ee-83fcf3e1c74b”).

title
string
required

The name or title of the plan (e.g., “Free”).

description
string
required

A brief description of the plan (e.g., “Launch Your Journey”).

icon
string|null
required

URL to the plan’s icon image. This field can be null if no icon is set.

price
number
required

The price of the plan. For free plans, this value will be 0.

billing_cycle
string
required

The billing cycle for the plan (e.g., “monthly”).

credit_count
number
required

The number of credits included in the plan.

created_at
number
required

Unix timestamp of when the plan was created.

updated_at
number
required

Unix timestamp of the last update to the plan.

is_featured
boolean
required

Indicates whether the plan is featured or not.

superiority
number
required

A numeric value representing the plan’s superiority or ranking compared to other plans.

config
PlanConfig
required

The configuration object for the plan. See PlanConfig Object for more details on the properties of this object.

feature_list
array
required

An array of features included in the plan. This array may be empty if no specific features are defined.