Update License Key Instance

PATCH

license_key_instances

{id}

JavaScript

import DodoPayments from 'dodopayments';

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

const licenseKeyInstance = await client.licenseKeyInstances.update('lki_123', { name: 'name' });

console.log(licenseKeyInstance.id);

from dodopayments import DodoPayments

client = DodoPayments(
    bearer_token="My Bearer Token",
)
license_key_instance = client.license_key_instances.update(
    id="lki_123",
    name="name",
)
print(license_key_instance.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"),
  )
  licenseKeyInstance, err := client.LicenseKeyInstances.Update(
    context.TODO(),
    "lki_123",
    dodopayments.LicenseKeyInstanceUpdateParams{
      Name: dodopayments.F("name"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", licenseKeyInstance.ID)
}

package com.dodopayments.api.example;

import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;
import com.dodopayments.api.models.licensekeyinstances.LicenseKeyInstance;
import com.dodopayments.api.models.licensekeyinstances.LicenseKeyInstanceUpdateParams;

public final class Main {
    private Main() {}

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

        LicenseKeyInstanceUpdateParams params = LicenseKeyInstanceUpdateParams.builder()
            .id("lki_123")
            .name("name")
            .build();
        LicenseKeyInstance licenseKeyInstance = client.licenseKeyInstances().update(params);
    }
}

package com.dodopayments.api.example

import com.dodopayments.api.client.DodoPaymentsClient
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient
import com.dodopayments.api.models.licensekeyinstances.LicenseKeyInstance
import com.dodopayments.api.models.licensekeyinstances.LicenseKeyInstanceUpdateParams

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

    val params: LicenseKeyInstanceUpdateParams = LicenseKeyInstanceUpdateParams.builder()
        .id("lki_123")
        .name("name")
        .build()
    val licenseKeyInstance: LicenseKeyInstance = client.licenseKeyInstances().update(params)
}

require "dodopayments"

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

license_key_instance = dodo_payments.license_key_instances.update("lki_123", name: "name")

puts(license_key_instance)

curl --request PATCH \
  --url https://test.dodopayments.com/license_key_instances/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://test.dodopayments.com/license_key_instances/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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",
  "id": "lki_123",
  "license_key_id": "lic_123",
  "name": "Production Server 1"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

License key instance ID

Body

application/json

name

string

required

Response

License key instance updated

business_id

string

required

created_at

string<date-time>

required

Example:

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

string

required

Example:

"lki_123"

license_key_id

string

required

Example:

"lic_123"

name

string

required

Example:

"Production Server 1"

⌘I

JavaScript

import DodoPayments from 'dodopayments';

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

const licenseKeyInstance = await client.licenseKeyInstances.update('lki_123', { name: 'name' });

console.log(licenseKeyInstance.id);

from dodopayments import DodoPayments

client = DodoPayments(
    bearer_token="My Bearer Token",
)
license_key_instance = client.license_key_instances.update(
    id="lki_123",
    name="name",
)
print(license_key_instance.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"),
  )
  licenseKeyInstance, err := client.LicenseKeyInstances.Update(
    context.TODO(),
    "lki_123",
    dodopayments.LicenseKeyInstanceUpdateParams{
      Name: dodopayments.F("name"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", licenseKeyInstance.ID)
}

package com.dodopayments.api.example;

import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;
import com.dodopayments.api.models.licensekeyinstances.LicenseKeyInstance;
import com.dodopayments.api.models.licensekeyinstances.LicenseKeyInstanceUpdateParams;

public final class Main {
    private Main() {}

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

        LicenseKeyInstanceUpdateParams params = LicenseKeyInstanceUpdateParams.builder()
            .id("lki_123")
            .name("name")
            .build();
        LicenseKeyInstance licenseKeyInstance = client.licenseKeyInstances().update(params);
    }
}

package com.dodopayments.api.example

import com.dodopayments.api.client.DodoPaymentsClient
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient
import com.dodopayments.api.models.licensekeyinstances.LicenseKeyInstance
import com.dodopayments.api.models.licensekeyinstances.LicenseKeyInstanceUpdateParams

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

    val params: LicenseKeyInstanceUpdateParams = LicenseKeyInstanceUpdateParams.builder()
        .id("lki_123")
        .name("name")
        .build()
    val licenseKeyInstance: LicenseKeyInstance = client.licenseKeyInstances().update(params)
}

require "dodopayments"

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

license_key_instance = dodo_payments.license_key_instances.update("lki_123", name: "name")

puts(license_key_instance)

curl --request PATCH \
  --url https://test.dodopayments.com/license_key_instances/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://test.dodopayments.com/license_key_instances/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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",
  "id": "lki_123",
  "license_key_id": "lic_123",
  "name": "Production Server 1"
}

API Reference

Checkout Sessions

Payments

Subscriptions

Discounts

Licenses

Customers

Customer Wallets

Products

Addons

Meters

Usage Events

Refunds

Disputes

Payouts

Brands

Webhooks

Miscellaneous

Authorizations

Path Parameters

Body

Response