function MCAPI::getAccountDetails in Mailchimp 6.2

Same name and namespace in other branches

1. 7 MCAPI.class.php \MCAPI::getAccountDetails()

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

@returnf string username The Account username @returnf string user_id The Account user unique id (for building some links) @returnf bool is_trial Whether the Account is in Trial mode (can only send campaigns to less than 100 emails) @returnf string timezone The timezone for the Account - default is "US/Eastern" @returnf string plan_type Plan Type - "monthly", "payasyougo", or "free" @returnf int plan_low <em>only for Monthly plans</em> - the lower tier for list size @returnf int plan_high <em>only for Monthly plans</em> - the upper tier for list size @returnf datetime plan_start_date <em>only for Monthly plans</em> - the start date for a monthly plan @returnf int emails_left <em>only for Free and Pay-as-you-go plans</em> emails credits left for the account @returnf bool pending_monthly Whether the account is finishing Pay As You Go credits before switching to a Monthly plan @returnf datetime first_payment date of first payment @returnf datetime last_payment date of most recent payment @returnf int times_logged_in total number of times the account has been logged into via the web @returnf datetime last_login date/time of last login via the web @returnf string affiliate_link Monkey Rewards link for our Affiliate program @returnf array contact Contact details for the account, including: First & Last name, email, company name, address, phone, and url @returnf array modules Addons installed in the account and the date they were installed. @returnf array orders Order details for the account, include order_id, type, cost, date/time, and any credits applied to the order @returnf array rewards Rewards details for the account including credits & inspections earned, number of referals, referal details, and rewards used

Return value

array containing the details for the account tied to this API Key

File

./MCAPI.class.php, line 1734

Class

MCAPI

Code

function getAccountDetails() {
  $params = array();
  return $this
    ->callServer("getAccountDetails", $params);
}