Verify a License

Endpoint

POST https://api.gumroad.com/v2/licenses/verify

Verifies that a license key is valid for a given product. This endpoint can optionally increment a usage counter to track how many times a license has been verified. This is commonly used for software licensing to validate customer purchases.

This endpoint does not require authentication and can be called from your application without an access token.

Request Parameters

string

required

The license key to verify (typically found in the purchase receipt)

string

The unique identifier for your product. This parameter is recommended and may be required for products created after a certain date.

string

The product’s permalink (either unique or custom). Can be used instead of product_id.

boolean

default:"true"

Whether to increment the usage counter for this license. Set to false to verify without tracking usage.

Response Fields

boolean

Whether the license verification was successful

integer

The number of times this license has been verified (with increment_uses_count=true)

object

Information about the purchase associated with this license

string

Encrypted purchase ID

string

Name of the product

string

Encrypted product ID

string

Full URL to the product page

string

Short unique identifier for the product

string

Email address of the purchaser

integer

Purchase price in cents

string

Currency code (e.g., “usd”)

integer

Quantity purchased

string

Timestamp when the purchase was created

string

Timestamp of the sale

integer

Numeric order number

string

The license key (same as the verified key, or new key if rotated)

string

Comma-separated list of variant options selected

array

Array of custom field responses from the purchase form

boolean

Whether the purchase has been refunded

boolean

Whether the purchase has been charged back

string

If this is a subscription, when it ended

string

If this is a subscription, when it was cancelled

string

If this is a subscription, when the last payment failed

boolean

Whether the customer agreed to be contacted

Examples

Verify a license with usage tracking

curl -X POST https://api.gumroad.com/v2/licenses/verify \
  -d "product_id=your-product-id" \
  -d "license_key=ABCD1234-EFGH5678-IJKL9012-MNOP3456"

import requests

response = requests.post(
    'https://api.gumroad.com/v2/licenses/verify',
    data={
        'product_id': 'your-product-id',
        'license_key': 'ABCD1234-EFGH5678-IJKL9012-MNOP3456'
    }
)

print(response.json())

const response = await fetch('https://api.gumroad.com/v2/licenses/verify', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/x-www-form-urlencoded',
  },
  body: new URLSearchParams({
    product_id: 'your-product-id',
    license_key: 'ABCD1234-EFGH5678-IJKL9012-MNOP3456'
  })
});

const data = await response.json();
console.log(data);

Verify without incrementing usage

curl -X POST https://api.gumroad.com/v2/licenses/verify \
  -d "product_id=your-product-id" \
  -d "license_key=ABCD1234-EFGH5678-IJKL9012-MNOP3456" \
  -d "increment_uses_count=false"

Success Response

{
  "success": true,
  "uses": 1,
  "purchase": {
    "id": "encrypted_purchase_id",
    "product_name": "My Software",
    "product_id": "encrypted_product_id",
    "product_permalink": "https://gumroad.com/l/my-software",
    "short_product_id": "my-software",
    "email": "customer@example.com",
    "price": 2999,
    "currency": "usd",
    "quantity": 1,
    "created_at": "2024-01-15T10:30:00Z",
    "sale_timestamp": "2024-01-15T10:30:00Z",
    "order_number": 123456,
    "license_key": "ABCD1234-EFGH5678-IJKL9012-MNOP3456",
    "variants": "",
    "custom_fields": [],
    "refunded": false,
    "chargebacked": false,
    "subscription_ended_at": null,
    "subscription_cancelled_at": null,
    "subscription_failed_at": null,
    "can_contact": true
  }
}

Error Responses

Invalid License Key (404)

{
  "success": false,
  "message": "That license does not exist for the provided product."
}

Disabled License (404)

{
  "success": false,
  "message": "This license key has been disabled."
}

Access Revoked (404)

{
  "success": false,
  "message": "Access to the purchase associated with this license has expired."
}

Missing product_id (500)

For products created after a certain date, the product_id parameter is required. If you receive this error, make sure to include the product_id in your request.

{
  "success": false,
  "message": "The 'product_id' parameter is required to verify the license for this product. Please set 'product_id' to 'your-product-id' in the request."
}

Common Use Cases

Software Activation

When a customer launches your software for the first time, call this endpoint to validate their license key. You can use the increment_uses_count parameter to track activations.

Periodic License Checks

For ongoing validation, set increment_uses_count=false to verify the license is still valid without inflating the usage counter.

Subscription Status

Check the subscription_ended_at, subscription_cancelled_at, and subscription_failed_at fields to determine if a subscription-based license is still active.

Getting Started

Products

Sales

Licenses

Subscribers

Other Resources

Verify a License

Endpoint

Request Parameters

Response Fields

Examples

Verify a license with usage tracking

Verify without incrementing usage

Success Response

Error Responses

Invalid License Key (404)

Disabled License (404)

Access Revoked (404)

Missing product_id (500)

Common Use Cases

Software Activation

Periodic License Checks

Subscription Status

​Endpoint

​Request Parameters

​Response Fields

​Examples

​Verify a license with usage tracking

​Verify without incrementing usage

​Success Response

​Error Responses

​Invalid License Key (404)

​Disabled License (404)

​Access Revoked (404)

​Missing product_id (500)

​Common Use Cases

​Software Activation

​Periodic License Checks

​Subscription Status

Endpoint

Request Parameters

Response Fields

Examples

Verify a license with usage tracking

Verify without incrementing usage

Success Response

Error Responses

Invalid License Key (404)

Disabled License (404)

Access Revoked (404)

Missing product_id (500)

Common Use Cases

Software Activation

Periodic License Checks

Subscription Status