Skip to main content
GET
/
product-offerings
List product offerings
curl --request GET \
  --url https://apiv2.example.com/product-offerings \
  --header 'X-Api-Key: <api-key>'
{
  "items": [
    {
      "productOfferingId": "<string>",
      "status": "AVAILABLE",
      "name": "Seamless 10GB",
      "price": {
        "currency": "USD",
        "priceType": "ONE_TIME",
        "discount": 5,
        "netPrice": 5,
        "boundMonths": 12,
        "billingCycle": {
          "period": "MONTHLY",
          "interval": 1
        }
      },
      "customerType": "CONSUMER",
      "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>",
      "product": {
        "productId": "<string>",
        "internalName": "<string>",
        "type": "SUBSCRIPTION",
        "category": "SUBSCRIPTION_CELL",
        "networkProviderId": "tmobile-us",
        "features": {
          "dataMb": 2048,
          "includedCallSeconds": 1000,
          "includedSms": 500
        }
      },
      "group": {
        "productOfferingGroupId": "mobile-plans",
        "name": "Mobile Plans",
        "category": "SUBSCRIPTION_CELL",
        "description": "Bundled cell subscriptions with unlimited calls and SMS with ILD enabled.",
        "internalDescription": "Core mobile offerings targeting consumer and business segments"
      },
      "addonCategories": [
        "SUBSCRIPTION_CELL"
      ],
      "internalDescription": "seamless_cell_10gb_us",
      "imageUrl": "https://cdn.example.com/images/mobile-basic.png",
      "metadata": {}
    }
  ],
  "pagination": {
    "nextCursor": "<string>"
  }
}

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

​
types
enum<string>[]

Filter by product offering types.

The type of product offering.

The type of the product offering determines how it can be used and how to create identifier.

  • SUBSCRIPTION: A subscription product offering. Can be used to create subscriptions, either via order or directly depending on configuration.
  • SUBSCRIPTION_ADDON: A subscription addon product offering. Can be added to existing subscriptions as an addon, either via order or directly depending on configuration.
  • LICENSE: A license product offering. Can be used to create licenses, either via order or directly depending on configuration.
  • EXTERNAL_PRODUCT: An external product offering representing purchasable items outside of our core platform. Can only be ordered via orders, not directly.
Available options:
SUBSCRIPTION,
SUBSCRIPTION_ADDON,
LICENSE,
EXTERNAL_PRODUCT
​
categories
string[]

Filter by product offering categories.

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>
required

Filter by customer type. The type of customer.

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
​
cursor
string

Opaque pagination token from a previous response's nextCursor.

Response

A list of product offerings.

​
items
object[]
required
​
pagination
object
required