Import Licenses From CSV

Import licenses from CSV, if the requesting manager has access permissions to it.

Ensure that all text fields in your CSV use ASCII characters. Non-ASCII characters (such as “ä”, “ñ”, or other special symbols) can cause import errors. To avoid issues, remove or replace these characters before uploading your file.

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
[email protected],pn7XXkuCRdsadasdy9S2XSsCYQ,impo-rtor-derk-ey00,psc
[email protected],pn7XXkuCRdsadasdy9S2XSsCYQ,impo-rtor-derk-ey01,psc

Success Response

Code: 200 OK

Content example:

{
    "job_id": 10
}

job_id from the response can be used to query the import result.