website logo
⌘K
Getting Started
Introduction
Basic Concepts
Opening an Account
Creating & Configuring Products
Integrating SDK and Configuring License Fulfillment
Activate a Key-Based License
Vendor Platform
Issuing New Licenses
License Detail View
Order Detail View
Customer Detail View
Metadata
Analytics
Settings
Product Configuration
Product Features
Product Custom Fields
Product Versioning
License Policies
Product Bundles
License Entitlements
License Types
Activations & Device Transfers
Features
Custom Fields
License Start Date
License Note
Maintenance Period
Trial Licenses
Floating Licenses
License Activation Types
Portals
End-User Portal
Offline Portal
Air-Gapped Portal
License API
License API Authorization
License Activation/Deactivation
License Check
Consumption
Floating
Trial Key
Product Details
Device Variables
Changing Password
Management API
Making API Requests
Management API Authorization
Customer
Product
Order
License
Device
Analytics
SDKs
Tutorials
.NET/C# SDK
.NET/C# Management SDK
C++ SDK
Java SDK
Python SDK
Go SDK
Delphi SDK
Swift/Objective-C SDK
Android SDK
Unity SDK
Errors and Response Codes
Floating Server
API Reference
Deployment
Configuration
Floating Server UI
Securing the Server
Whitelabeling
FAQ
Floating Server Changelog
Integrations
Salesforce
FastSpring
Stripe
Shopify
Common Scenarios
Single Sign On (SSO)
Glossary
General
SDK Glossary
Vendor Platform
Product Configuration Glossary
License Configuration
Postman Collections
Frequently Asked Questions
Changelog
License API changelog
Platform changelog
Docs powered by
Archbee
License API
Consumption

Adding Feature Consumption

7min
Only for consumption feature licenses. Adds 1 or more consumptions to the feature usage.
POST
Params
Header Parameters
Date
required
String
eq. Thu, 17 Nov 2022 20:51:35 GMT
Authorization
required
String
See signing of the License API calls article.
Body Parameters
hardware_id
required
String
Unique hardware ID generated for some device
product
required
String
Product short code
feature
required
String
Feature short code
license_key
optional
String
Required if product is key_based. Attach the license key (eq. 1111-2222-3333-4444)
username
optional
String
Required if product is user based. Attach the assigned license user email (eq. user@example.com)
consumptions
optional
Number
number of consumptions on certain feature (this is optional, if not provided "1" is default)
Curl
Node.js
JS
Python
Ruby
|
import requests

url = "/api/v4/deactivate_license"

payload = "{\"hardware_id\":\"String\",\"product\":\"string\",\"feature\":\"string\",\"license_key\":\"string\",\"username\":\"string\",\"consumptions\":\"Number\"}"
headers = {
   'Accept': 'application/json',
   'Date': 'string',
   'Authorization': 'string'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

RESPONSES
200
400
|
{
    "unknown_product": "Provided product was not found",
    "license_not_found": "License with the provided license user not found",
    "license_not_enabled": "The license is not enabled",
    "device_not_found": "An active device matching the hardware_id not found.",
    "blacklisted": "This device is blacklisted",
    "license_not_active": "This license is not activated",
    "unsupported_product_feature": "One or more of requested product features     do not exists or they are not enabled on the product.",
    "Feature_not_enough_consumptions": "Not enough consumptions left."


List of exceptions

unknown_product (400): Provided product was not found
license_not_found (400): License with the provided license user not found
license_not_active (400): The license is not active
license_not_enabled (400): The license is not enabled
unsupported_product_feature (400): One or more of requested product features do not exists or they are not enabled on the product
feature_not_enough_consumptions (400): Not enough consumptions left
device_not_found (400): An active device matching the hardware_id not found
blacklisted (400): This device is blacklisted



Updated 22 Sep 2023
Did this page help you?
PREVIOUS
Adding Consumption
NEXT
Floating
Docs powered by
Archbee
/api/v4/add_feature_consumption
TABLE OF CONTENTS
POST
/api/v4/add_feature_consumption
List of exceptions
Docs powered by
Archbee