Skip to main content
GET
/
product-offerings
{
  "items": [
    {
      "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": {}
    }
  ],
  "pagination": {
    "total": 123,
    "limit": 123,
    "offset": 123,
    "sort": {
      "key": "<string>",
      "direction": "ASC"
    }
  }
}

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

type
enum<string>[]

Filter by product offering type.

category
string[]

Filter by product offering category.

A product category is a sub-type for grouping offerings of the same type.

Typically, product offerings of the same type with the same category allow for switching between them. For upgrading and downgrading subscriptions and licenses, we recommend using their corresponding endpoints though.

customerType
enum<string>

Filter by customer type.

Available options:
CONSUMER,
BUSINESS
includeArchived
boolean
default:false

Whether to include archived product offerings.

promoCode
string

Apply promotional pricing by providing a valid promo code.

limit
integer
default:100

The maximum number of items to return.

Required range: 1 <= x <= 1000
offset
integer
default:0

The number of items to skip before starting to collect the result set.

Required range: x >= 0

Response

A list of product offerings.

items
object[]
pagination
object
I