Nexus
Nexus APIs
GET
/v1/subscriptions/line-item-catalog/{organizationId}
Gets the amendable line-item catalog for an organization
Returns amendment-eligible line items from the organization's active subscriptions. Requires the subscription_amendment.read permission.
Parameters
| Name | In | Required | Description |
|---|---|---|---|
organizationId |
path | Yes |
Responses
200
Example
[
{
"pupm": 0,
"lineId": "string",
"currency": "string",
"productCode": "string",
"productName": "string",
"subscriptionId": 0,
"currentQuantity": 0
}
]Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
currency
|
string
|
nullable | The ISO currency code for this subscription. | — |
currentQuantity
|
number (double)
|
nullable | The current quantity on this line. | — |
lineId
|
string
|
nullable | The opaque, point-in-time line handle used to address this line on a write. Resolved server-side to the underlying Salesforce ids; never a Salesforce id itself. | — |
productCode
|
string
|
nullable | The CPQ product code (SBQQ SKU) this line belongs to. | — |
productName
|
string
|
nullable | The human-readable product name for display. | — |
pupm
|
number (double)
|
nullable | The per-user-per-month price for this line. | — |
subscriptionId
|
integer (int32)
|
nullable | The subscription identifier | — |
Example
[
{
"pupm": 0,
"lineId": "string",
"currency": "string",
"productCode": "string",
"productName": "string",
"subscriptionId": 0,
"currentQuantity": 0
}
]Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
currency
|
string
|
nullable | The ISO currency code for this subscription. | — |
currentQuantity
|
number (double)
|
nullable | The current quantity on this line. | — |
lineId
|
string
|
nullable | The opaque, point-in-time line handle used to address this line on a write. Resolved server-side to the underlying Salesforce ids; never a Salesforce id itself. | — |
productCode
|
string
|
nullable | The CPQ product code (SBQQ SKU) this line belongs to. | — |
productName
|
string
|
nullable | The human-readable product name for display. | — |
pupm
|
number (double)
|
nullable | The per-user-per-month price for this line. | — |
subscriptionId
|
integer (int32)
|
nullable | The subscription identifier | — |
Example
[
{
"pupm": 0,
"lineId": "string",
"currency": "string",
"productCode": "string",
"productName": "string",
"subscriptionId": 0,
"currentQuantity": 0
}
]Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
currency
|
string
|
nullable | The ISO currency code for this subscription. | — |
currentQuantity
|
number (double)
|
nullable | The current quantity on this line. | — |
lineId
|
string
|
nullable | The opaque, point-in-time line handle used to address this line on a write. Resolved server-side to the underlying Salesforce ids; never a Salesforce id itself. | — |
productCode
|
string
|
nullable | The CPQ product code (SBQQ SKU) this line belongs to. | — |
productName
|
string
|
nullable | The human-readable product name for display. | — |
pupm
|
number (double)
|
nullable | The per-user-per-month price for this line. | — |
subscriptionId
|
integer (int32)
|
nullable | The subscription identifier | — |
Example
[
{
"pupm": 0,
"lineId": "string",
"currency": "string",
"productCode": "string",
"productName": "string",
"subscriptionId": 0,
"currentQuantity": 0
}
]Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
currency
|
string
|
nullable | The ISO currency code for this subscription. | — |
currentQuantity
|
number (double)
|
nullable | The current quantity on this line. | — |
lineId
|
string
|
nullable | The opaque, point-in-time line handle used to address this line on a write. Resolved server-side to the underlying Salesforce ids; never a Salesforce id itself. | — |
productCode
|
string
|
nullable | The CPQ product code (SBQQ SKU) this line belongs to. | — |
productName
|
string
|
nullable | The human-readable product name for display. | — |
pupm
|
number (double)
|
nullable | The per-user-per-month price for this line. | — |
subscriptionId
|
integer (int32)
|
nullable | The subscription identifier | — |
Example
[
{
"pupm": 0,
"lineId": "string",
"currency": "string",
"productCode": "string",
"productName": "string",
"subscriptionId": 0,
"currentQuantity": 0
}
]Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
currency
|
string
|
nullable | The ISO currency code for this subscription. | — |
currentQuantity
|
number (double)
|
nullable | The current quantity on this line. | — |
lineId
|
string
|
nullable | The opaque, point-in-time line handle used to address this line on a write. Resolved server-side to the underlying Salesforce ids; never a Salesforce id itself. | — |
productCode
|
string
|
nullable | The CPQ product code (SBQQ SKU) this line belongs to. | — |
productName
|
string
|
nullable | The human-readable product name for display. | — |
pupm
|
number (double)
|
nullable | The per-user-per-month price for this line. | — |
subscriptionId
|
integer (int32)
|
nullable | The subscription identifier | — |
Example
[
{
"pupm": 0,
"lineId": "string",
"currency": "string",
"productCode": "string",
"productName": "string",
"subscriptionId": 0,
"currentQuantity": 0
}
]Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
currency
|
string
|
nullable | The ISO currency code for this subscription. | — |
currentQuantity
|
number (double)
|
nullable | The current quantity on this line. | — |
lineId
|
string
|
nullable | The opaque, point-in-time line handle used to address this line on a write. Resolved server-side to the underlying Salesforce ids; never a Salesforce id itself. | — |
productCode
|
string
|
nullable | The CPQ product code (SBQQ SKU) this line belongs to. | — |
productName
|
string
|
nullable | The human-readable product name for display. | — |
pupm
|
number (double)
|
nullable | The per-user-per-month price for this line. | — |
subscriptionId
|
integer (int32)
|
nullable | The subscription identifier | — |
Example
[
{
"pupm": 0,
"lineId": "string",
"currency": "string",
"productCode": "string",
"productName": "string",
"subscriptionId": 0,
"currentQuantity": 0
}
]Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
currency
|
string
|
nullable | The ISO currency code for this subscription. | — |
currentQuantity
|
number (double)
|
nullable | The current quantity on this line. | — |
lineId
|
string
|
nullable | The opaque, point-in-time line handle used to address this line on a write. Resolved server-side to the underlying Salesforce ids; never a Salesforce id itself. | — |
productCode
|
string
|
nullable | The CPQ product code (SBQQ SKU) this line belongs to. | — |
productName
|
string
|
nullable | The human-readable product name for display. | — |
pupm
|
number (double)
|
nullable | The per-user-per-month price for this line. | — |
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