# DID Group Object

DID Group Object attributes and meta attributes.

Meta attributes are not available through [includes](../../../specification/includes.html#api-includes).

Note

In version `2026-11-19`, the `number_type` attribute replaces the `did_group_type`
relationship. Requests that include `did_group_type`, filter by `did_group_type.id`, sort
by `did_group_type.name`, or request `did_group_type` in sparse fieldsets return
`400 Bad Request`.

## Attributes

| Name | Type | Description |
| --- | --- | --- |
| area\_name | `string` | DID Group area name. This will be the name of the city, or a designation applicable to the area code such as **National**. |
| prefix | `string` | DID Group prefix (city or area calling code). |
| features | Array of `strings` | Features available for the DID Group. Supported values are `voice_in`, `voice_out`, `t38`, `sms_in`, `p2p`, `a2p`, `emergency`, and `cnam_out`. A DID Group may have multiple features. |
| is\_metered | `boolean` | Defines if the DID Group supports metered services (per-minute billing). |
| allow\_additional\_channels | `boolean` | Defines if channel capacity may be added to this DID Group. |
| service\_restrictions | `string` or `null` | Service restrictions message for the DID Group, if any restrictions apply. |
| number\_type | `string` | Number type offered by the DID Group. Possible values are `local`, `national`, `mobile`, `toll_free`, `shared_cost`, and `global`. |
| is\_demo | `boolean` | Defines if the DID Group is flagged as a demo group. |

## Meta Attributes

| Name | Type | Description |
| --- | --- | --- |
| needs\_registration | `boolean` | Defines if end-user registration is required for this DID Group. |
| is\_available | `boolean` | Defines if numbers in this DID Group are currently in stock. |
| available\_dids\_enabled | `boolean` | Defines if the DID Group supports numbers selection feature. |
| total\_count | `integer` | Defines current stock available. |

## Relationships

| Name | Type | Description |
| --- | --- | --- |
| country | to-one | [Country Object](../countries/country-object.html#country-object-v35). Returns the country assigned to the DID Group. |
| region | to-one | [Region Object](../regions/region-object.html#region-object-v35). Returns the region assigned to the DID Group. |
| city | to-one | [City Object](../city/city-object.html#city-object-v35). Returns the city assigned to the DID Group. |
| stock\_keeping\_units | to-many | A list of [Stock Keeping Unit Objects](../../common-definitions/index.html#stock-keeping-unit-object-v35) returned for the DID Group. |
| address\_requirement | to-one | [Address Requirement Object](../../regulation-resources/requirements/address-requirement-object.html#address-requirement-object-v35). Returns the address requirement assigned to the DID Group. |
