List plans

Eventually Consistent

This API fetches all the active and archived plans. If the limit parameter is not set, it will return upto 10 plans.

Sample Request

Sample Result[JSON]

URL Format

GET https://[site].chargebee.com/api/v2/plans

Input Parameters

limit

optional, integer, default=10, min=1, max=100

The number of resources to be returned.

offset

optional, string, max chars=1000

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset to the value of next_offset obtained in the previous iteration of the API call.

include_deleted

optional, boolean, default=false

If set to true, includes the deleted resources in the response. For the deleted resources in the response, the 'deleted ' attribute will be 'true '.

Filter Params

For operator usages, see the Pagination and Filtering section.

id[<operator>]

optional, string filter

A unique ID for your system to identify the plan. Supported operators : is, is_not, starts_with, in, not_in

Example → id[is] = "Enterprise"

Supported operators: is, is_not, starts_with, in, not_in

Example → Enterprise

name[<operator>]

optional, string filter

The display name used in web interface for identifying the plan. Supported operators : is, is_not, starts_with, in, not_in

Example → name[is] = "plan_enterprise"

Supported operators: is, is_not, starts_with, in, not_in

Example → plan_enterprise

price[<operator>]

optional, in cents filter

The price of the plan. The unit depends on the type of currency . Supported operators : is, is_not, lt, lte, gt, gte, between

Example → price[gte] = "1200"

Supported operators: is, is_not, lt, lte, gt, gte, between

Example → 1200

period[<operator>]

optional, integer filter

Defines billing frequency. Example: to bill customer every 3 months, provide "3" here. Supported operators : is, is_not, lt, lte, gt, gte, between

Example → period[lte] = "3"

Supported operators: is, is_not, lt, lte, gt, gte, between

Example → 3

period_unit[<operator>]

optional, enumerated string filter

Defines billing frequency in association with billing period. Possible values are : day, week, month, year.

Supported operators : is, is_not, in, not_in

Example → period_unit[is] = "month"

Supported operators: is, is_not, in, not_in

Example → month

trial_period[<operator>]

optional, integer filter

The free time window for your customer to try your product. Supported operators : is, is_not, lt, lte, gt, gte, between, is_present

Example → trial_period[lt] = "14"

Supported operators: is, is_not, lt, lte, gt, gte, between, is_present

Example → 14

trial_period_unit[<operator>]

optional, enumerated string filter

Time unit for the trial period. Possible values are : day, month.

Supported operators : is, is_not, in, not_in

Example → trial_period_unit[is] = "day"

Supported operators: is, is_not, in, not_in

Example → day

addon_applicability[<operator>]

optional, enumerated string filter

Indicates if all or only some addons are applicable with the plan. Possible values are : all, restricted.

Supported operators : is, is_not, in, not_in

Example → addon_applicability[is] = "all"

Supported operators: is, is_not, in, not_in

Example → all

giftable[<operator>]

optional, boolean filter

Specifies if the plan should be gifted or not. Possible values are : true, false

Supported operators : is

Example → giftable[is] = "true"

Supported operators: is

Example → true

pricing_model[<operator>]

optional, enumerated string filter

Defines how the recurring charges for the subscription is calculated. Possible values are : flat_fee, per_unit, tiered, volume, stairstep.

Supported operators : is, is_not, in, not_in

Example → pricing_model[is] = "flat_fee"

Supported operators: is, is_not, in, not_in

Example → flat_fee

status[<operator>]

optional, enumerated string filter

The plan state. Possible values are : active, archived, deleted.

Supported operators : is, is_not, in, not_in

Example → status[is] = "active"

Supported operators: is, is_not, in, not_in

Example → active

updated_at[<operator>]

optional, timestamp(UTC) in seconds filter

To filter based on updated at. This attribute will be present only if the resource has been updated after 2016-11-09. Supported operators : after, before, on, between

Example → updated_at[before] = "1243545465"

Supported operators: after, before, on, between

Example → 1243545465

currency_code[<operator>]

optional, string filter

The currency code (ISO 4217 format) of the plan. Supported operators : is, is_not, starts_with, in, not_in

Example → currency_code[is] = "USD"

Supported operators: is, is_not, starts_with, in, not_in

Example → USD

channel[<operator>]

optional, enumerated string filter

The subscription channel this object originated from and is maintained in. Possible values are : web, app_store, play_store.

Supported operators : is, is_not, in, not_in

Example → channel[is] = "APP STORE"

Supported operators: is, is_not, in, not_in

Example → APP STORE

Returns

next_offset

optional, string, max chars=1000

This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter offset.

plan

Plan object

Resource object representing plan