« Back to Documentation Overview

getAccountDetails – v1.2

 getAccountDetails(string apikey)

Retrieve lots of account information including payments made, plan info, some account stats, installed modules, contact info, and more. No private information like Credit Card numbers is available.

Section
Helper
Parameters
apikey a valid API Key for your user account. Get by visiting your API dashboard
Returns
array containing the details for the account tied to this API Key
Returned Fields
stringusernameThe Account username
stringuser_idThe Account user unique id (for building some links)
boolis_trialWhether the Account is in Trial mode (can only send campaigns to less than 100 emails)
stringtimezoneThe timezone for the Account - default is "US/Eastern"
stringplan_typePlan Type - "monthly", "payasyougo", or "free"
intplan_lowonly for Monthly plans - the lower tier for list size
intplan_highonly for Monthly plans - the upper tier for list size
stringplan_start_dateonly for Monthly plans - the start date for a monthly plan
intemails_leftonly for Free and Pay-as-you-go plans emails credits left for the account
boolpending_monthlyWhether the account is finishing Pay As You Go credits before switching to a Monthly plan
stringfirst_paymentdate of first payment
stringlast_paymentdate of most recent payment
inttimes_logged_intotal number of times the account has been logged into via the web
stringlast_logindate/time of last login via the web
stringaffiliate_linkMonkey Rewards link for our Affiliate program
arraycontactContact details for the account
stringfnameFirst Name
stringlnameLast Name
stringemailEmail Address
stringcompanyCompany Name
stringaddress1Address Line 1
stringaddress2Address Line 2
stringcityCity
stringstateState or Province
stringzipZip or Postal Code
stringcountryCountry name
stringurlWebsite URL
stringphonePhone number
stringfaxFax number
arraymodulesAddons installed in the account
stringnameThe module name
stringaddedThe date the module was added
arrayordersOrder details for the account
intorder_idThe order id
stringtypeThe order type - either "monthly" or "credits"
doubleamountThe order amount
stringdateThe order date
doublecredits_usedThe total credits used
arrayrewardsRewards details for the account including credits & inspections earned, number of referals, referal details, and rewards used
intreferrals_this_monththe total number of referrals this month
stringnotify_onwhether or not we notify the user when rewards are earned
stringnotify_emailthe email address address used for rewards notifications
arraycreditsEmail credits earned "this_month", "total_earned", and "remaining"
arrayinspectionsInbox Inspections earned "this_month", "total_earned", and "remaining"
arrayreferralsAll referrals, including "name", "email", "signup_date", and "type"
arrayappliedApplied rewards, including "value", "date", "order_id", and "order_desc"