Chuyển đến nội dung chính
POST
/
grants
/
{grant_id}
/
license-key
`POST /grants/{grant_id}/license-key` — merchant fulfills a pending manual license-key grant by supplying the key value.
curl --request POST \
  --url https://test.dodopayments.com/grants/{grant_id}/license-key \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "key": "<string>",
  "activations_limit": 123,
  "expires_at": "2023-11-07T05:31:56Z"
}
'
{
  "business_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "customer_id": "<string>",
  "entitlement_id": "<string>",
  "id": "<string>",
  "metadata": {},
  "updated_at": "2023-11-07T05:31:56Z",
  "delivered_at": "2023-11-07T05:31:56Z",
  "digital_product_delivery": {
    "files": [
      {
        "download_url": "<string>",
        "expires_in": 123,
        "file_id": "<string>",
        "filename": "<string>",
        "content_type": "<string>",
        "file_size": 123
      }
    ],
    "external_url": "<string>",
    "instructions": "<string>"
  },
  "error_code": "<string>",
  "error_message": "<string>",
  "license_key": {
    "activations_used": 123,
    "key": "<string>",
    "activations_limit": 123,
    "expires_at": "2023-11-07T05:31:56Z"
  },
  "oauth_expires_at": "2023-11-07T05:31:56Z",
  "oauth_url": "<string>",
  "payment_id": "<string>",
  "revocation_reason": "<string>",
  "revoked_at": "2023-11-07T05:31:56Z",
  "subscription_id": "<string>"
}
Chỉ sử dụng endpoint này cho các cấp phép được tạo dưới một License Key entitlement với fulfillment_mode: manual. Cấp phép phải ở trạng thái pending và không có khóa đính kèm. Xem Thực Hiện Thủ Công và Hướng Dẫn Tích Hợp Thực Hiện Cấp Phép Khóa Bản Quyền Thủ Công để biết quy trình đầy đủ.

Ủ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

​
grant_id
string
bắt buộc

Grant ID

Nội dung

application/json

Request body for manually fulfilling a pending license-key grant.

​
key
string
bắt buộc

The license key string to deliver to the customer.

​
activations_limit
integer<int32> | null

Optional per-key activation limit; falls back to the entitlement config.

​
expires_at
string<date-time> | null

Optional per-key expiry; falls back to the entitlement config's duration.

Phản hồi

Detailed view of a single entitlement grant: who it's for, its lifecycle state, and any integration-specific delivery payload.

​
business_id
string
bắt buộc

Identifier of the business that owns the grant.

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

Timestamp when the grant was created.

​
customer_id
string
bắt buộc

Identifier of the customer the grant was issued to.

​
entitlement_id
string
bắt buộc

Identifier of the entitlement this grant was issued from.

​
id
string
bắt buộc

Unique identifier of the grant.

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

The integration type of the grant's entitlement (e.g. license_key).

Tùy chọn có sẵn:
discord,
telegram,
github,
figma,
framer,
notion,
digital_files,
license_key
​
metadata
object
bắt buộc

Arbitrary key-value metadata recorded on the grant.

​
status
enum<string>
bắt buộc

Lifecycle status of the grant.

Tùy chọn có sẵn:
Pending,
Delivered,
Failed,
Revoked
​
updated_at
string<date-time>
bắt buộc

Timestamp when the grant was last modified.

​
delivered_at
string<date-time> | null

Timestamp when the grant transitioned to delivered, when applicable.

​
digital_product_delivery
Digital Product Delivery · object

Digital-product-delivery payload, present when the entitlement integration is digital_files.

​
error_code
string | null

Machine-readable code reported when delivery failed, when applicable.

​
error_message
string | null

Human-readable message reported when delivery failed, when applicable.

​
license_key
object

License-key delivery payload, present when the entitlement integration is license_key.

​
oauth_expires_at
string<date-time> | null

Timestamp when oauth_url stops being valid, when applicable.

​
oauth_url
string | null

Customer-facing OAuth URL for OAuth-style integrations. Populated during the customer-portal accept flow; null until the customer completes that step, and on grants for non-OAuth integrations.

​
payment_id
string | null

Identifier of the payment that triggered this grant, when applicable.

​
revocation_reason
string | null

Reason recorded when the grant was revoked, when applicable.

​
revoked_at
string<date-time> | null

Timestamp when the grant transitioned to revoked, when applicable.

​
subscription_id
string | null

Identifier of the subscription that triggered this grant, when applicable.

Last modified on June 9, 2026