Skip to main content

Interface: Plan

Properties

channel_settings

channel_settings: ChannelSettings

An object containing the availability of the plan through various supported channels.


created_at

created_at: string

The time the plan was created.


deleted_at?

optional deleted_at: string

If deleted, the time the plan was deleted.


discount_amount

discount_amount: string

The discount amount applied to the product price when purchased through this Plan. All Plans for a product must have the same discount amount.


discount_type

discount_type: DiscountType

Used in combination with discount amount to determine the discount applied on a product price when purchased through this Plan.


external_plan_group_id

external_plan_group_id: number

External plan group id


external_plan_id

external_plan_id: number

External plan id


external_plan_name

external_plan_name: string

External plan name


external_product_id

external_product_id: ExternalId

An object containing the product id as it appears in external platforms.


external_variant_ids

external_variant_ids: string[]

External variant ids related to this plan


has_variant_restrictions

has_variant_restrictions: boolean


id

id: number

Unique numeric identifier for the Plan.


sort_order

sort_order: number

The number indicating the order which the plan will be in a list of related plans.


subscription_preferences

subscription_preferences: SubscriptionPreferences

An object containing the various subscription preferences associated with this plan.


title

title: string

The title of the plan. All Plans for a product must have the same title.


type

type: PlanType

The type of the plan. Products with a prepaid plan cannot have plans of other types.


updated_at

updated_at: string

The time the plan was last updated.