列出许可证密钥实例

检索许可证密钥实例列表。可以选择通过license_key_id过滤以将结果限定在特定的许可证密钥上，或通过grant_id过滤以限定在授权范围内。

GET /license_key_instances

JavaScript

JavaScript

import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const licenseKeyInstance of client.licenseKeyInstances.list()) {
  console.log(licenseKeyInstance.id);
}

import os
from dodopayments import DodoPayments

client = DodoPayments(
    bearer_token=os.environ.get("DODO_PAYMENTS_API_KEY"),  # This is the default and can be omitted
)
page = client.license_key_instances.list()
page = page.items[0]
print(page.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"),
	)
	page, err := client.LicenseKeyInstances.List(context.TODO(), dodopayments.LicenseKeyInstanceListParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)
}

package com.dodopayments.api.example;

import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;
import com.dodopayments.api.models.licensekeyinstances.LicenseKeyInstanceListPage;
import com.dodopayments.api.models.licensekeyinstances.LicenseKeyInstanceListParams;

public final class Main {
    private Main() {}

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

        LicenseKeyInstanceListPage page = client.licenseKeyInstances().list();
    }
}

package com.dodopayments.api.example

import com.dodopayments.api.client.DodoPaymentsClient
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient
import com.dodopayments.api.models.licensekeyinstances.LicenseKeyInstanceListPage
import com.dodopayments.api.models.licensekeyinstances.LicenseKeyInstanceListParams

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

    val page: LicenseKeyInstanceListPage = client.licenseKeyInstances().list()
}

require "dodopayments"

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

page = dodo_payments.license_key_instances.list

puts(page)

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Dodopayments\Client;
use Dodopayments\Core\Exceptions\APIException;

$client = new Client(
  bearerToken: getenv('DODO_PAYMENTS_API_KEY') ?: 'My Bearer Token',
  environment: 'test_mode',
);

try {
  $page = $client->licenseKeyInstances->list(
    grantID: 'grant_id',
    licenseKeyID: 'license_key_id',
    pageNumber: 0,
    pageSize: 0,
  );

  var_dump($page);
} catch (APIException $e) {
  echo $e->getMessage();
}

using System;
using DodoPayments.Client;
using DodoPayments.Client.Models.LicenseKeyInstances;

DodoPaymentsClient client = new();

LicenseKeyInstanceListParams parameters = new();

var page = await client.LicenseKeyInstances.List(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}

use dodopayments::Client;

#[tokio::main]
async fn main() -> dodopayments::Result<()> {
    let client = Client::from_env()?;
    let result = client
        .license_key_instances()
        .list()
        .query(serde_json::json!({}))
        .await?;
    println!("{result:?}");
    Ok(())
}

curl --request GET \
  --url https://test.dodopayments.com/license_key_instances \
  --header 'Authorization: Bearer <token>'

200

{
  "items": [
    {
      "business_id": "<string>",
      "created_at": "2024-01-01T00:00:00.000Z",
      "id": "lki_123",
      "license_key_id": "lic_123",
      "name": "Production Server 1"
    }
  ]
}

授权

Authorization · string · header · 必填

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

查询参数

page_size · integer<int32> | null

Page size default is 10 max is 100

必填范围: x >= 0

page_number · integer<int32> | null

Page number default is 0

必填范围: x >= 0

license_key_id · string | null

Filter by license key ID

grant_id · string | null

Filter instances by entitlement grant ID

响应

200

application/json

items · object[] · 必填

Show child attributes