Getting started
API reference
A valid request URL is required to generate request examples{
"productCatalogId": "<string>",
"name": "US Consumer Catalog",
"productOfferings": [
{
"productOfferingId": "<string>",
"name": "Seamless 10GB",
"price": {
"currency": "USD",
"discount": 5,
"netPrice": 5,
"priceType": "ONE_TIME",
"boundMonths": 12,
"billingCycle": {
"period": "MONTHLY",
"interval": 1
}
},
"status": "AVAILABLE",
"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"
}
},
"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": {}
}
],
"external_reference": "us-consumer-2025",
"description": "Product catalog for US consumer customers",
"ProductOfferingGroups": [
{
"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"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"metadata": {},
"customerType": "CONSUMER"
}Get default product catalog
Get the default product catalog for the current customer context.
Returns the catalog that applies to the customer’s type and locale.
A valid request URL is required to generate request examples{
"productCatalogId": "<string>",
"name": "US Consumer Catalog",
"productOfferings": [
{
"productOfferingId": "<string>",
"name": "Seamless 10GB",
"price": {
"currency": "USD",
"discount": 5,
"netPrice": 5,
"priceType": "ONE_TIME",
"boundMonths": 12,
"billingCycle": {
"period": "MONTHLY",
"interval": 1
}
},
"status": "AVAILABLE",
"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"
}
},
"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": {}
}
],
"external_reference": "us-consumer-2025",
"description": "Product catalog for US consumer customers",
"ProductOfferingGroups": [
{
"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"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"metadata": {},
"customerType": "CONSUMER"
}Authorizations
An API key that grants access to the Connect API. You can create and manage API keys in the portal.
Query Parameters
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.
Unique identifier for the product catalog.
Name of the product catalog.
"US Consumer Catalog"
The product offerings available in this catalog.
Show child attributes
Show child attributes
Unique identifier for the product offering.
Name of the product offering.
"Seamless 10GB"
Pricing information with discount details.
Show child attributes
Show child attributes
The currency code.
"USD"
The discount amount from the original price.
The final cost after all discounts are applied.
5
The type of pricing model applied to the product offering.
ONE_TIME, RECURRING The number of months the price is bound to (for recurring prices).
12
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, ARCHIVED "AVAILABLE"
Description of the product offering.
"Basic mobile plan with 5GB data and unlimited calls"
Rich HTML content with detailed information about the product offering.
"<h3>Features</h3><ul><li>5GB monthly data</li><li>Unlimited calls & texts</li><li>No setup fees</li></ul>"
The unique identifier for the product.
Embedded representation of a product.
Show child attributes
Show child attributes
The unique identifier for the product.
The internal name of the product.
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.
SUBSCRIPTION, SUBSCRIPTION_ADDON, SUBSCRIPTION_TOPUP, LICENSE, EXTERNAL_PRODUCT 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.
"SUBSCRIPTION_CELL"
The unique identifier for the network provider.
"tmobile-us"
The features included with the product, if any. Typically used for telecom products.
Show child attributes
Show child attributes
Megabytes of data included with the product, if any.
2048
Outbound call minutes included with the product, if any.
1000
Number of SMS messages included with the product, if any.
500
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
Show child attributes
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.
OPTIONAL, REQUIRED, VERIFIED { "subscriber.address": "VERIFIED" }The unique identifier for the product offering group.
Product offering group information embedded in responses.
Show child attributes
Show child attributes
The unique identifier for the product offering group.
The name of the product offering group.
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.
"SUBSCRIPTION_CELL"
The type of customer.
CONSUMER, BUSINESS 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.
Internal description of the product offering for operational use only.
"seamless_cell_10gb_us"
URL to the image representing the product offering.
"https://cdn.example.com/images/mobile-basic.png"
Date and time when the product offering was created.
Date and time when the product offering was last updated.
External reference for the product catalog. This ID should be used by external parties to reference the catalog.
"us-consumer-2025"
Description of the product catalog.
"Product catalog for US consumer customers"
The product groups in this catalog.
Show child attributes
Show child attributes
Unique identifier for the product group.
"mobile-plans"
Name of the product group in the requested locale.
"Mobile Plans"
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.
"SUBSCRIPTION_CELL"
Description of the product group in the requested locale.
"Bundled cell subscriptions with unlimited calls and SMS with ILD enabled."
Internal description of the product group for operational use only.
"Core mobile offerings targeting consumer and business segments"
Date and time when the product catalog was created.
Date and time when the product catalog was last updated.
The type of customer.
CONSUMER, BUSINESS