Update a Product

put https://api.revenium.io/profitstream/v1/api/products/{id}

Update a product

Path Params

string

required

The id of the product to update

Body Params

ownerId

string

The id of the user that owns the product

organizationId

string

The id of the organization that owns the product

name

string

The name of the product

description

string

The description of the product

shortDescription

string

link

string

A link to the product

version

string

The version of the product

baseCost

number

The base cost to access the product

settlementPeriod

string

The settlement period that determines when product charges are calculated for an invoice

account

string

The account id

transactionType

string

The transaction type of the product

paymentConfigurationId

string

The id of the payment configuration

pricingRuleIds

array of strings

required

The product's pricing rules

pricingRuleIds*

assetIds

array of strings

required

A list of asset ids that compose the product

assetIds*

productIds

array of strings

required

A list of product ids that compose the product

productIds*

slaDefinitionIds

array of strings

required

A list of sla definition ids to add to this product.

slaDefinitionIds*

cpqStaged

boolean

Is the product staged from a CPQ system?

tags

array of strings

required

A list of tags associated with this product.

tags*

defaultQuota

int64

The default transaction quota for product keys associated with this product

defaultQuotaNotificationThreshold

double

The default percentage of quota consumption to exceed before sending a notification

sendDefaultNotificationOnInvoice

boolean

required

Whether or not to send invoice notifications to the recipient of the invoice

notificationAddressesOnInvoice

array of strings

required

Additional email addresses to end invoice notifications to

notificationAddressesOnInvoice*

overageRatePerTransaction

number

The subscription overage rate per transaction for products defined with 'SUBSCRIPTION_WITH_OVERAGE'

subscriptionIncludedTransactions

int64

The included transaction count for products defined with 'SUBSCRIPTION_WITH_OVERAGE'

isStaged

boolean

required

Whether or not the product should be staged or immediately live

code

string

The product's code (to correlate in an external ERP system)

terms

string

The terms and conditions

termsDisplayName

string

The terms and conditions display name

additionalTerms1

string

Additional terms and conditions

additionalTermsDisplayName1

string

Additional terms and conditions display name

additionalTerms2

string

Additional terms and conditions

additionalTermsDisplayName2

string

Additional terms and conditions display name

externalId

string

required

An external identifier (ie, in a API Management system) that is associated with the Asset

displayPriority

double

The display priority the product

notifyClientOnInvoice

boolean

Notify client on invoice

notifyClientTrialAboutToExpire

boolean

Notify client that trial is about to expire

audienceRestriction

string

required

The audience restriction, if any, on a product

externalLabel

string

An external label for the product that is exposed in developer portals

environmentId

string

The environment for the product

apimConfigurationId

string

The id of the APIM Configuration (if synchronizing this product with an external APIM)

namedOrganizations

array of strings

required

The organizations allowed to access the product

namedOrganizations*

plan

object

A plan that can be used for a product

performanceDefinition

object

A performance definition defining the expected performance characteristics for a product

subscriptionAllowMidPeriodCancellation

boolean

Whether or not to allow mid period cancellation of the subscription with proration

logo

string

The product's logo

pricingDescriptionWithoutHtml

string

A full description not parsed for html

pricingDescriptionUseCustom

boolean

Whether to use the custom pricing description

invoiceManagement

object

Invoice Management configuration for a product

paymentSource

string

The product payment source

staged

boolean

Responses

Language

Credentials

Header


xxxxxxxxxx
14
1
curl --request PUT \
2
     --url https://api.revenium.io/profitstream/v1/api/products/id \
3
     --header 'accept: MediaType.APPLICATION_JSON_VALUE' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "sendDefaultNotificationOnInvoice": true,
8
  "isStaged": true,
9
  "plan": {
10
    "graduated": true,
11
    "template": true
12
  }
13
}
14
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The updated product

403Forbidden to access this user

404Product not found