List items

Filter items based on item_family_id . Supported operators : is, is_not, starts_with, in, not_in

Example → item_family_id[is] = "acme"

Filter items based on item type. Possible values are : plan, addon, charge.

Supported operators : is, is_not, in, not_in

Example → type[is] = "plan"

Filter items based on item name . Supported operators : is, is_not, starts_with

Example → name[is_not] = "basic"

Filter items based on item_applicability. Possible values are : all, restricted.

Supported operators : is, is_not, in, not_in

Example → item_applicability[is_not] = "all"

Filter items based on item status. Possible values are : active, archived, deleted.

Supported operators : is, is_not, in, not_in

Example → status[is] = "active"

Specifies if gift subscriptions can be created for this item. Possible values are : true, false

Supported operators : is

Example → is_giftable[is] = "true"

Filter items based on when the items were last updated. Supported operators : after, before, on, between

Example → updated_at[after] = "1243545465"

Allow the plan to subscribed to via Checkout. Applies only for plan-items. Note: Only the in-app layout of Checkout is supported. Possible values are : true, false

Supported operators : is

Example → enabled_for_checkout[is] = "null"

Allow customers to change their subscription to this plan via the Self-Serve Portal. Applies only for plan-items. This requires the Portal configuration to allow changing subscriptions. Possible values are : true, false

Supported operators : is

Example → enabled_in_portal[is] = "null"

Specifies whether the item undergoes metered billing. When true , the quantity is calculated from usage records. When false , the quantity is as determined while adding an item price to the subscription. Applicable only for items of type plan or addon and when Metered Billing is enabled. The value of this attribute cannot be changed. Possible values are : true, false

Supported operators : is

Example → metered[is] = "true"

How the quantity is calculated from usage data for the item prices belonging to this item. Only applicable when the item is metered. This value overrides the one set at the site level. Possible values are : sum_of_usages, last_usage, max_usage.

Supported operators : is, is_not, in, not_in

Example → usage_calculation[is_not] = "SUM_OF_USAGES"

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"

The unique ID of the business entity of this item. Learn more about all the scenarios before using this filter.

Supported operators : is, is_present

Example → business_entity_id[is_present] = "true"

Default value is true . To exclude site-level resources in specific cases, set this parameter to false. Possible values are : true, false

Supported operators : is

Example → include_site_level_resources[is] = "null"