Skip to content

Mercury: Organization schemas

3 Mercury schemas with complete fields and constraints.

← Organization operations · All schemas

Get organization information — response body

FieldTypePresenceDescription and constraints
$objectRootResponse containing organization details.
organizationJSONRequired within parent
organization (allOf 1)ModelAll variants applyExpand Get organization information — response body — organization Organization information
organization (allOf 2)JSONAll variants applyOrganization information

Referenced models: Get organization information — response body — organization Organization information

Get organization information — response body — organization Organization information

FieldTypePresenceDescription and constraints
$objectRootOrganization information
billingCadenceJSONRequired within parent
billingCadence (allOf 1)stringAll variants applyKnown values: monthly, annual
billingCadence (allOf 2)JSONAll variants applyHow often the organization is billed for its current subscription.
Always "monthly" when the tier is "free".
dbasarrayRequired within parentList of DBAs (Doing Business As names) for this organization
dbas[]ModelEach itemExpand Get organization information — response body — organization Organization information dbas item
einJSONOptional
ein (anyOf 1)stringAlternativeEmployer Identification Number (EIN), if available
ein (anyOf 2)nullAlternative
idJSONRequired within parent
id (allOf 1)stringAll variants applyFormat: uuid
id (allOf 2)JSONAll variants applyUnique identifier for the organization
kindJSONRequired within parent
kind (allOf 1)stringAll variants applyKnown values: personal, business
kind (allOf 2)JSONAll variants applyWhether this is a personal or business organization
legalBusinessNamestringRequired within parentLegal business name as registered
subscriptionTierJSONRequired within parent
subscriptionTier (allOf 1)stringAll variants applyKnown values: free, plus, premium, pro, enterprise
subscriptionTier (allOf 2)JSONAll variants applyThe Mercury subscription tier this organization is currently on.
Reports "free" when the organization has no paid subscription.

Referenced models: Get organization information — response body — organization Organization information dbas item

Get organization information — response body — organization Organization information dbas item

FieldTypePresenceDescription and constraints
$objectRootDBA (Doing Business As) information
dbaIsDefaultbooleanRequired within parentWhether this DBA is set as the default for payments
dbaNamestringRequired within parentThe DBA name

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.