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.
Signature
public function getAccountDetails([array
$exclude = ] )
Parameters
$exclude
—
array
optional defaults to nothing for backwards compatibility. Allows controlling which extra arrays are returned since they can slow down calls. Valid keys are "modules", "orders", "rewards-credits", "rewards-inspections", "rewards-referrals", and "rewards-applied". Hint: "rewards-referrals" is typically the culprit. To avoid confusion, if data is excluded, the corresponding key <strong>will not be returned at all</strong>.
Returns
array
containing the details for the account tied to this API Key string username The Account username
string user_id The Account user unique id (for building some links)
bool is_trial Whether the Account is in Trial mode (can only send campaigns to less than 100 emails)
bool is_approved Whether the Account has been approved for purchases
bool has_activated Whether the Account has been activated
string timezone The timezone for the Account - default is "US/Eastern"
string plan_type Plan Type - "monthly", "payasyougo", or "free"
int plan_low <em>only for Monthly plans</em> - the lower tier for list size
int plan_high <em>only for Monthly plans</em> - the upper tier for list size
string plan_start_date <em>only for Monthly plans</em> - the start date for a monthly plan
int emails_left <em>only for Free and Pay-as-you-go plans</em> emails credits left for the account
bool pending_monthly Whether the account is finishing Pay As You Go credits before switching to a Monthly plan
string first_payment date of first payment
string last_payment date of most recent payment
int times_logged_in total number of times the account has been logged into via the web
string last_login date/time of last login via the web
string affiliate_link Monkey Rewards link for our Affiliate program
array contact Contact details for the account
string fname First Name
string lname Last Name
string email Email Address
string company Company Name
string address1 Address Line 1
string address2 Address Line 2
string city City
string state State or Province
string zip Zip or Postal Code
string country Country name
string url Website URL
string phone Phone number
string fax Fax number
array modules Addons installed in the account
string id An internal module id
string name The module name
string added The date the module was added
array data Any extra data associated with this module as key=>value pairs
array orders Order details for the account
int order_id The order id
string type The order type - either "monthly" or "credits"
double amount The order amount
string date The order date
double credits_used The total credits used
array rewards Rewards details for the account including credits & inspections earned, number of referals, referal details, and rewards used
int referrals_this_month the total number of referrals this month
string notify_on whether or not we notify the user when rewards are earned
string notify_email the email address address used for rewards notifications
array credits Email credits earned:
int this_month credits earned this month
int total_earned credits earned all time
int remaining credits remaining
array inspections Inbox Inspections earned:
int this_month credits earned this month
int total_earned credits earned all time
int remaining credits remaining
array referrals All referrals, including:
string name the name of the account
string email the email address associated with the account
string signup_date the signup date for the account
string type the source for the referral
array applied Applied rewards, including:
int value the number of credits user
string date the date appplied
int order_id the order number credits were applied to
string order_desc the order description