Getting started
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"
}
},
"status": "PENDING",
"productOfferingId": "<string>",
"productOfferingGroupId": "<string>",
"group": {
"productOfferingGroupId": "<string>",
"name": "<string>",
"category": "SUBSCRIPTION_CELL"
},
"licenseId": "<string>",
"pendingStatus": {
"status": "PENDING",
"scheduledAt": "2023-12-25"
},
"addedAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"cancelledAt": "2023-11-07T05:31:56Z",
"metadata": {}
}
]
}List active add-ons for subscription
Get all active and pending add-ons for a subscription.
This endpoint returns only add-ons that are currently attached to the subscription, including their status and scheduling information. Use /addon-options to query available add-ons.
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"
}
},
"status": "PENDING",
"productOfferingId": "<string>",
"productOfferingGroupId": "<string>",
"group": {
"productOfferingGroupId": "<string>",
"name": "<string>",
"category": "SUBSCRIPTION_CELL"
},
"licenseId": "<string>",
"pendingStatus": {
"status": "PENDING",
"scheduledAt": "2023-12-25"
},
"addedAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"cancelledAt": "2023-11-07T05:31:56Z",
"metadata": {}
}
]
}Authorizations
An API key that grants access to the Connect API. You can create and manage API keys in the portal.
Path Parameters
The unique identifier of the subscription.
Query Parameters
Filter add-ons by status.
The status of an add-on on a subscription.
- PENDING: Add-on is scheduled but not yet active
- ACTIVE: Add-on is currently active and billable
- CANCELLED: Add-on has been cancelled and is no longer active
PENDING, ACTIVE, CANCELLED Response
Active add-ons for the subscription.
Show child attributes
Show child attributes
Embedded representation of a product offering.
Show child attributes
Show child attributes
The unique identifier for the product offering.
The name of the product offering.
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 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 status of an add-on on a subscription.
- PENDING: Add-on is scheduled but not yet active
- ACTIVE: Add-on is currently active and billable
- CANCELLED: Add-on has been cancelled and is no longer active
PENDING, ACTIVE, CANCELLED 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
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 of the license associated with this add-on (if applicable).
Details about when a pending status change is scheduled for this add-on.
Show child attributes
Show child attributes
The status of an add-on on a subscription.
- PENDING: Add-on is scheduled but not yet active
- ACTIVE: Add-on is currently active and billable
- CANCELLED: Add-on has been cancelled and is no longer active
PENDING, ACTIVE, CANCELLED The date when the pending status change is scheduled to occur.
The date and time when the add-on was added to the subscription.
The date and time when the add-on was last updated.
The date and time when the add-on was cancelled (if applicable).¨