Create a Product Key (Subscription)

Create a product key (subscription)

Log in to see full request history
Body Params
string

Unique id of the organization that the product key was provided by

string

Unique identifier of the organization the product key belongs to

productIds
array of strings
required

The products the product key belongs to

productIds*
string
required

A description

boolean

Is the key valid?

string

The product key's owner

string

The key

slaDefinitionIds
array of strings

A list of sla definition ids associated with this product key

slaDefinitionIds
pricingRuleIds
array of strings

A list of pricing rule ids associated with this product key

pricingRuleIds
int64

The product key's expiration timestamp (milliseconds)

string
required

In the event the owner doesn't have an account an email address can be passed to create the account on the fly

string

The quote the product key may be associated with in an external cpq / financial system

int64

The optional transaction quota associated with the product key

int64
required

The consumed quota associated with the product key

double

The percentage of quota consumption to exceed before sending a notification

applications
array of strings
required

A list of application id's associated with this product key

applications*
boolean
required

Whether or not to send notifications to the productkey creator on creation

notificationAddressesOnCreation
array of strings
required

Additional email addresses for product key creation notification

notificationAddressesOnCreation*
boolean
required

Whether or not to send quota notifications to the product key's owner

notificationAddressesOnQuotaThreshold
array of strings
required

Additional email addresses for product key quota notifications

notificationAddressesOnQuotaThreshold*
string

The external id of an application associated with this product key

boolean
required

Whether or not to disable the product key on payment failed

string

Company name

namedConsumers
array of strings
required

List of user email addresses who are allowed to access the product

namedConsumers*
namedOrganizations
array of strings
required

List of organization id's who are allowed to access the product

namedOrganizations*
string

The id of the consumer data provider configuration

boolean

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

boolean

Whether or not to notify client when trial is about to expiry

string
required

The product key clients first name

tags
array of strings

A list of tags associated with this product license.

tags
string
required

The product key clients last name

int64
required

The product key's future subscription start date timestamp (milliseconds)

Responses

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json