SubscriptionPlan.md

@elfo/sdk / Exports / SubscriptionPlan

Class: SubscriptionPlan

Represents a subscription plan

Table of contents

Properties

• amount
• feePercentage
• frequency
• hasAlreadyBeenInitialized
• isActive
• planName
• publicKey
• subscriptionAccounts
• subscriptionPlanAuthor
• subscriptionPlanPaymentAccount

Methods

• address
• from

Properties

amount

• amount: BN

---

feePercentage

• feePercentage: number

---

frequency

• frequency: BN

---

hasAlreadyBeenInitialized

• hasAlreadyBeenInitialized: boolean

---

isActive

• isActive: boolean

---

planName

• planName: string

---

publicKey

• publicKey: string

---

subscriptionAccounts

• subscriptionAccounts: string[]

---

subscriptionPlanAuthor

• subscriptionPlanAuthor: string

---

subscriptionPlanPaymentAccount

• subscriptionPlanPaymentAccount: string

Methods

address

▸ Static address(planName, planAuthor): string

Helper function to generate subscription plan PDA Address

Parameters

Name	Type	Description
planName	string	subscription plan name
planAuthor	string	subscription plan author account address

Returns

string

PDA of the subscription plan account

---

from

▸ Static from(subscriptionPlanPublicKey, provider): Promise<SubscriptionPlan>

Fetches a subscription plan instance from a public key

Parameters

Name	Type	Description
subscriptionPlanPublicKey	string	Public key of the subscription
provider	default	Anchor connection provider

Returns

Promise<SubscriptionPlan>