# User

## Extends

- `User`

### avatarUrl?

```ts
optional avatarUrl: string;
```

The user public avatar url

#### Inherited from

```ts
bkper.User.avatarUrl
```

***

### bankConnections?

```ts
optional bankConnections: boolean;
```

True if user already had any bank connection

#### Inherited from

```ts
bkper.User.bankConnections
```

***

### billingAdminEmail?

```ts
optional billingAdminEmail: string;
```

The billing admin email for this user's billing account

#### Inherited from

```ts
bkper.User.billingAdminEmail
```

***

### billingEnabled?

```ts
optional billingEnabled: boolean;
```

True if billing is enabled for the user

#### Inherited from

```ts
bkper.User.billingEnabled
```

***

### daysLeftInTrial?

```ts
optional daysLeftInTrial: number;
```

How many days left in trial

#### Inherited from

```ts
bkper.User.daysLeftInTrial
```

***

### domain?

```ts
optional domain: Domain;
```

#### Inherited from

```ts
bkper.User.domain
```

***

### email?

```ts
optional email: string;
```

The user email

#### Inherited from

```ts
bkper.User.email
```

***

### free?

```ts
optional free: boolean;
```

True if user is in the free plan

#### Inherited from

```ts
bkper.User.free
```

***

### fullName?

```ts
optional fullName: string;
```

The user full name

#### Inherited from

```ts
bkper.User.fullName
```

***

### givenName?

```ts
optional givenName: string;
```

The user given name

#### Inherited from

```ts
bkper.User.givenName
```

***

### hash?

```ts
optional hash: string;
```

The user hash

#### Inherited from

```ts
bkper.User.hash
```

***

### hostedDomain?

```ts
optional hostedDomain: string;
```

The user hosted domain

#### Inherited from

```ts
bkper.User.hostedDomain
```

***

### id?

```ts
optional id: string;
```

The user unique id

#### Inherited from

```ts
bkper.User.id
```

***

### name?

```ts
optional name: string;
```

The user display name

#### Inherited from

```ts
bkper.User.name
```

***

### plan?

```ts
optional plan: string;
```

The user plan

#### Inherited from

```ts
bkper.User.plan
```

***

### planCycle?

```ts
optional planCycle: "MONTHLY" | "YEARLY";
```

The user plan billing cycle

#### Inherited from

```ts
bkper.User.planCycle
```

***

### planOverdue?

```ts
optional planOverdue: boolean;
```

True if subscription payment is overdue

#### Inherited from

```ts
bkper.User.planOverdue
```

***

### startedTrial?

```ts
optional startedTrial: boolean;
```

True if user started trial

#### Inherited from

```ts
bkper.User.startedTrial
```

***

### totalTransactionsThisMonth?

```ts
optional totalTransactionsThisMonth: number;
```

User-level total transactions this month

#### Inherited from

```ts
bkper.User.totalTransactionsThisMonth
```

***

### totalTransactionsThisYear?

```ts
optional totalTransactionsThisYear: number;
```

User-level total transactions this year

#### Inherited from

```ts
bkper.User.totalTransactionsThisYear
```

***

### username?

```ts
optional username: string;
```

The Bkper username of the user

#### Inherited from

```ts
bkper.User.username
```