Nexus
Nexus APIs
POST
/v1/subscriptions/{subscriptionId}/amendments
Creates a subscription amendment for a subscription
Requires the subscription_amendment.write permission. The owning organization is derived server-side from the subscription, and the AllowUpsell kill-switch still applies.
Parameters
| Name | In | Required | Description |
|---|---|---|---|
subscriptionId |
path | Yes |
Request body
Request payload
Example
{
"requestItems": [
{
"lineId": "string",
"requestedAdditionalQuantity": 0
}
]
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
requestItems
|
nullable | The list of items being requested | — |
Example
{
"requestItems": [
{
"lineId": "string",
"requestedAdditionalQuantity": 0
}
]
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
requestItems
|
nullable | The list of items being requested | — |
Example
{
"requestItems": [
{
"lineId": "string",
"requestedAdditionalQuantity": 0
}
]
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
requestItems
|
nullable | The list of items being requested | — |
Example
{
"requestItems": [
{
"lineId": "string",
"requestedAdditionalQuantity": 0
}
]
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
requestItems
|
nullable | The list of items being requested | — |
Example
{
"requestItems": [
{
"lineId": "string",
"requestedAdditionalQuantity": 0
}
]
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
requestItems
|
nullable | The list of items being requested | — |
Example
{
"requestItems": [
{
"lineId": "string",
"requestedAdditionalQuantity": 0
}
]
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
requestItems
|
nullable | The list of items being requested | — |
Example
{
"requestItems": [
{
"lineId": "string",
"requestedAdditionalQuantity": 0
}
]
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
requestItems
|
nullable | The list of items being requested | — |
Example
{
"requestItems": [
{
"lineId": "string",
"requestedAdditionalQuantity": 0
}
]
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
requestItems
|
nullable | The list of items being requested | — |
Responses
201
Example
{
"id": 0,
"status": "string",
"created": "string",
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"statusText": "string",
"sfLicenseId": "string",
"requestItems": {},
"sfContractId": "string",
"organizationId": 0,
"subscriptionId": 0,
"sfOpportunityId": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
nullable | The date/time the record was created (UTC). | — |
createdBy
|
string
|
nullable | The user that created the record. | — |
id
|
integer (int32)
|
nullable | A system assigned unique identifier. | — |
modified
|
string (date-time)
|
nullable | The date/time the record was last modified (UTC). | — |
modifiedBy
|
string
|
nullable | The user that last modified the record. | — |
organizationId
|
integer (int32)
|
nullable | Id of the organization the subscription amendment belongs to | — |
requestItems
|
— | JsonObject primitive | — | |
sfContractId
|
string
|
nullable | The Salesforce contract identifier | — |
sfLicenseId
|
string
|
nullable | The Salesforce license identifier | — |
sfOpportunityId
|
string
|
nullable | The Salesforce Opportunity identifier returned by contractAmendment | — |
status
|
string
|
nullable | Status of the subscription amendment | — |
statusText
|
string
|
nullable | Message related to the status | — |
subscriptionId
|
integer (int32)
|
nullable | Id of the subscription the amendment is for | — |
Example
{
"id": 0,
"status": "string",
"created": "string",
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"statusText": "string",
"sfLicenseId": "string",
"requestItems": {},
"sfContractId": "string",
"organizationId": 0,
"subscriptionId": 0,
"sfOpportunityId": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
nullable | The date/time the record was created (UTC). | — |
createdBy
|
string
|
nullable | The user that created the record. | — |
id
|
integer (int32)
|
nullable | A system assigned unique identifier. | — |
modified
|
string (date-time)
|
nullable | The date/time the record was last modified (UTC). | — |
modifiedBy
|
string
|
nullable | The user that last modified the record. | — |
organizationId
|
integer (int32)
|
nullable | Id of the organization the subscription amendment belongs to | — |
requestItems
|
— | JsonObject primitive | — | |
sfContractId
|
string
|
nullable | The Salesforce contract identifier | — |
sfLicenseId
|
string
|
nullable | The Salesforce license identifier | — |
sfOpportunityId
|
string
|
nullable | The Salesforce Opportunity identifier returned by contractAmendment | — |
status
|
string
|
nullable | Status of the subscription amendment | — |
statusText
|
string
|
nullable | Message related to the status | — |
subscriptionId
|
integer (int32)
|
nullable | Id of the subscription the amendment is for | — |
Example
{
"id": 0,
"status": "string",
"created": "string",
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"statusText": "string",
"sfLicenseId": "string",
"requestItems": {},
"sfContractId": "string",
"organizationId": 0,
"subscriptionId": 0,
"sfOpportunityId": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
nullable | The date/time the record was created (UTC). | — |
createdBy
|
string
|
nullable | The user that created the record. | — |
id
|
integer (int32)
|
nullable | A system assigned unique identifier. | — |
modified
|
string (date-time)
|
nullable | The date/time the record was last modified (UTC). | — |
modifiedBy
|
string
|
nullable | The user that last modified the record. | — |
organizationId
|
integer (int32)
|
nullable | Id of the organization the subscription amendment belongs to | — |
requestItems
|
— | JsonObject primitive | — | |
sfContractId
|
string
|
nullable | The Salesforce contract identifier | — |
sfLicenseId
|
string
|
nullable | The Salesforce license identifier | — |
sfOpportunityId
|
string
|
nullable | The Salesforce Opportunity identifier returned by contractAmendment | — |
status
|
string
|
nullable | Status of the subscription amendment | — |
statusText
|
string
|
nullable | Message related to the status | — |
subscriptionId
|
integer (int32)
|
nullable | Id of the subscription the amendment is for | — |
Example
{
"id": 0,
"status": "string",
"created": "string",
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"statusText": "string",
"sfLicenseId": "string",
"requestItems": {},
"sfContractId": "string",
"organizationId": 0,
"subscriptionId": 0,
"sfOpportunityId": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
nullable | The date/time the record was created (UTC). | — |
createdBy
|
string
|
nullable | The user that created the record. | — |
id
|
integer (int32)
|
nullable | A system assigned unique identifier. | — |
modified
|
string (date-time)
|
nullable | The date/time the record was last modified (UTC). | — |
modifiedBy
|
string
|
nullable | The user that last modified the record. | — |
organizationId
|
integer (int32)
|
nullable | Id of the organization the subscription amendment belongs to | — |
requestItems
|
— | JsonObject primitive | — | |
sfContractId
|
string
|
nullable | The Salesforce contract identifier | — |
sfLicenseId
|
string
|
nullable | The Salesforce license identifier | — |
sfOpportunityId
|
string
|
nullable | The Salesforce Opportunity identifier returned by contractAmendment | — |
status
|
string
|
nullable | Status of the subscription amendment | — |
statusText
|
string
|
nullable | Message related to the status | — |
subscriptionId
|
integer (int32)
|
nullable | Id of the subscription the amendment is for | — |
Example
{
"id": 0,
"status": "string",
"created": "string",
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"statusText": "string",
"sfLicenseId": "string",
"requestItems": {},
"sfContractId": "string",
"organizationId": 0,
"subscriptionId": 0,
"sfOpportunityId": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
nullable | The date/time the record was created (UTC). | — |
createdBy
|
string
|
nullable | The user that created the record. | — |
id
|
integer (int32)
|
nullable | A system assigned unique identifier. | — |
modified
|
string (date-time)
|
nullable | The date/time the record was last modified (UTC). | — |
modifiedBy
|
string
|
nullable | The user that last modified the record. | — |
organizationId
|
integer (int32)
|
nullable | Id of the organization the subscription amendment belongs to | — |
requestItems
|
— | JsonObject primitive | — | |
sfContractId
|
string
|
nullable | The Salesforce contract identifier | — |
sfLicenseId
|
string
|
nullable | The Salesforce license identifier | — |
sfOpportunityId
|
string
|
nullable | The Salesforce Opportunity identifier returned by contractAmendment | — |
status
|
string
|
nullable | Status of the subscription amendment | — |
statusText
|
string
|
nullable | Message related to the status | — |
subscriptionId
|
integer (int32)
|
nullable | Id of the subscription the amendment is for | — |
Example
{
"id": 0,
"status": "string",
"created": "string",
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"statusText": "string",
"sfLicenseId": "string",
"requestItems": {},
"sfContractId": "string",
"organizationId": 0,
"subscriptionId": 0,
"sfOpportunityId": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
nullable | The date/time the record was created (UTC). | — |
createdBy
|
string
|
nullable | The user that created the record. | — |
id
|
integer (int32)
|
nullable | A system assigned unique identifier. | — |
modified
|
string (date-time)
|
nullable | The date/time the record was last modified (UTC). | — |
modifiedBy
|
string
|
nullable | The user that last modified the record. | — |
organizationId
|
integer (int32)
|
nullable | Id of the organization the subscription amendment belongs to | — |
requestItems
|
— | JsonObject primitive | — | |
sfContractId
|
string
|
nullable | The Salesforce contract identifier | — |
sfLicenseId
|
string
|
nullable | The Salesforce license identifier | — |
sfOpportunityId
|
string
|
nullable | The Salesforce Opportunity identifier returned by contractAmendment | — |
status
|
string
|
nullable | Status of the subscription amendment | — |
statusText
|
string
|
nullable | Message related to the status | — |
subscriptionId
|
integer (int32)
|
nullable | Id of the subscription the amendment is for | — |
Example
{
"id": 0,
"status": "string",
"created": "string",
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"statusText": "string",
"sfLicenseId": "string",
"requestItems": {},
"sfContractId": "string",
"organizationId": 0,
"subscriptionId": 0,
"sfOpportunityId": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
nullable | The date/time the record was created (UTC). | — |
createdBy
|
string
|
nullable | The user that created the record. | — |
id
|
integer (int32)
|
nullable | A system assigned unique identifier. | — |
modified
|
string (date-time)
|
nullable | The date/time the record was last modified (UTC). | — |
modifiedBy
|
string
|
nullable | The user that last modified the record. | — |
organizationId
|
integer (int32)
|
nullable | Id of the organization the subscription amendment belongs to | — |
requestItems
|
— | JsonObject primitive | — | |
sfContractId
|
string
|
nullable | The Salesforce contract identifier | — |
sfLicenseId
|
string
|
nullable | The Salesforce license identifier | — |
sfOpportunityId
|
string
|
nullable | The Salesforce Opportunity identifier returned by contractAmendment | — |
status
|
string
|
nullable | Status of the subscription amendment | — |
statusText
|
string
|
nullable | Message related to the status | — |
subscriptionId
|
integer (int32)
|
nullable | Id of the subscription the amendment is for | — |
Security
Authentication is required for this operation.
Source: default
Requirements (any one option may satisfy)
- Bearer and ApplicationToken
- Basic