Common Definitions#

Common Definitions describe embedded objects that are referenced by DIDWW API resource documentation.

These objects are not standalone API endpoints. They appear inside responses from other resources and are used to describe reusable or separately documented data structures, such as inventory pricing and capacity pricing tiers.

Some definitions may be used by multiple resources. Others are documented here because they are referenced as embedded objects from a resource relationship.

Common Definitions should not be used for endpoint-specific request attributes. Request schemas such as did_order_items and capacity_order_items are documented in the Orders section.

Definitions#

Stock Keeping Unit Object

A Stock Keeping Unit Object describes an inventory unit that can be selected when ordering DID phone numbers or related services.

In DID ordering flows, retrieve Stock Keeping Unit objects from inventory resources such as DID Groups or Available DIDs, then use the selected Stock Keeping Unit id as sku_id when creating an order.

Attributes

Name	Type	Description
`setup_price`	`string`	Price for order creation.
`monthly_price`	`string`	Monthly price for order renewal.
`channels_included_count`	`integer`	Included channel capacity for each DID.

Example

{
  "id": "e2406add-fd8a-475c-b959-81e9619d7a4b",
  "type": "stock_keeping_units",
  "attributes": {
    "setup_price": "4.00",
    "monthly_price": "4.00",
    "channels_included_count": 2
  }
}

Common usage

Used with	Purpose
DID Groups	Returned as related SKU options for DID ordering and pricing.
Available DIDs	May be returned through included DID Group SKU data when selecting a specific DID phone number.
Orders	The selected Stock Keeping Unit `id` is sent as `sku_id` in `did_order_items`.

Note

channels_included_count is part of the Stock Keeping Unit Object. It describes the included channel capacity for each DID when that SKU is selected.

It is not sent directly in the Create Order request. To order a DID phone number with a specific included channel option, select the matching Stock Keeping Unit and send its id as sku_id.

Channel Quantity Based Price Object

A Channel Quantity Based Price Object describes quantity-based pricing tiers for channels in a Capacity Pool.

In the API documentation, this object is referenced by the Capacity Pool Object through the qty_based_pricings relationship.

It is not a standalone endpoint and it is not sent directly in POST /v3/orders.

Attributes

Name	Type	Description
`setup_price`	`string`	Price for order creation per channel.
`monthly_price`	`string`	Monthly price for order renewal based on the Capacity Pool billing cycle date, also known as `renew_date`.
`qty`	`integer`	Quantity of channels from which the price per channel applies with a discount.

Example

{
  "setup_price": "0.00",
  "monthly_price": "1.50",
  "qty": 10
}

Common usage

Used with	Purpose
Capacity Pool Object	Returned through the `qty_based_pricings` relationship to describe quantity-based pricing tiers for the Capacity Pool.

Note

This object describes pricing tiers returned for a Capacity Pool.

Capacity orders are created separately with POST /v3/orders using capacity_order_items.

The capacity order request uses attributes such as capacity_pool_id and qty. It does not send the Channel Quantity Based Price Object.

A capacity order item uses request attributes such as:

Name	Type	Required	Description
`capacity_pool_id`	`string`	Yes	Capacity Pool ID.
`qty`	`integer`	No	Quantity of channels to order.

When to use these definitions#

Use these definitions when reading API responses that include the documented embedded objects.

Definition	Commonly used with
`Stock Keeping Unit Object`	DID Groups, Available DIDs, and DID order preparation.
`Channel Quantity Based Price Object`	Capacity Pool Object only. Returned through the `qty_based_pricings` relationship to describe quantity-based pricing tiers for the Capacity Pool.

Common Definitions#

Definitions#

When to use these definitions#

Related resources#