PriceList

Attributes of the PriceList type

Name
Type
Description

basePrice

Float

The minimum amount you'll pay by using this plan

charges

List of charges for this plan

code

String

Unique code of the plan. To avoid name collissions, it is a good idea to prefix with plan code

createdAt

ISO8601DateTime

Timestamp of when the plan was created

currency

Currency object

currencyId

ID

The currency of the prices on the plan

id

ID

Unique ID of the price list

isVisible

Boolean

Controls whether the plan is visible for sale

name

String

Name of the price list

periodMonths

Int

Number of months per billing cycle

plan

Object of the plan the price list belongs to

planId

ID

ID of the plan the price list belongs to

priceAdjustmentAction

priceAdjustmentActionOptions

List (String)

priceAdjustmentPercentage

Float

priceAdjustmentTiming

priceAdjustmentTimingOptions

List (String)

priceDescription

String

Auto-generated summary of the pricing

priceListChargeDefaults

Default values for a new price list charge

product

productId

ID

ID of the plan the product belongs to

renewalTermMonths

Int

Number of months for the renewal term

renewalTermMonthsOptions

sku

String

Stock keeping unit

trialAllowed

Boolean

Determines whether a trial period is possible before paying

trialExpirationAction

Controls whether the subscription expires or converts to active when the trial expires

trialLengthDays

Int

The defaeult length in days of the trial period

updatedAt

ISO8601DateTime

Timestamp of last time the plan was updated

Last updated

Was this helpful?