Skip to main content
GET
/
subscriptions
/
{subscriptionId}
/
addons
/
product-offering-options
Get change options for subscription add-on
curl --request GET \
  --url https://apiv2.example.com/subscriptions/{subscriptionId}/addons/product-offering-options \
  --header 'X-Api-Key: <api-key>'
{
  "items": [
    {
      "productOffering": {
        "productOfferingId": "<string>",
        "name": "<string>",
        "price": {
          "currency": "USD",
          "priceType": "ONE_TIME",
          "discount": 5,
          "netPrice": 5,
          "boundMonths": 12,
          "billingCycle": {
            "period": "MONTHLY",
            "interval": 1
          },
          "currencyOptions": {}
        },
        "group": {
          "productOfferingGroupId": "mobile-plans",
          "name": "Mobile Plans",
          "category": "PRODUCT_CATEGORY_SUBSCRIPTION_CELL",
          "description": "Bundled cell subscriptions with unlimited calls and SMS with ILD enabled.",
          "internalDescription": "Core mobile offerings targeting consumer and business segments"
        }
      },
      "changeSchedule": "INSTANT",
      "changeScheduleDate": "2024-02-01"
    }
  ]
}

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

​
subscriptionId
string
required

The identifier of the subscription. May be the entity's internal UUID or an external reference identifier. Reference identifiers MUST be prefixed with rid_ (e.g., rid_crm-subscription-12345) so the API can distinguish them from internal UUIDs. The prefix is stripped before lookup.

Query Parameters

​
currentProductOfferingId
string
required

The current add-on product offering to get change options for.

Response

Available change options for the add-on.

​
items
object[]
required