Skip to main content

Interface: CDNPlan

Extends

  • Omit<Plan, "channel_settings" | "created_at" | "deleted_at" | "external_product_id" | "subscription_preferences" | "updated_at">

Properties

apply_custom_date_to_checkout

apply_custom_date_to_checkout: boolean


charge_interval_frequency

charge_interval_frequency: number


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.

Inherited from

Omit.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.

Inherited from

Omit.discount_type


external_plan_group_id

external_plan_group_id: number

External plan group id

Inherited from

Omit.external_plan_group_id


external_plan_id

external_plan_id: number

External plan id

Inherited from

Omit.external_plan_id


external_plan_name

external_plan_name: string

External plan name

Inherited from

Omit.external_plan_name


external_variant_ids

external_variant_ids: string[]

External variant ids related to this plan

Inherited from

Omit.external_variant_ids


has_variant_restrictions

has_variant_restrictions: boolean

Inherited from

Omit.has_variant_restrictions


id

id: number

Unique numeric identifier for the Plan.

Inherited from

Omit.id


interval_unit

interval_unit: IntervalUnit


order_interval_frequency

order_interval_frequency: number


pricing_progression

pricing_progression: object[]


sort_order

sort_order: number

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

Inherited from

Omit.sort_order


title

title: string

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

Inherited from

Omit.title


type

type: PlanType

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

Inherited from

Omit.type