Mercury: Organization schemas
3 Mercury schemas with complete fields and constraints.
← Organization operations · All schemas
Get organization information — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response containing organization details. |
organization | JSON | Required within parent | |
organization (allOf 1) | Model | All variants apply | Expand Get organization information — response body — organization Organization information |
organization (allOf 2) | JSON | All variants apply | Organization information |
Referenced models: Get organization information — response body — organization Organization information
Get organization information — response body — organization Organization information
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Organization information |
billingCadence | JSON | Required within parent | |
billingCadence (allOf 1) | string | All variants apply | Known values: monthly, annual |
billingCadence (allOf 2) | JSON | All variants apply | How often the organization is billed for its current subscription. Always "monthly" when the tier is "free". |
dbas | array | Required within parent | List of DBAs (Doing Business As names) for this organization |
dbas[] | Model | Each item | Expand Get organization information — response body — organization Organization information dbas item |
ein | JSON | Optional | |
ein (anyOf 1) | string | Alternative | Employer Identification Number (EIN), if available |
ein (anyOf 2) | null | Alternative | |
id | JSON | Required within parent | |
id (allOf 1) | string | All variants apply | Format: uuid |
id (allOf 2) | JSON | All variants apply | Unique identifier for the organization |
kind | JSON | Required within parent | |
kind (allOf 1) | string | All variants apply | Known values: personal, business |
kind (allOf 2) | JSON | All variants apply | Whether this is a personal or business organization |
legalBusinessName | string | Required within parent | Legal business name as registered |
subscriptionTier | JSON | Required within parent | |
subscriptionTier (allOf 1) | string | All variants apply | Known values: free, plus, premium, pro, enterprise |
subscriptionTier (allOf 2) | JSON | All variants apply | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | DBA (Doing Business As) information |
dbaIsDefault | boolean | Required within parent | Whether this DBA is set as the default for payments |
dbaName | string | Required within parent | The DBA name |