Interface: IEthPlan

A plan definition used to describe an ethereum plan contract

Hierarchy

• IEthPlan

Index

Properties

• address

• balance

• connectedPlans

• consumed

• features

• id

• merchant

• operators

• owner

• subscriberCount

• token

Properties

Optional address

• address? : undefined | string

the ethereum address for the contract

balance

• balance: string

total holdings in this contract

connectedPlans

• connectedPlans: IEthConnectedPlan[]

a list of connected plans attached to this plan

consumed

• consumed: string

the total amount that has been consumed by all subscribers

features

• features: IEthFeature[]

the list of features and prices for this plan

id

• id: string

a reference to the plan in the tepui registry

merchant

• merchant: string

the address where any withdrawals will be sent

operators

• operators: string[]

a list of addresses that are allowed to perform actions like subscribe, subscriber transfers, consume, and cancel subscriptions. The Tepui operator address should be included to allow the tepui service to process recurring features like monthly fees

owner

• owner: string

an ethereum address for the owner that can make changes and withdraw from this plan contract

subscriberCount

• subscriberCount: string

number of subscribers in this plan

token

• token: string

the ethereum address for the ERC20 token used to price this contract. if the token is the 0x address then the contract is priced in ether