Web service parameters
These are the possible request parameters to your web service for product license generation. You can configure them via:
Our support team
You can change standard parameter names when configuring.
You can change standard parameter names when configuring.
Order
string
Order identifier (Order ID)
Item
string
Order item ID
This is our internal identifier assigned to the products inside an order when it is created (currently not used in other APIs)
ID
string
Product identifier (Product ID)
Quantity
string
Product unit quantities
Order_sum
string
Product total price
Transferred in order currency
Product quantity, VAT, discount are included
Format: Number with 2 decimals, separator - dot, transferred as string
Currency
string
Checkout currency
Order currency code:
Format: ISO 4217 alpha-3, 3 characters
For value options, see reference guide
Zone
string
Zone This is a sales area code which is determined by the checkout currency.
Subscription_ID
string
Subscription ID
Used only if a product has an active subscription
Transferred for AR and PMR subscriptions
Subscription_period
string
Subscription validity period
Product validity period is transferred.
Format: ISO 8601 code: P[number][unit of measurement]
Supported units of measurement: Y - year, M - month, D – day. Example: "P1Y" means "1 year"
Key_first_renew
string
Product license initiating subscriptions
For subscription products - a product license initiating a subscription. For example, if a request to get a license for a renewal order (child order) is transferred, the license from the parent order (the first order in the subscription) is transferred in this parameter.
This parameter can be added to the request only with the help of our support team.
Key_last_renew
string
Last issued license within subscription
For subscription products - a product license issued in a previous order within a subscription. For example:
If a request to get a license is transferred for the product initiating the subscription (parent order), the parameter is transferred being empty
If a request to get a license is transferred for the product that renews the subscription for the first time (first child order), the parameter transfers a license for the product that initiates the subscription
If a request to get a license is transferred for the product that renews a subscription for the second time (second child order), the parameter transfers the license of the previous product purchased within the subscription (e.g., the license from the first child order returns for the second child order)
This parameter can be added to the request only with the help of our support team.
string
Customer's email
Fullname
string
Customer's last name and name
Fname
string
Customer's name
Lname
string
Customer's last name
Company
string
Customer's company name
Referer1-Referer6
string
Additional order parameters
These are internal order parameters (referer1, referer2, etc.). More details on additional parameters. Note that the retention period of the additional parameters in an order is limited.
Referer7-Referer12
string
Additional order parameters
These are internal order parameters (referer7, referer7, etc.). More details on additional parameters. Note that the retention period of the additional parameters in an order is limited.
These parameters can be added to the request only with the help of our support team.
Noventiq Checkout
Support | |
Our resources |