Skip to main content
GET
/
product-offerings
/
{productOfferingId}
{
  "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": {}
}

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.

Path Parameters

​
productOfferingId
string
required

The unique identifier of the product offering.

Query Parameters

​
promoCode
string

Apply promotional pricing by providing a valid promo code.

Response

Product offering details.

A product offering is a product combined with a price that is offered to customers.

​
productOfferingId
string
required

Unique identifier for the product offering.

​
name
string
required

Name of the product offering.

Example:

"Seamless 10GB"

​
price
object
required

Pricing information with discount details.

​
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"

​
description
string

Description of the product offering.

Example:

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

​
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>"

​
productId
string

The unique identifier for the product.

​
product
object

Embedded representation of a product.

​
productOfferingGroupId
string

The unique identifier for the product offering group.

​
group
object

Product offering group information embedded in responses.

​
customerType
enum<string>

The type of customer.

Available options:
CONSUMER,
BUSINESS
​
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.

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.

​
internalDescription
string

Internal description of the product offering for operational use only.

Example:

"seamless_cell_10gb_us"

​
imageUrl
string<uri>

URL to the image representing the product offering.

Example:

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

​
createdAt
string<date-time>

Date and time when the product offering was created.

​
updatedAt
string<date-time>

Date and time when the product offering 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.

⌘I