Skip to main content
GET
/
product-catalogs
/
default
{
  "productCatalogId": "<string>",
  "name": "US Consumer Catalog",
  "external_reference": "us-consumer-2025",
  "description": "Product catalog for US consumer customers",
  "ProductOfferingGroups": [
    {
      "productOfferingGroupId": "mobile-plans",
      "name": "Mobile Plans",
      "description": "Bundled cell subscriptions with unlimited calls and SMS with ILD enabled.",
      "category": "SUBSCRIPTION_CELL",
      "internalDescription": "Core mobile offerings targeting consumer and business segments"
    }
  ],
  "productOfferings": [
    {
      "productOfferingId": "<string>",
      "status": "AVAILABLE",
      "name": "Seamless 10GB",
      "description": "Basic mobile plan with 5GB data and unlimited calls",
      "richContent": "<h3>Features</h3><ul><li>5GB monthly data</li><li>Unlimited calls & texts</li><li>No setup fees</li></ul>",
      "productId": "<string>",
      "product": {
        "productId": "<string>",
        "internalName": "<string>",
        "type": "SUBSCRIPTION",
        "category": "SUBSCRIPTION_CELL",
        "networkProviderId": "tmobile-us",
        "features": {
          "dataMb": 2048,
          "includedCallSeconds": 1000,
          "includedSms": 500
        },
        "requirements": {
          "subscriber.address": "VERIFIED"
        }
      },
      "price": {
        "grossPrice": 10,
        "discount": 5,
        "netPrice": 5,
        "currency": "USD",
        "priceType": "ONE_TIME",
        "boundMonths": 12,
        "billingCycle": {
          "period": "MONTHLY",
          "interval": 1
        },
        "taxIncluded": true
      },
      "productOfferingGroupId": "<string>",
      "group": {
        "productOfferingGroupId": "<string>",
        "name": "<string>",
        "category": "SUBSCRIPTION_CELL"
      },
      "customerType": "CONSUMER",
      "addonCategories": [
        "SUBSCRIPTION_CELL"
      ],
      "internalDescription": "seamless_cell_10gb_us",
      "imageUrl": "https://cdn.example.com/images/mobile-basic.png",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "metadata": {}
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "metadata": {},
  "customerType": "CONSUMER"
}

Authorizations

​
X-API-Key
string
header
required

An API key that grants access to the Connect API. You can create and manage API keys in the portal.

Query Parameters

​
promoCode
string

Apply promotional pricing by providing a valid promo code.

Response

Default product catalog.

A product catalog contains all available product offerings and groups for a specific context.

Product catalogs are used to selectively expose product offerings for different customer bases, regions, or sales channels.

​
productCatalogId
string
required

Unique identifier for the product catalog.

​
name
string
required

Name of the product catalog.

Example:

"US Consumer Catalog"

​
productOfferings
object[]
required

The product offerings available in this catalog.

​
external_reference
string

External reference for the product catalog. This ID should be used by external parties to reference the catalog.

Example:

"us-consumer-2025"

​
description
string

Description of the product catalog.

Example:

"Product catalog for US consumer customers"

​
ProductOfferingGroups
object[]

The product groups in this catalog.

​
createdAt
string<date-time>

Date and time when the product catalog was created.

​
updatedAt
string<date-time>

Date and time when the product catalog was last updated.

​
metadata
object

A set of key-value pairs that can be attached to an object for storing additional information in a semi-structured format.

​
customerType
enum<string>

The type of customer.

Available options:
CONSUMER,
BUSINESS
⌘I