Account

Plan limits, subscription dates, meters and forecast

Read-only overview of the account: plan and its limits, subscription status, trial allowance and end, current billing period end and any scheduled cancellation, this month's scheduled and on-demand check meters (a check is one keyword × location × device × source search), and the forecast of scheduled checks at the current configuration. Usage months are UTC. Plan changes, checkout and payment methods are only available to the owner in the app.

get/account/overview

Request

  • Base URL: https://adslighthouse.com/api/v1
  • URL: https://adslighthouse.com/api/v1/account/overview
  • Auth: HTTP bearer

Response

Plan limits, subscription dates, meters and forecast

account_idstring required
labelstring required
your_role'owner' | 'admin' | 'member' required
can_change_plan_in_appboolean required

Only the owner can change the plan, in Settings > Billing. Not available through the API.

status'preview' | 'trialing' | 'active' | 'past_due' | 'canceled' | 'unpaid' | 'paused' | 'incomplete' | 'incomplete_expired' required

Subscription status.

usage_periodstring required

Usage month, YYYY-MM in UTC. Allowances reset each month.

request_idstring

Changes

No recorded changes to this operation across all 1 revision of this API.