Activate License

POST

licenses

activate

JavaScript

import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: 'My Bearer Token',
});

const response = await client.licenses.activate({ license_key: 'license_key', name: 'name' });

console.log(response.id);

from dodopayments import DodoPayments

client = DodoPayments(
    bearer_token="My Bearer Token",
)
response = client.licenses.activate(
    license_key="license_key",
    name="name",
)
print(response.id)

package main

import (
  "context"
  "fmt"

  "github.com/dodopayments/dodopayments-go"
  "github.com/dodopayments/dodopayments-go/option"
)

func main() {
  client := dodopayments.NewClient(
    option.WithBearerToken("My Bearer Token"),
  )
  response, err := client.Licenses.Activate(context.TODO(), dodopayments.LicenseActivateParams{
    LicenseKey: dodopayments.F("license_key"),
    Name: dodopayments.F("name"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.ID)
}

package com.dodopayments.api.example;

import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;
import com.dodopayments.api.models.licenses.LicenseActivateParams;
import com.dodopayments.api.models.licenses.LicenseActivateResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        DodoPaymentsClient client = DodoPaymentsOkHttpClient.fromEnv();

        LicenseActivateParams params = LicenseActivateParams.builder()
            .licenseKey("license_key")
            .name("name")
            .build();
        LicenseActivateResponse response = client.licenses().activate(params);
    }
}

package com.dodopayments.api.example

import com.dodopayments.api.client.DodoPaymentsClient
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient
import com.dodopayments.api.models.licenses.LicenseActivateParams
import com.dodopayments.api.models.licenses.LicenseActivateResponse

fun main() {
    val client: DodoPaymentsClient = DodoPaymentsOkHttpClient.fromEnv()

    val params: LicenseActivateParams = LicenseActivateParams.builder()
        .licenseKey("license_key")
        .name("name")
        .build()
    val response: LicenseActivateResponse = client.licenses().activate(params)
}

require "dodopayments"

dodo_payments = Dodopayments::Client.new(
  bearer_token: "My Bearer Token",
  environment: "test_mode" # defaults to "live_mode"
)

response = dodo_payments.licenses.activate(license_key: "license_key", name: "name")

puts(response)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://test.dodopayments.com/licenses/activate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'license_key' => '<string>',
    'name' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "business_id": "<string>",
  "created_at": "2024-01-01T00:00:00Z",
  "customer": {
    "customer_id": "<string>",
    "email": "<string>",
    "name": "<string>",
    "metadata": {},
    "phone_number": "<string>"
  },
  "id": "lki_123",
  "license_key_id": "lic_123",
  "name": "Production Server 1",
  "product": {
    "product_id": "<string>",
    "name": "<string>"
  }
}

No API Key Required: This is a public endpoint that does not require authentication. You can call it directly from client applications, desktop software, or CLIs to activate license keys without exposing your API credentials.

Body

application/json

license_key

string

required

name

string

required

Response

License key instance created

business_id

string

required

Business ID

created_at

string<date-time>

required

Creation timestamp

Example:

"2024-01-01T00:00:00Z"

customer

object

required

Limited customer details associated with the license key.

Show child attributes

string

required

License key instance ID

Example:

"lki_123"

license_key_id

string

required

Associated license key ID

Example:

"lic_123"

name

string

required

Instance name

Example:

"Production Server 1"

product

object

required

Related product info. Present if the license key is tied to a product.

Show child attributes

⌘I

JavaScript

import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: 'My Bearer Token',
});

const response = await client.licenses.activate({ license_key: 'license_key', name: 'name' });

console.log(response.id);

from dodopayments import DodoPayments

client = DodoPayments(
    bearer_token="My Bearer Token",
)
response = client.licenses.activate(
    license_key="license_key",
    name="name",
)
print(response.id)

package main

import (
  "context"
  "fmt"

  "github.com/dodopayments/dodopayments-go"
  "github.com/dodopayments/dodopayments-go/option"
)

func main() {
  client := dodopayments.NewClient(
    option.WithBearerToken("My Bearer Token"),
  )
  response, err := client.Licenses.Activate(context.TODO(), dodopayments.LicenseActivateParams{
    LicenseKey: dodopayments.F("license_key"),
    Name: dodopayments.F("name"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.ID)
}

package com.dodopayments.api.example;

import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;
import com.dodopayments.api.models.licenses.LicenseActivateParams;
import com.dodopayments.api.models.licenses.LicenseActivateResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        DodoPaymentsClient client = DodoPaymentsOkHttpClient.fromEnv();

        LicenseActivateParams params = LicenseActivateParams.builder()
            .licenseKey("license_key")
            .name("name")
            .build();
        LicenseActivateResponse response = client.licenses().activate(params);
    }
}

package com.dodopayments.api.example

import com.dodopayments.api.client.DodoPaymentsClient
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient
import com.dodopayments.api.models.licenses.LicenseActivateParams
import com.dodopayments.api.models.licenses.LicenseActivateResponse

fun main() {
    val client: DodoPaymentsClient = DodoPaymentsOkHttpClient.fromEnv()

    val params: LicenseActivateParams = LicenseActivateParams.builder()
        .licenseKey("license_key")
        .name("name")
        .build()
    val response: LicenseActivateResponse = client.licenses().activate(params)
}

require "dodopayments"

dodo_payments = Dodopayments::Client.new(
  bearer_token: "My Bearer Token",
  environment: "test_mode" # defaults to "live_mode"
)

response = dodo_payments.licenses.activate(license_key: "license_key", name: "name")

puts(response)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://test.dodopayments.com/licenses/activate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'license_key' => '<string>',
    'name' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "business_id": "<string>",
  "created_at": "2024-01-01T00:00:00Z",
  "customer": {
    "customer_id": "<string>",
    "email": "<string>",
    "name": "<string>",
    "metadata": {},
    "phone_number": "<string>"
  },
  "id": "lki_123",
  "license_key_id": "lic_123",
  "name": "Production Server 1",
  "product": {
    "product_id": "<string>",
    "name": "<string>"
  }
}

API Reference

Checkout Sessions

Payments

Subscriptions

Discounts

Licenses

Customers

Customer Wallets

Products

Addons

Meters

Usage Events

Refunds

Disputes

Payouts

Brands

Webhooks

Miscellaneous

Body

Response