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"
}
},
"productOfferingId": "<string>",
"productOfferingGroupId": "<string>",
"group": {
"productOfferingGroupId": "<string>",
"name": "<string>",
"category": "SUBSCRIPTION_CELL"
}
}
]
}Get all top-up options that are available for a subscription.
This endpoint returns top-ups that can potentially be added to the subscription.
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"
}
},
"productOfferingId": "<string>",
"productOfferingGroupId": "<string>",
"group": {
"productOfferingGroupId": "<string>",
"name": "<string>",
"category": "SUBSCRIPTION_CELL"
}
}
]
}An API key that grants access to the Connect API. You can create and manage API keys in the portal.
The unique identifier of the subscription.
Available add-on options for the subscription.
Show child attributes
Embedded representation of a product offering.
Show child attributes
The unique identifier for the product offering.
The name of the product offering.
Pricing information with discount details.
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 unique identifier for the product offering group.
Product offering group information embedded in responses.
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 unique identifier for the product offering.
The unique identifier for the product offering group.
Product offering group information embedded in responses.
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"