Subscription.md

@elfo/sdk / Exports / Subscription

Class: Subscription

Represents a subscription account

Table of contents

Properties

• cancellationReason
• hasAlreadyBeenInitialized
• isActive
• isCancelled
• lastPaymentTimestamp
• nextPaymentTimestamp
• publicKey
• subscriber
• subscriptionPlan

Methods

• address
• from

Properties

cancellationReason

• cancellationReason: number

---

hasAlreadyBeenInitialized

• hasAlreadyBeenInitialized: boolean

---

isActive

• isActive: boolean

---

isCancelled

• isCancelled: boolean

---

lastPaymentTimestamp

• lastPaymentTimestamp: number

---

nextPaymentTimestamp

• nextPaymentTimestamp: number

---

publicKey

• publicKey: string

---

subscriber

• subscriber: string

---

subscriptionPlan

• subscriptionPlan: string

Methods

address

▸ Static address(subscriber, subscriptionPlan): string

Helper function to generate subscription PDA Address

Parameters

Name	Type	Description
subscriber	string	Public Key of subscriber state account
subscriptionPlan	string	Public Key of the subscription plan

Returns

string

PDA of the subscription account

---

from

▸ Static from(subscriptionPublicKey, provider): Promise<Subscription>

Fetches a subscription instance from a public key

Parameters

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

Returns

Promise<Subscription>