Interface PaymentPlan

Defines prices and a payment schedule for a subscription plan.

Hierarchy

  • PaymentPlan

Properties

description? id is_active period_quantity period_unit prices provider_configs title

Properties

Optional description

description?: string

Short description.

id

id: string

A UUID.

is_active

is_active: boolean

Whether this payment plan can be used by new subscribers

period_quantity

period_quantity: number

Payment period quantity.

period_unit

period_unit: PeriodUnit

Payment period unit.

prices

prices: PaymentPlanPrice[]

Price by country per payment period.

provider_configs

provider_configs: PaymentPlanProviderConfig[]

Payment provider specific configurations.

title

title: string

The string has a minimum length of one character and it cannot consist of only whitespace characters.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc