Skip to main content
GET
/
subscriptions
/
{subscriptionId}
/
product-offering-options
Get change options for subscription
curl --request GET \
  --url https://apiv2.example.com/subscriptions/{subscriptionId}/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
          }
        },
        "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"
        }
      },
      "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 unique identifier of the subscription.

Response

Available change options.

items
object[]
required