Types > SubscriptionPlanCreate
Commerce APITypesSubscriptionPlanCreate
SubscriptionPlanCreate

Description

Fields

align_day_of_month: OptionalIntCreate

Specifies how annual and monthly subscriptions should be aligned


align_day_of_week: OptionalIntCreate

Specifies how weekly subscriptions should be aligned


align_hour: OptionalIntCreate

Specifies how annual, monthly and daily subscriptions should be aligned


align_month: OptionalIntCreate

Specifies how annual subscriptions should be aligned


billing_interval_count: Int!

Billing interval count

Example: 12

Valid when: billing_interval_count is a positive integer


discountable: Boolean

Whether it's possible to apply a discount to a product (given that subscription is used)

Example: false


fulfillment_interval_count: Int!

Fulfillment interval count

Example: 1

Valid when: fulfillment_interval_count is a positive integer


interval: SubscriptionPlanInterval!

Interval for subscription plan

Example: "monthly"


limit: Int

A maxiumum amount of billing cycles

Example: 0

Valid when: limit is a non-negative integer


price1: Int

First purchase price value

Example: 1500

Valid when: price1 is a non-negative integer


price1_percentage: Float

First purchase price percentage value

Example: 50

Valid when: price1_percentage is valid percentage, i.e.: 0 ≤ price1_percentage ≤ 100


price1_type: SubscriptionPlanPriceType!

First purchase price type

Example: price


price2: Int

Non-first purchases price value

Example: 1500

Valid when: price2 is a non-negative integer


price2_percentage: Float

Non-first purchases price percentage value

Example: 50

Valid when: price2_percentage is valid percentage, i.e.: 0 ≤ price2_percentage ≤ 100


price2_type: SubscriptionPlanPriceType!

Non-first purchases price type

Example: price


Used By

Types

ProductCreate, ProductModify

Preview (typescript)

Loading module