Account

Get the account behind this API key

Returns billing and plan info for the account: subscription state, plan type, enabled modules, AI quota, locale, and login email.

The account is the user/billing layer (one Cognito identity, one Stripe customer). Profiles are company-scoped and live under the account - see /profiles for that data.

get/account

Request

  • Base URL: https://api.lumabill.ch/v1
  • URL: https://api.lumabill.ch/v1/account
  • Auth: HTTP bearer

Response

Account object

idstring uuid required
emailstring email required

Login email (Cognito identity).

plan_typestring required
subscription_statusstring required
stripe_customer_idstring nullable
stripe_price_idstring nullable
past_due_sincestring date-time nullable
email_preferencesobject
modulesstring[]
ai_quota_limitinteger
ai_quota_usedinteger
ai_quota_reset_atstring date-time nullable
profile_limitinteger
localestring
trial_ends_atstring date-time nullable
last_login_atstring date-time nullable
created_atstring date-time required

Example response

{
  "plan_type": "pro_yearly",
  "subscription_status": "active",
  "email_preferences": {
    "marketing": true
  },
  "modules": [
    "BOOKKEEPING",
    "AI"
  ],
  "profile_limit": 3,
  "locale": "en"
}

Changes

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