Nhận Quyền lợi

Lấy một quyền lợi đơn lẻ với cấu hình tích hợp đã được giải quyết. Đối với quyền lợi Tệp Kỹ thuật số, metadata của tệp và các URL tải xuống có chữ ký sẵn được điền trong phản hồi.

GET /entitlements/{id}

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
});

const entitlement = await client.entitlements.retrieve('id');

console.log(entitlement.id);

200

{
  "business_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "integration_config": {
    "target_id": "<string>"
  },
  "is_active": true,
  "metadata": {},
  "name": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>"
}

Ủy quyền

Authorization · string · header · bắt buộc

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

Tham số đường dẫn

id · string · bắt buộc

Entitlement ID

Phản hồi

200

application/json

Detailed view of a single entitlement: identity, integration type, integration-specific configuration, and metadata.

business_id · string · bắt buộc

Identifier of the business that owns this entitlement.

created_at · string<date-time> · bắt buộc

Timestamp when the entitlement was created.

id · string · bắt buộc

Unique identifier of the entitlement.

integration_config · Github Config · object · bắt buộc

Integration-specific configuration. For digital_files entitlements this includes presigned download URLs for each attached file.

Github Config

Discord Config

Telegram Config

Figma Config

Framer Config

Notion Config

Digital Files Config

License Key Config

Show child attributes

integration_type · enum<string> · bắt buộc

Platform integration this entitlement uses.

Tùy chọn có sẵn: discord, telegram, github, figma, framer, notion, digital_files, license_key

is_active · boolean · bắt buộc

Always true for entitlements returned by the public API; soft-deleted entitlements are not returned.

metadata · object · bắt buộc

Arbitrary key-value metadata supplied at creation or via PATCH.

Show child attributes

name · string · bắt buộc

Display name supplied at creation.

updated_at · string<date-time> · bắt buộc

Timestamp when the entitlement was last modified.

description · string | null

Optional description supplied at creation.