Skip to main content
POST
/
grants
/
{grant_id}
/
license-key
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 entitlementGrant = await client.entitlements.grants.fulfillLicenseKey(
  'entg_w0ZCJZgNXuNDdMVzvja6p',
  { key: 'key' },
);

console.log(entitlementGrant.id);
{
  "brand_id": "<string>",
  "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>"
}
Use this endpoint only for grants created under a License Key entitlement with fulfillment_mode: manual. The grant must be in pending status with no key attached. See Manual Fulfillment and the Manual License Key Fulfillment Integration Guide for the full flow.

Authorizations

Authorization
string
header
required

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

Path Parameters

grant_id
string
required

Grant ID

Body

application/json

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

key
string
required

The license key value to deliver to the customer.

activations_limit
integer<int32> | null

Per-key activation limit. Defaults to the entitlement's license-key configuration.

expires_at
string<date-time> | null

When the key expires. Defaults to the duration in the entitlement's license-key configuration.

Response

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

brand_id
string
required

Brand id this grant belongs to.

business_id
string
required

Identifier of the business that owns the grant.

created_at
string<date-time>
required

Timestamp when the grant was created.

customer_id
string
required

Identifier of the customer the grant was issued to.

entitlement_id
string
required

Identifier of the entitlement this grant was issued from.

id
string
required

Unique identifier of the grant.

integration_type
enum<string>
required

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

Available options:
discord,
telegram,
github,
figma,
framer,
notion,
digital_files,
license_key
metadata
object
required

Arbitrary key-value metadata recorded on the grant.

status
enum<string>
required

Lifecycle status of the grant.

Available options:
Pending,
Delivered,
Failed,
Revoked
updated_at
string<date-time>
required

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 8, 2026