@collectivtech/alana-sdk-js / resources/account / ProfileSubscription
Interface: ProfileSubscription
Defined in: src/resources/account.ts:9
A single subscription of the active user to an ALANA Partner site.
Properties
baseCredits?
optionalbaseCredits?:number
Defined in: src/resources/account.ts:53
If this membership plan provides ALANA Credits or Coins, then this property will contain the number of coins provided in each payment period. Credits and coins are deposited in the user's account at the time of payment.
basePrice
basePrice:
number
Defined in: src/resources/account.ts:32
The base price of this membership, in dollars. This amount will be charged every month unless the payPeriodMonths property is set.
businessPlan?
optionalbusinessPlan?:boolean
Defined in: src/resources/account.ts:82
Whether this membership is considered a "business" plan rather than one intended for end users.
creditName?
optionalcreditName?:string
Defined in: src/resources/account.ts:59
If this membership plan provides ALANA Credits or Coins, then this property will contain the name of the credit or coin provided.
description?
optionaldescription?:string
Defined in: src/resources/account.ts:45
A description of this membership plan, set by the providing business or brand. At a minimum, it should detail the features of the plan.
id
id:
number
Defined in: src/resources/account.ts:13
A unique, opaque ID for this subscription.
name
name:
string
Defined in: src/resources/account.ts:18
The name of the membership plan.
payPeriodMonths?
optionalpayPeriodMonths?:number
Defined in: src/resources/account.ts:39
If the membership plan is not charged monthly, then the number of months each successive renewal of the plan lasts. For example, quarterly plans will have this property set to 3, annual plans to 12, and so on.
provider?
optionalprovider?:string
Defined in: src/resources/account.ts:66
The name of the business or brand providing this membership. The ALANA Platform only offers direct memberships to our partners. In that rare case, this property will be null.
providerLogo?
optionalproviderLogo?:string
Defined in: src/resources/account.ts:71
A URL pointing to the logo of the business providing this membership.
providerWebsite?
optionalproviderWebsite?:string
Defined in: src/resources/account.ts:76
The URL of the website for the business providing this membership.
tier
tier:
number
Defined in: src/resources/account.ts:26
The "tier" of the membership plan. Partners are allowed to restrict services to members with higher tiers.
TODO: Define the values.