List product offerings

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.

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.
SUBSCRIPTION_TOPUP: A subscription top-up product offering. Can be added to existing subscriptions as a top-up, 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,

SUBSCRIPTION_TOPUP,

LICENSE,

EXTERNAL_PRODUCT

Response

A list of product offerings.

items

object[]

Show child attributes

items.productOfferingId

string

required

Unique identifier for the product offering.

items.name

string

required

Name of the product offering.

Example:

"Seamless 10GB"

items.price

object

required

Pricing information with discount details.

Show child attributes

items.price.currency

string

required

The currency code.

Example:

"USD"

items.price.discount

number<decimal>

default:5

The discount amount from the original price.

items.price.netPrice

number<decimal>

The final cost after all discounts are applied.

Example:

5

items.price.priceType

enum<string>

The type of pricing model applied to the product offering.

Available options:

ONE_TIME,

RECURRING

items.price.boundMonths

integer

The number of months the price is bound to (for recurring prices).

Example:

12

items.price.billingCycle

object

The billing cycle for recurring prices.

Show child attributes

items.price.billingCycle.period

enum<string>

The billing period.

Available options:

MONTHLY

items.price.billingCycle.interval

integer

The interval of the billing period.

Example:

1

items.status

enum<string>

The status of the product offering.

Archived offerings are not allowed to be created/ordered by customers, but can still be used for existing subscriptions.

Available options:

AVAILABLE,

ARCHIVED

Example:

"AVAILABLE"

items.description

string

Description of the product offering.

Example:

"Basic mobile plan with 5GB data and unlimited calls"

items.richContent

string

Rich HTML content with detailed information about the product offering.

Example:

"<h3>Features</h3><ul><li>5GB monthly data</li><li>Unlimited calls & texts</li><li>No setup fees</li></ul>"

items.productId

string

The unique identifier for the product.

items.product

object

Embedded representation of a product.

Show child attributes

items.product.productId

string

required

The unique identifier for the product.

items.product.internalName

string

required

The internal name of the product.

items.product.type

enum<string>

required

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.
SUBSCRIPTION_TOPUP: A subscription top-up product offering. Can be added to existing subscriptions as a top-up, 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,

SUBSCRIPTION_TOPUP,

LICENSE,

EXTERNAL_PRODUCT

items.product.category

string

required

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

Example:

"SUBSCRIPTION_CELL"

items.product.networkProviderId

string

The unique identifier for the network provider.

Example:

"tmobile-us"

items.product.features

object

The features included with the product, if any. Typically used for telecom products.

Show child attributes

items.product.features.dataMb

number

Megabytes of data included with the product, if any.

Example:

2048

items.product.features.includedCallSeconds

integer

Outbound call minutes included with the product, if any.

Example:

1000

items.product.features.includedSms

integer

Number of SMS messages included with the product, if any.

Example:

500

items.product.requirements

object

Information that may or must be collected from the user before purchasing the product, if any.

Typically varies between product types, regions, and customer types.

Treat these as in addition to already required fields on the entity being created (e.g., subscriptions typically require a subscriber name).

Show child attributes

items.product.requirements.{key}

enum<string>

Whether the requirement is optional or required.

'OPTIONAL': The requirement is optional, may be collected if available.
'REQUIRED': The requirement is required, must be collected.
'VERIFIED': The requirement is required and must be verified (e.g., by validating the address beforehand) where strict validation applies.

Available options:

OPTIONAL,

REQUIRED,

VERIFIED

Example:

{ "subscriber.address": "VERIFIED" }

items.productOfferingGroupId

string

The unique identifier for the product offering group.

items.group

object

Product offering group information embedded in responses.

Show child attributes

items.group.productOfferingGroupId

string

required

The unique identifier for the product offering group.

items.group.name

string

required

The name of the product offering group.

items.group.category

string

required

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

Example:

"SUBSCRIPTION_CELL"

items.customerType

enum<string>

The type of customer.

Available options:

CONSUMER,

BUSINESS

items.addonCategories

string[]

List of product categories this addon is applicable for. Only populated when type is ADDON.

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

items.internalDescription

string

Internal description of the product offering for operational use only.

Example:

"seamless_cell_10gb_us"

items.imageUrl

string<uri>

URL to the image representing the product offering.

Example:

"https://cdn.example.com/images/mobile-basic.png"

items.createdAt

string<date-time>

Date and time when the product offering was created.

items.updatedAt

string<date-time>

Date and time when the product offering was last updated.

items.metadata

object

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

Show child attributes

items.metadata.{key}

string

pagination

object

Show child attributes

pagination.total

integer

The total number of items available.

pagination.limit

integer

The maximum number of items to return.

pagination.offset

integer

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

pagination.sort

object

The sorting criteria.

Show child attributes

pagination.sort.key

string

The key to sort by.

pagination.sort.direction

enum<string>

The direction to sort by.

Available options:

ASC,

DESC

Getting started

Overview

API reference

Authorizations

Query Parameters

Response