Interface: IPlan

A plan that a subscriber can sign-up for. It includes a set of features and branding

Hierarchy

• IPlan

Index

Properties

• connectedPlans

• description

• features

• id

• imageUrl

• merchant

• name

• operators

• ownerId

• token

• transactions

Properties

connectedPlans

• connectedPlans: IConnectedPlan[]

plans that are connected to this one

Optional description

• description? : undefined | string

a description of the plan

features

• features: IFeature[]

a list of features included with the plan

Optional id

• id? : undefined | string

a unique identifier set by Tepui when the plan is created

Optional imageUrl

• imageUrl? : undefined | string

a url to an image and shown in plan cards

merchant

• merchant: string

a merchant address used to send any withdrawals

name

• name: string

the name of the plan shown to the subscriber

operators

• operators: IOperator[]

A list of operators that can invoke operations like subscribe, cancel, and token transfers.

ownerId

• ownerId: string

the owner address that is authorized to make withdrawals and other changes

token

• token: string

the token used to price this plan. For example: ETH, USDC, USDT

transactions

• transactions: string[]

a list of transactions for contract deployments