Management API
License

Import Licenses From CSV

5min
imports licenses from csv, if requesting manager has access permissions to it url /api/v1/licenses/import from csv/ method post content type required content type is multipart/form data with the following single key value pair key file value {csv file from which to import} required csv headers license license key product short code possible csv headers customer last name last name of the customer customer company name name of the company the customer is associated with customer phone phone number of the customer customer reference unique identifier or reference number for the customer customer address address of the customer customer postcode postal code associated with the customer's address customer state state or region of the customer's address customer city city of the customer's address customer country country of the customer's address order store id unique identifier for the store from which the order was made order type type of order order is test boolean flag indicating whether the order is a test order order is trial boolean flag indicating whether the order is for a trial product order download id unique identifier for any digital products that may need to be downloaded as part of the order order language language preference for the order order campaign params parameters related to any marketing campaign associated with the order license license key unique license key license enabled boolean flag indicating whether the license is active and valid license max activations maximum number of activations permitted for the license license allow unlimited activations permits unlimited activations for the license license validity period period during which the license is valid license valid duration the exact duration the license is valid for license license type the type of license(perpetual, time limited, subscription, consumption) license enable maintenance period boolean flag indicating whether a maintenance period is enabled for the license license maintenance period the duration of the maintenance period for the license used to set the date when maintenance will end for this license, license enable maintenance period must also be set for it to take effect format yyyy mm dd example 2023 09 15 license maintenance duration the duration of the maintenance period for the license license is trial boolean flag indicating whether the license is a trial license license max consumptions maximum number of uses allowed license subscription id identifier for any subscription plan associated with the license license prevent vm boolean flag indicating whether the license prevents use in virtual machines license allow overages boolean flag indicating whether overages are allowed license max overages maximum allowable overages for the license license reset consumption boolean flag indicating whether the consumption count for the license resets after a certain period license consumption period period after which the consumption count resets license trial days number of days for which the trial license is valid license is floating boolean flag indicating whether the license is a floating license license is floating cloud boolean flag indicating whether the license is a cloud based floating license license floating users maximum number of concurrent users allowed under a floating license license note additional notes or information about the license license max license users maximum number of users who can use a single license license floating timeout period of inactivity after which a floating license is released for use by another user product short code short identifier or code for the product associated with the license data example customer email,order store id,license license key,product short code example1\@email com,pn7xxkucrdsadasdy9s2xsscyq,impo rtor derk ey00,psc example1\@email com,pn7xxkucrdsadasdy9s2xsscyq,impo rtor derk ey01,psc success response code 200 ok content examples { "job id" 10 } job id from response can be used to query the import result