Get change options for subscription

Error

A valid request URL is required to generate request examples

{
  "items": [
    {
      "productOffering": {
        "productOfferingId": "<string>",
        "name": "<string>",
        "price": {
          "currency": "USD",
          "discount": 5,
          "netPrice": 5,
          "priceType": "ONE_TIME",
          "boundMonths": 12,
          "billingCycle": {
            "period": "MONTHLY",
            "interval": 1
          }
        },
        "productOfferingGroupId": "<string>",
        "group": {
          "productOfferingGroupId": "<string>",
          "name": "<string>",
          "category": "SUBSCRIPTION_CELL"
        }
      },
      "changeSchedule": "INSTANT",
      "changeScheduleDate": "2024-02-01"
    }
  ]
}

GET

subscriptions

{subscriptionId}

product-offering-options

Error

A valid request URL is required to generate request examples

{
  "items": [
    {
      "productOffering": {
        "productOfferingId": "<string>",
        "name": "<string>",
        "price": {
          "currency": "USD",
          "discount": 5,
          "netPrice": 5,
          "priceType": "ONE_TIME",
          "boundMonths": 12,
          "billingCycle": {
            "period": "MONTHLY",
            "interval": 1
          }
        },
        "productOfferingGroupId": "<string>",
        "group": {
          "productOfferingGroupId": "<string>",
          "name": "<string>",
          "category": "SUBSCRIPTION_CELL"
        }
      },
      "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

Show child attributes

items.productOffering

object

required

Embedded representation of a product offering.

Show child attributes

items.productOffering.productOfferingId

string

required

The unique identifier for the product offering.

items.productOffering.name

string

required

The name of the product offering.

items.productOffering.price

object

required

Pricing information with discount details.

Show child attributes

items.productOffering.price.currency

string

required

The currency code.

Example:

"USD"

items.productOffering.price.discount

number<decimal>

default:5

The discount amount from the original price.

items.productOffering.price.netPrice

number<decimal>

The final cost after all discounts are applied.

Example:

5

items.productOffering.price.priceType

enum<string>

The type of pricing model applied to the product offering.

Available options:

ONE_TIME,

RECURRING

items.productOffering.price.boundMonths

integer

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

Example:

12

items.productOffering.price.billingCycle

object

The billing cycle for recurring prices.

Show child attributes

items.productOffering.price.billingCycle.period

enum<string>

The billing period.

Available options:

MONTHLY

items.productOffering.price.billingCycle.interval

integer

The interval of the billing period.

Example:

1

items.productOffering.productOfferingGroupId

string

The unique identifier for the product offering group.

items.productOffering.group

object

Product offering group information embedded in responses.

Show child attributes

items.productOffering.group.productOfferingGroupId

string

required

The unique identifier for the product offering group.

items.productOffering.group.name

string

required

The name of the product offering group.

items.productOffering.group.category

string

required

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.

Example:

"SUBSCRIPTION_CELL"

items.changeSchedule

enum<string>

required

The schedule type for when a product offering change can take effect.

INSTANT: Change takes effect immediately
FIRST_OF_NEXT_MONTH: Change takes effect on the first day of the next calendar month
NEXT_RENEWAL_DAY: Change takes effect on the next renewal date

Available options:

INSTANT,

FIRST_OF_NEXT_MONTH,

NEXT_RENEWAL_DAY

items.changeScheduleDate

string<date>

required

The date when the product offering change can take effect.

Example:

"2024-02-01"

Change subscription product offering Restore subscription

⌘I

Getting started

Overview

API reference

Authorizations

Path Parameters

Response