Retrieve Account Details

GET https://api.chartmogul.com/v1/account

Returns some useful information about your ChartMogul account.

curl -X GET "https://api.chartmogul.com/v1/account" \
     -u YOUR_API_KEY:

# With include parameter for additional account settings

curl -X GET "https://api.chartmogul.com/v1/account?include=churn_recognition,churn_when_zero_mrr" \
     -u YOUR_API_KEY:

ChartMogul::Account.retrieve

# With include parameter for additional account settings

ChartMogul::Account.retrieve(include: "churn_recognition,churn_when_zero_mrr")

ChartMogul.Account.retrieve(config);

// With include parameter for additional account settings

ChartMogul.Account.retrieve(config, {
  include: "churn_recognition,churn_when_zero_mrr"
});

ChartMogul\Account::retrieve();

// With include parameter for additional account settings

ChartMogul\Account::retrieve(null, ["include" => "churn_recognition,churn_when_zero_mrr"]);

api.RetrieveAccount()

// With include parameter for additional account settings

api.RetrieveAccount(&chartmogul.RetrieveAccountParams{
  Include: "churn_recognition,churn_when_zero_mrr",
})

chartmogul.Account.retrieve(config)

# With include parameter for additional account settings

chartmogul.Account.retrieve(config, include="churn_recognition,churn_when_zero_mrr")

{
  "id": "acc_93b06efd-30f0-2153-890f-709a64cf8292",
  "name": "ChartMogul",
  "currency": "USD",
  "time_zone": "Europe/Berlin",
  "week_start_on": "monday"
}

#<ChartMogul::Account:0x007fb4993f25a0
  @name="ChartMogul",
  @currency="USD",
  @time_zone="Europe/Berlin",
  @week_start_on="monday",
>

{
  id: "acc_93b06efd-30f0-2153-890f-709a64cf8292",
  name: "ChartMogul",
  currency: "USD",
  time_zone: "Europe/Berlin",
  week_start_on: "monday"
}

ChartMogul\Account::__set_state(array(
  "name" => "ChartMogul",
  "currency" => "USD",
  "time_zone" => "Europe/Berlin",
  "week_start_on" => "monday",
));

(*chartmogul.Account)(0xc04203e5a0)({
  Name: (string) (len=10) "ChartMogul",
  Currency: (string) (len=3) "USD",
  TimeZone: (string) (len=13) "Europe/Berlin",
  WeekStartOn: (string) (len=6) "monday",
})

<Account{
  name="ChartMogul",
  currency="USD",
  time_zone="Europe/Berlin",
  week_start_on="sunday",
}>

Query parameters

include string optional: A comma-separated list of additional account settings to include in the response. Valid values are: churn_recognition, churn_when_zero_mrr, auto_churn_subscription, refund_handling, proximate_movement_reclassification.

Response

The response contains the following properties:

id: The UUID of your ChartMogul account with the acc_ prefix, such as acc_93b06efd-30f0-2153-890f-709a64cf8292.
name: The name of your account. Usually, that would be the name of your company.
currency: Your account currency, as an ISO 4217-formatted string. For example, USD or EUR.
time_zone: Canonical time zone name of your account as a TZ identifier, e.g. Europe/Berlin.
week_start_on: First day of the week according to your account; either monday or sunday.

The following fields are only included when requested via the include query parameter:

churn_recognition: The churn recognition setting for your account. Controls when churn is recorded in your reports. Possible values: churn_at_time_of_cancelation, churn_at_period_end, churn_at_click.
churn_when_zero_mrr boolean: The free customer handling setting for your account. Controls whether subscriptions with zero MRR are considered churned.
auto_churn_subscription boolean: The past-due subscription handling setting for your account. Controls automatic churning of past-due subscriptions.
refund_handling: The refund handling setting for your account. Controls whether fully refunded invoices prevent subscription creation or updates. Possible values: refund_ignore, refund_full_only.
proximate_movement_reclassification: The subscription activity reclassification setting for your account. Controls reclassification of upgrades/downgrades that occur within a configured time window. Possible values: reclassification_off, ten_minutes_reclassification, one_hour_reclassification, one_day_reclassification, one_week_reclassification, thirty_days_reclassification, among others.