getBilling

GET

/v5/user/billing

Retrieve the user billing information

Responses

200

A Billing response

object

adminEmail

The billing admin email for the user’s billing account

string

daysLeftInTrial

How many days the user has left in the trial period

integer format: int32

email

The user’s email address

string

enabled

True if billing is enabled for the user

boolean

hostedDomain

The user hosted domain

string

plan

The user’s current plan

string

planOverdue

True if subscription payment is overdue

boolean

startedTrial

True if the user has started the trial period

boolean

totalTransactionsThisMonth

User-level total transactions this month

integer format: int64

totalTransactionsThisYear

User-level total transactions this year

integer format: int64

Example

{
  "adminEmail": "string",
  "daysLeftInTrial": 1,
  "email": "string",
  "enabled": true,
  "hostedDomain": "string",
  "plan": "string",
  "planOverdue": true,
  "startedTrial": true,
  "totalTransactionsThisMonth": 1,
  "totalTransactionsThisYear": 1
}