Nexus
Nexus APIs
GET
/v1/subscriptions/upsell-catalog/{organizationId}
Gets the upsell catalog for an organization
Returns upsell-eligible modules from the organization's active subscriptions. Requires the upsell_request.read permission.
Parameters
| Name | In | Required | Description |
|---|---|---|---|
organizationId |
path | Yes |
Responses
200
Example
[
{
"sfModuleId": "string",
"currentPupm": 0,
"sfAccountId": "string",
"sfLicenseId": "string",
"sfProductId": "string",
"dependencies": [
{}
],
"moduleString": "string",
"sfContractId": "string",
"subscriptionId": 0,
"currentQuantity": 0,
"sfSubscriptionId": "string",
"softwareDeliveryType": "string"
}
]Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
currentPupm
|
number (double)
|
nullable | The current per-user-per-month price for this module | — |
currentQuantity
|
integer (int32)
|
nullable | The current quantity of the module | — |
dependencies
|
nullable | Dependency rules for this module from product metadata | — | |
moduleString
|
string
|
nullable | The module string identifier | — |
sfAccountId
|
string
|
nullable | The Salesforce Account identifier | — |
sfContractId
|
string
|
nullable | The Salesforce contract identifier | — |
sfLicenseId
|
string
|
nullable | The Salesforce license identifier | — |
sfModuleId
|
string
|
nullable | The Salesforce module identifier | — |
sfProductId
|
string
|
nullable | The Salesforce product identifier | — |
sfSubscriptionId
|
string
|
nullable | The Salesforce CPQ subscription identifier (SBQQ__Subscription__c.Id) | — |
softwareDeliveryType
|
string
|
nullable | The software delivery type for this module | — |
subscriptionId
|
integer (int32)
|
nullable | The subscription identifier | — |
Example
[
{
"sfModuleId": "string",
"currentPupm": 0,
"sfAccountId": "string",
"sfLicenseId": "string",
"sfProductId": "string",
"dependencies": [
{}
],
"moduleString": "string",
"sfContractId": "string",
"subscriptionId": 0,
"currentQuantity": 0,
"sfSubscriptionId": "string",
"softwareDeliveryType": "string"
}
]Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
currentPupm
|
number (double)
|
nullable | The current per-user-per-month price for this module | — |
currentQuantity
|
integer (int32)
|
nullable | The current quantity of the module | — |
dependencies
|
nullable | Dependency rules for this module from product metadata | — | |
moduleString
|
string
|
nullable | The module string identifier | — |
sfAccountId
|
string
|
nullable | The Salesforce Account identifier | — |
sfContractId
|
string
|
nullable | The Salesforce contract identifier | — |
sfLicenseId
|
string
|
nullable | The Salesforce license identifier | — |
sfModuleId
|
string
|
nullable | The Salesforce module identifier | — |
sfProductId
|
string
|
nullable | The Salesforce product identifier | — |
sfSubscriptionId
|
string
|
nullable | The Salesforce CPQ subscription identifier (SBQQ__Subscription__c.Id) | — |
softwareDeliveryType
|
string
|
nullable | The software delivery type for this module | — |
subscriptionId
|
integer (int32)
|
nullable | The subscription identifier | — |
Example
[
{
"sfModuleId": "string",
"currentPupm": 0,
"sfAccountId": "string",
"sfLicenseId": "string",
"sfProductId": "string",
"dependencies": [
{}
],
"moduleString": "string",
"sfContractId": "string",
"subscriptionId": 0,
"currentQuantity": 0,
"sfSubscriptionId": "string",
"softwareDeliveryType": "string"
}
]Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
currentPupm
|
number (double)
|
nullable | The current per-user-per-month price for this module | — |
currentQuantity
|
integer (int32)
|
nullable | The current quantity of the module | — |
dependencies
|
nullable | Dependency rules for this module from product metadata | — | |
moduleString
|
string
|
nullable | The module string identifier | — |
sfAccountId
|
string
|
nullable | The Salesforce Account identifier | — |
sfContractId
|
string
|
nullable | The Salesforce contract identifier | — |
sfLicenseId
|
string
|
nullable | The Salesforce license identifier | — |
sfModuleId
|
string
|
nullable | The Salesforce module identifier | — |
sfProductId
|
string
|
nullable | The Salesforce product identifier | — |
sfSubscriptionId
|
string
|
nullable | The Salesforce CPQ subscription identifier (SBQQ__Subscription__c.Id) | — |
softwareDeliveryType
|
string
|
nullable | The software delivery type for this module | — |
subscriptionId
|
integer (int32)
|
nullable | The subscription identifier | — |
Example
[
{
"sfModuleId": "string",
"currentPupm": 0,
"sfAccountId": "string",
"sfLicenseId": "string",
"sfProductId": "string",
"dependencies": [
{}
],
"moduleString": "string",
"sfContractId": "string",
"subscriptionId": 0,
"currentQuantity": 0,
"sfSubscriptionId": "string",
"softwareDeliveryType": "string"
}
]Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
currentPupm
|
number (double)
|
nullable | The current per-user-per-month price for this module | — |
currentQuantity
|
integer (int32)
|
nullable | The current quantity of the module | — |
dependencies
|
nullable | Dependency rules for this module from product metadata | — | |
moduleString
|
string
|
nullable | The module string identifier | — |
sfAccountId
|
string
|
nullable | The Salesforce Account identifier | — |
sfContractId
|
string
|
nullable | The Salesforce contract identifier | — |
sfLicenseId
|
string
|
nullable | The Salesforce license identifier | — |
sfModuleId
|
string
|
nullable | The Salesforce module identifier | — |
sfProductId
|
string
|
nullable | The Salesforce product identifier | — |
sfSubscriptionId
|
string
|
nullable | The Salesforce CPQ subscription identifier (SBQQ__Subscription__c.Id) | — |
softwareDeliveryType
|
string
|
nullable | The software delivery type for this module | — |
subscriptionId
|
integer (int32)
|
nullable | The subscription identifier | — |
Example
[
{
"sfModuleId": "string",
"currentPupm": 0,
"sfAccountId": "string",
"sfLicenseId": "string",
"sfProductId": "string",
"dependencies": [
{}
],
"moduleString": "string",
"sfContractId": "string",
"subscriptionId": 0,
"currentQuantity": 0,
"sfSubscriptionId": "string",
"softwareDeliveryType": "string"
}
]Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
currentPupm
|
number (double)
|
nullable | The current per-user-per-month price for this module | — |
currentQuantity
|
integer (int32)
|
nullable | The current quantity of the module | — |
dependencies
|
nullable | Dependency rules for this module from product metadata | — | |
moduleString
|
string
|
nullable | The module string identifier | — |
sfAccountId
|
string
|
nullable | The Salesforce Account identifier | — |
sfContractId
|
string
|
nullable | The Salesforce contract identifier | — |
sfLicenseId
|
string
|
nullable | The Salesforce license identifier | — |
sfModuleId
|
string
|
nullable | The Salesforce module identifier | — |
sfProductId
|
string
|
nullable | The Salesforce product identifier | — |
sfSubscriptionId
|
string
|
nullable | The Salesforce CPQ subscription identifier (SBQQ__Subscription__c.Id) | — |
softwareDeliveryType
|
string
|
nullable | The software delivery type for this module | — |
subscriptionId
|
integer (int32)
|
nullable | The subscription identifier | — |
Example
[
{
"sfModuleId": "string",
"currentPupm": 0,
"sfAccountId": "string",
"sfLicenseId": "string",
"sfProductId": "string",
"dependencies": [
{}
],
"moduleString": "string",
"sfContractId": "string",
"subscriptionId": 0,
"currentQuantity": 0,
"sfSubscriptionId": "string",
"softwareDeliveryType": "string"
}
]Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
currentPupm
|
number (double)
|
nullable | The current per-user-per-month price for this module | — |
currentQuantity
|
integer (int32)
|
nullable | The current quantity of the module | — |
dependencies
|
nullable | Dependency rules for this module from product metadata | — | |
moduleString
|
string
|
nullable | The module string identifier | — |
sfAccountId
|
string
|
nullable | The Salesforce Account identifier | — |
sfContractId
|
string
|
nullable | The Salesforce contract identifier | — |
sfLicenseId
|
string
|
nullable | The Salesforce license identifier | — |
sfModuleId
|
string
|
nullable | The Salesforce module identifier | — |
sfProductId
|
string
|
nullable | The Salesforce product identifier | — |
sfSubscriptionId
|
string
|
nullable | The Salesforce CPQ subscription identifier (SBQQ__Subscription__c.Id) | — |
softwareDeliveryType
|
string
|
nullable | The software delivery type for this module | — |
subscriptionId
|
integer (int32)
|
nullable | The subscription identifier | — |
Example
[
{
"sfModuleId": "string",
"currentPupm": 0,
"sfAccountId": "string",
"sfLicenseId": "string",
"sfProductId": "string",
"dependencies": [
{}
],
"moduleString": "string",
"sfContractId": "string",
"subscriptionId": 0,
"currentQuantity": 0,
"sfSubscriptionId": "string",
"softwareDeliveryType": "string"
}
]Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
currentPupm
|
number (double)
|
nullable | The current per-user-per-month price for this module | — |
currentQuantity
|
integer (int32)
|
nullable | The current quantity of the module | — |
dependencies
|
nullable | Dependency rules for this module from product metadata | — | |
moduleString
|
string
|
nullable | The module string identifier | — |
sfAccountId
|
string
|
nullable | The Salesforce Account identifier | — |
sfContractId
|
string
|
nullable | The Salesforce contract identifier | — |
sfLicenseId
|
string
|
nullable | The Salesforce license identifier | — |
sfModuleId
|
string
|
nullable | The Salesforce module identifier | — |
sfProductId
|
string
|
nullable | The Salesforce product identifier | — |
sfSubscriptionId
|
string
|
nullable | The Salesforce CPQ subscription identifier (SBQQ__Subscription__c.Id) | — |
softwareDeliveryType
|
string
|
nullable | The software delivery type for this module | — |
subscriptionId
|
integer (int32)
|
nullable | The subscription identifier | — |
Security
Authentication is required for this operation.
Source: default
Requirements (any one option may satisfy)
- Bearer and ApplicationToken
- Basic