User

Extends

• User

Properties

avatarUrl?

optional avatarUrl: string;

The user public avatar url

Inherited from

bkper.User.avatarUrl

---

bankConnections?

optional bankConnections: boolean;

True if user already had any bank connection

Inherited from

bkper.User.bankConnections

---

billingAdminEmail?

optional billingAdminEmail: string;

The billing admin email for this user’s billing account

Inherited from

bkper.User.billingAdminEmail

---

billingEnabled?

optional billingEnabled: boolean;

True if billing is enabled for the user

Inherited from

bkper.User.billingEnabled

---

daysLeftInTrial?

optional daysLeftInTrial: number;

How many days left in trial

Inherited from

bkper.User.daysLeftInTrial

---

email?

optional email: string;

The user email

Inherited from

bkper.User.email

---

free?

optional free: boolean;

True if user is in the free plan

Inherited from

bkper.User.free

---

fullName?

optional fullName: string;

The user full name

Inherited from

bkper.User.fullName

---

givenName?

optional givenName: string;

The user given name

Inherited from

bkper.User.givenName

---

hash?

optional hash: string;

The user hash

Inherited from

bkper.User.hash

---

hostedDomain?

optional hostedDomain: string;

The user hosted domain

Inherited from

bkper.User.hostedDomain

---

id?

optional id: string;

The user unique id

Inherited from

bkper.User.id

---

name?

optional name: string;

The user display name

Inherited from

bkper.User.name

---

plan?

optional plan: string;

The user plan

Inherited from

bkper.User.plan

---

planOverdue?

optional planOverdue: boolean;

True if subscription payment is overdue

Inherited from

bkper.User.planOverdue

---

startedTrial?

optional startedTrial: boolean;

True if user started trial

Inherited from

bkper.User.startedTrial

---

totalTransactionsThisMonth?

optional totalTransactionsThisMonth: number;

User-level total transactions this month

Inherited from

bkper.User.totalTransactionsThisMonth

---

totalTransactionsThisYear?

optional totalTransactionsThisYear: number;

User-level total transactions this year

Inherited from

bkper.User.totalTransactionsThisYear

---

username?

optional username: string;

The Bkper username of the user

Inherited from

bkper.User.username