Skip to content
Bkper
Sign in with Google

getBilling

GET
/v5/user/billing

Retrieve the user billing information

Authorizations

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
transactionsAverage

Authoritative rounded-up rolling monthly average of posted transactions for the current plan

integer format: int64
transactionsCapacity

Confirmed average monthly transaction capacity for the current plan

integer format: int64

Examples 

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

default

An error response from the Bkper API or its public API proxy.

A JSON error response. API operation errors use the nested error object. Public API proxy errors use the Problem Details fields.

object
error
object
errors
Array<object>
object
domain
string
reason
string
message
string
code
required
integer format: int32
message
required
string
type
string
title
string
status
integer format: int32
detail
string
instance
string
code
string