Gumroad API

https://gumroad.com/api
Admin
Gumroad's OAuth 2.0 API lets you see information about your products, as well as you can add, edit,...
Tokens:64,071
Snippets:359
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Product update response example

Source: https://gumroad.com/api

Example response showing file ID mappings after a successful product update.

```json
{
  "success": true,
  "file_id_mappings": { "cli-upload-1": "NEW_FILE_ID" }
}
```

--------------------------------

### Schedule Email Response Example

Source: https://gumroad.com/api

Example JSON response after successfully scheduling an email.

```json
{
  "success": true,
  "email": {
    "id": "bfi_30HLgGWL8H2wo_Gzlg==",
    "subject": "Launch update",
    "message": "<p>Hello, world!</p>",
    "audience_type": "audience",
    "product_id": null,
    "state": "scheduled",
    "published_at": null,
    "scheduled_at": "2026-07-01T18:00:00.000Z",
    "send_emails": true,
    "shown_on_profile": false,
    "audience_count": null,
    "recipients_count": null,
    "url": null,
    "created_at": "2026-06-17T12:00:00.000Z",
    "updated_at": "2026-06-17T12:00:00.000Z"
  }
}
```

--------------------------------

### Create Product via CLI

Source: https://gumroad.com/api

Example of creating a product using the Gumroad CLI.

```bash
  --name "Pencil Icon PSD v2" \
  --max-purchase-count 100
```

--------------------------------

### Enable a License

Source: https://gumroad.com/api

Examples for enabling a product license using cURL or the Gumroad CLI.

```bash
curl https://api.gumroad.com/v2/licenses/enable \
  -d "access_token=ACCESS_TOKEN" \
  -d "product_id=32-nPAicqbLj8B_WswVlMw==" \
  -d "license_key=A1B2C3D4-E5F60718-9ABCDEF0-1234ABCD" \
  -X PUT
```

```bash
echo "A1B2C3D4-E5F60718-9ABCDEF0-1234ABCD" | gumroad licenses enable \
  --product 32-nPAicqbLj8B_WswVlMw==
```

--------------------------------

### Subscriber Response Example

Source: https://gumroad.com/api

Example JSON response structure for a subscriber query.

```json
{
  "success":true,
  "subscribers": {
    "id": "P5ppE6H8XIjy2JSCgUhbAw==",
    "product_id": "0ssD7adjRklGBjS5cwlWPq==",
    "product_name":"Pencil Icon PSD",
    "user_id": "3523953790232",
    "user_email":"calvin@gumroad.com",
    "purchase_ids": [O4pjE6H8XNjy2JSCgKhbAw==],
    "created_at": "2015-06-30T17:38:04Z",
    "user_requested_cancellation_at": null,
    "charge_occurrence_count": null,
    "recurrence": "monthly",
    "cancelled_at": null,
    "ended_at": null,
    "failed_at": null,
    "free_trial_ends_at": null,
    "license_key": "85DB562A-C11D4B06-A2335A6B-8C079166",
    "status": "alive"
  }
}
```

--------------------------------

### Install Gumroad CLI

Source: https://gumroad.com/api

Installation methods for the Gumroad command line interface using Homebrew or a shell script.

```bash
brew install antiwork/cli/gumroad
```

```bash
curl -fsSL https://gumroad.com/install-cli.sh | bash
```

--------------------------------

### Product Creation Response

Source: https://gumroad.com/api

Example JSON response returned after successfully creating a product.

```json
{
  "success": true,
  "product": {
    "id": "A-m3CDDC5dlrSdKZp0RFhA==",
    "name": "Pencil Icon PSD",
    "price": 100,
    "currency": "usd",
    "taxonomy_id": 123,
    "category": "design/ui-and-web/figma",
    "category_label": "Figma",
    "published": false,
    "files": [],
    "covers": [],
    "main_cover_id": null,
    "rich_content": [],
    "has_same_rich_content_for_all_variants": true
```

--------------------------------

### GET /products

Source: https://gumroad.com/api

Retrieve all of the existing products for the authenticated user.

```APIDOC
## GET /products

### Description
Retrieve all of the existing products for the authenticated user.

### Method
GET

### Endpoint
https://api.gumroad.com/v2/products

### Response
#### Success Response (200)
- **success** (boolean) - Whether the request succeeded
- **products** (array) - Array of product objects
- **id** (string) - Unique identifier for the product
- **name** (string) - Product name
- **description** (string | null) - Product description
- **price** (number) - Price in cents
- **currency** (string) - ISO currency code
- **published** (boolean) - Whether the product is published
- **deleted** (boolean) - Whether the product has been deleted
- **short_url** (string) - Short Gumroad URL for the product
```

--------------------------------

### Verify a License

Source: https://gumroad.com/api

Examples for verifying a product license using cURL or the Gumroad CLI.

```bash
curl https://api.gumroad.com/v2/licenses/verify \
  -d "product_id=32-nPAicqbLj8B_WswVlMw==" \
  -d "license_key=A1B2C3D4-E5F60718-9ABCDEF0-1234ABCD" \
  -X POST
```

```bash
echo "A1B2C3D4-E5F60718-9ABCDEF0-1234ABCD" | gumroad licenses verify \
  --product 32-nPAicqbLj8B_WswVlMw==
```

--------------------------------

### Preview Response Example

Source: https://gumroad.com/api

The JSON structure returned after a successful preview request.

```json
{
  "success": true,
  "email": {
    "id": "bfi_30HLgGWL8H2wo_Gzlg==",
    "subject": "Launch update",
    "message": "<p>Hello, world!</p>",
    "audience_type": "audience",
    "product_id": null,
    "state": "draft",
    "published_at": null,
    "scheduled_at": null,
    "send_emails": true,
    "shown_on_profile": false,
    "audience_count": null,
    "recipients_count": null,
    "url": null,
    "created_at": "2026-06-17T12:00:00.000Z",
    "updated_at": "2026-06-17T12:00:00.000Z"
  },
  "preview_url": "https://gumroad.com/emails/bfi_30HLgGWL8H2wo_Gzlg==/edit?preview_post=true",
  "message": "A preview has been sent to your email."
}
```

--------------------------------

### Add a Product Cover Response

Source: https://gumroad.com/api

Example JSON response after successfully adding a cover.

```json
{
  "success": true,
  "covers": [{
    "id": "abc123",
    "url": "https://www.youtube.com/embed/qKebcV1jv3A?feature=oembed&enablejsapi=1",
    "original_url": "https://www.youtube.com/embed/qKebcV1jv3A?feature=oembed&enablejsapi=1",
    "thumbnail": "https://i.ytimg.com/vi/qKebcV1jv3A/hqdefault.jpg",
    "type": "oembed",
    "filetype": null,
    "width": 670,
    "height": 377,
    "native_width": 1280,
    "native_height": 720
  }],
  "main_cover_id": "abc123"
}
```

--------------------------------

### Set Product Thumbnail Response

Source: https://gumroad.com/api

Example JSON response after successfully setting a product thumbnail.

```json
{
  "success": true,
  "thumbnail": {
    "url": "https://public-files.gumroad.com/variants/72iaezqqthnj1350mdc618namqki/f2f9c6fc18a80b8bafa38f3562360c0e42507f1c0052dcb708593f7efa3bdab8",
    "guid": "abc123"
  }
}
```

--------------------------------

### Custom Fields Response Example

Source: https://gumroad.com/api

Example JSON response structure for retrieving custom fields.

```json
{
  "success": true,
  "custom_fields": [{
    "name": "phone number",
    "required": "false"
  }, {...}, {...}]
}
```

--------------------------------

### Create Variant Response Example

Source: https://gumroad.com/api

Example JSON response structure for a create variant request.

```json
{
  "success": true,
  "variant": {
    "id": "lSC1XVfr2TC3WoCGY7YrUg==",
    "max_purchase_count": null,
    "name": "red",
    "price_difference_cents": 100
  }
}
```

--------------------------------

### Product API Response Example

Source: https://gumroad.com/api

A sample JSON response showing the structure of a product object.

```json
{
  "success": true,
  "product": {
    "custom_permalink": null,
    "custom_receipt": null,
    "custom_summary": "You'll get one PSD file.",
    "custom_fields": [],
    "customizable_price": null,
    "description": "I made this for fun.",
    "deleted": false,
    "max_purchase_count": null,
    "name": "Pencil Icon PSD",
    "preview_url": null,
    "require_shipping": false,
    "subscription_duration": null,
    "published": true,
    "url": null, # Deprecated, always null
    "id": "A-m3CDDC5dlrSdKZp0RFhA==",
    "price": 100,
    "purchasing_power_parity_prices": {
      "US": 100,
      "IN": 50,
      "EC": 25
    },
    "currency": "usd",
```

--------------------------------

### GET /products/:product_id/offer_codes

Source: https://gumroad.com/api

Retrieve all of the existing offer codes for a product.

```APIDOC
## GET /products/:product_id/offer_codes

### Description
Retrieve all of the existing offer codes for a product. Either amount_cents or percent_off will be returned depending if the offer code is a fixed amount off or a percentage off.

### Method
GET

### Endpoint
https://api.gumroad.com/v2/products/:product_id/offer_codes

### Parameters
#### Path Parameters
- **product_id** (string) - Required - The unique identifier of the product.

### Response
#### Success Response (200)
- **success** (boolean) - Whether the request succeeded
- **offer_codes** (array) - Array of offer code objects

#### Response Example
{
  "success": true,
  "offer_codes": [{
    "id": "mN7CdHiwHaR9FlxKvF-n-g==",
    "name": "1OFF",
    "amount_cents": 100,
    "max_purchase_count": null,
    "universal": false,
    "times_used": 1
  }]
}
```

--------------------------------

### Retrieve product details

Source: https://gumroad.com/api

Examples for fetching product information using cURL and the Gumroad CLI.

```bash
curl https://api.gumroad.com/v2/products/A-m3CDDC5dlrSdKZp0RFhA== \
  -d "access_token=ACCESS_TOKEN" \
  -X GET
```

```bash
gumroad products show A-m3CDDC5dlrSdKZp0RFhA==
```

--------------------------------

### Example product list response

Source: https://gumroad.com/api

A sample JSON response structure for a product list request.

```json
{
  "success": true,
  "products": [{
    "custom_permalink": null,
    "custom_receipt": null,
    "custom_summary": "You'll get one PSD file.",
    "custom_fields": [],
    "customizable_price": null,
    "description": "I made this for fun.",
    "deleted": false,
    "max_purchase_count": null,
    "name": "Pencil Icon PSD",
    "preview_url": null,
    "require_shipping": false,
    "subscription_duration": null,
    "published": true,
    "url": null, # Deprecated, always null
    "id": "A-m3CDDC5dlrSdKZp0RFhA==",
    "price": 100,
    "taxonomy_id": 123,
    "category": "design/ui-and-web/figma",
    "category_label": "Figma",
    "purchasing_power_parity_prices": {
      "US": 100,
      "IN": 50,
      "EC": 25
    },
    "currency": "usd",
    "short_url": "https://sahil.gumroad.com/l/pencil",
    "thumbnail_url": "https://public-files.gumroad.com/variants/72iaezqqthnj1350mdc618namqki/f2f9c6fc18a80b8bafa38f3562360c0e42507f1c0052dcb708593f7efa3bdab8",
    "tags": ["pencil", "icon"],
    "formatted_price": "$1",
    "file_info": {},
    "sales_count": 0, # available with the 'view_sales' or 'account' scope
    "sales_usd_cents": 0, # available with the 'view_sales' or 'account' scope
    "is_tiered_membership": true,
    "recurrences": ["monthly"], # if is_tiered_membership is true, renders list of available subscription durations; otherwise null
    "variants": [
      {
        "title": "Tier",
        "options": [
          {
            "name": "First Tier",
            "price_difference": 0, # 0 for tiered membership options; non-zero for non-membership options with a price bump
            "purchasing_power_parity_prices": { # present when PPP is enabled for the seller and the product has not opted out; null when price_difference is null
              "US": 200,
              "IN": 100,
              "EC": 50
            },
            "is_pay_what_you_want": false,
            "recurrence_prices": { # present for membership products; otherwise null
              "monthly": {
                "price_cents": 300,
                "suggested_price_cents": null, # may return number if is_pay_what_you_want is true
                "purchasing_power_parity_prices": {
                  "US": 400,
                  "IN": 200,
                  "EC": 100
                }
              }
            }
          }
        ]
      }
    ]
  }, {...}, {...}]
}
```

--------------------------------

### GET /v2/products

Source: https://gumroad.com/api

Retrieve a list of products associated with the authenticated account.

```APIDOC
## GET /v2/products

### Description
Retrieve a list of products for the authenticated seller.

### Method
GET

### Endpoint
https://api.gumroad.com/v2/products

### Response
#### Success Response (200)
- **success** (boolean) - Whether the request succeeded
- **products** (array) - List of product objects
- **next_page_key** (string) - Opaque cursor to fetch the next page
- **next_page_url** (string) - Path-relative URL for the next page

### Response Example
{
  "success": true,
  "products": [
    {
      "id": "A-m3CDDC5dlrSdKZp0RFhA==",
      "name": "Pencil Icon PSD",
      "price": 100
    }
  ]
}
```

--------------------------------

### Retrieve Sale Details

Source: https://gumroad.com/api

Examples for fetching specific sale information using cURL or the Gumroad CLI.

```bash
curl https://api.gumroad.com/v2/sales/FO8TXN-dvxYabdavG97Y-Q== \
  -d "access_token=ACCESS_TOKEN" \
  -X GET
```

```bash
gumroad sales view FO8TXN-dvxYabdavG97Y-Q==
```

--------------------------------

### List offer codes example response

Source: https://gumroad.com/api

JSON structure returned when listing offer codes.

```json
{
  "success": true,
  "offer_codes": [{
    "id": "mN7CdHiwHaR9FlxKvF-n-g==",
    "name": "1OFF",
    "amount_cents": 100,
    "max_purchase_count": null,
    "universal": false,
    "times_used": 1
  }, {
    "id": "l5C1XQfr2TG3WXcGY7-r-g==",
    "name": "HALFOFF",
    "percent_off": 50,
    "max_purchase_count": null,
    "universal": false,
    "times_used": 1
  }, {...}, {...}]
}
```

--------------------------------

### Send Email Response Example

Source: https://gumroad.com/api

The JSON structure returned after successfully publishing an email.

```json
{
  "success": true,
  "email": {
    "id": "bfi_30HLgGWL8H2wo_Gzlg==",
    "subject": "Launch update",
    "message": "<p>Hello, world!</p>",
    "audience_type": "audience",
    "product_id": null,
    "state": "published",
    "published_at": "2026-06-17T12:15:00.000Z",
    "scheduled_at": null,
    "send_emails": true,
    "shown_on_profile": false,
    "audience_count": null,
    "recipients_count": 0,
    "url": "https://seller.gumroad.com/p/launch-update",
    "created_at": "2026-06-17T12:00:00.000Z",
    "updated_at": "2026-06-17T12:15:00.000Z"
  }
}
```

--------------------------------

### List Media Library Response

Source: https://gumroad.com/api

Example JSON response containing a list of media objects.

```json
{
  "success": true,
  "media": [
    {
      "id": "k7m2q9x4tb1zn6dw",
      "name": "logo",
      "extension": "PNG",
      "file_size": 18422,
      "url": "https://public-files.gumroad.com/abc123/logo.png",
      "status": { "type": "saved" },
      "file_group": "image",
      "created_at": "2026-03-01T12:00:00Z"
    }
  ]
}
```

--------------------------------

### GET /products/:product_id/offer_codes/:id

Source: https://gumroad.com/api

Retrieve the details of a specific offer code of a product.

```APIDOC
## GET /products/:product_id/offer_codes/:id

### Description
Retrieve the details of a specific offer code of a product.

### Method
GET

### Endpoint
https://api.gumroad.com/v2/products/:product_id/offer_codes/:id

### Parameters
#### Path Parameters
- **product_id** (string) - Required - The unique identifier of the product.
- **id** (string) - Required - The unique identifier of the offer code.

### Response
#### Success Response (200)
- **success** (boolean) - Whether the request succeeded
- **offer_code** (object) - The offer code object

#### Response Example
{
  "success": true,
  "offer_code": {
    "id": "mN7CdHiwHaR9FlxKvF-n-g==",
    "name": "1OFF",
    "amount_cents": 100,
    "max_purchase_count": null,
    "times_used": 1
  }
}
```

--------------------------------

### Retrieve Custom HTML

Source: https://gumroad.com/api

Get the custom HTML landing page configuration for the user profile.

```text
https://api.gumroad.com/v2/user/custom_html
```

--------------------------------

### Subscription Update Payload Example

Source: https://gumroad.com/api

Example JSON structure for a subscription_updated event notification.

```json
{
  ...
  type: "upgrade",
  effective_as_of: "2021-02-23T16:31:44Z",
  old_plan: {
    tier: { id: "G_-mnBf9b1j9A7a4ub4nFQ==", name: "Basic tier" },
    recurrence: "monthly",
    price_cents: "1000",
    quantity: 1
  },
  new_plan: {
    tier: { id: "G_-mnBf9b1j9A7a4ub4nFQ==", name: "Basic tier" },
    recurrence: "yearly",
    price_cents: "12000",
    quantity: 2
  }
}
```

--------------------------------

### Create a Product via CLI

Source: https://gumroad.com/api

Use the Gumroad CLI to create a product with specified type, name, price, and currency.

```bash
gumroad products create --type digital \
  --name "Pencil Icon PSD" \
  --price 1.00 \
  --currency usd
```

--------------------------------

### Earnings API Response Example

Source: https://gumroad.com/api

Example JSON response showing annual earnings in cents.

```json
{
  "success": true,
  "year": 2025,
  "currency": "usd",
  "gross_cents": 123456,
  "fees_cents": 12345,
  "taxes_cents": 678,
  "affiliate_credit_cents": 0,
  "net_cents": 110433
}
```

--------------------------------

### Retrieve Payout Details

Source: https://gumroad.com/api

Examples for fetching specific payout information using cURL and the Gumroad CLI.

```bash
curl https://api.gumroad.com/v2/payouts/fEGTaEpuKDsnDvf_MfecTA== \
  -d "access_token=ACCESS_TOKEN" \
  -d "include_transactions=true" \
  -X GET
```

```bash
gumroad payouts view fEGTaEpuKDsnDvf_MfecTA==
```

--------------------------------

### Workflow Email Response Example

Source: https://gumroad.com/api

Example JSON response structure for a workflow email update.

```json
{
  "success": true,
  "email": {
    "id": "bfi_30HLgGWL8H2wo_Gzlg==",
    "subject": "Week four",
    "message": "<p>Updated copy.</p>",
    "audience_type": "product",
    "product_id": "A-m3CDDC5dlrSdKZp0RFhA==",
    "state": "published",
    "published_at": "2026-08-06T12:00:00.000Z",
    "send_emails": true,
    "delay": { "amount": 4, "unit": "week" },
    "sent_count": 24,
    "open_count": null,
    "open_rate": null,
    "click_count": null,
    "click_rate": null,
    "created_at": "2026-08-06T12:00:00.000Z",
    "updated_at": "2026-08-07T12:00:00.000Z"
  }
}
```

--------------------------------

### PUT /products/:id/enable

Source: https://gumroad.com/api

Enable an existing product.

```APIDOC
## PUT /products/:id/enable

### Description
Enable an existing product.

### Method
PUT

### Endpoint
https://api.gumroad.com/v2/products/:id/enable

### Parameters
#### Path Parameters
- **id** (string) - Required - Unique identifier for the product

### Response
#### Success Response (200)
- **success** (boolean) - Whether the request succeeded
- **product** (object) - The product object
```

--------------------------------

### Variant Categories Response Example

Source: https://gumroad.com/api

Example JSON response structure for a variant categories request.

```json
{
  "success": true,
  "variant_categories": [{
    "id": "mN7CdHiwHaR9FlxKvF-n-g==",
    "title": "colors"
  }, {...}, {...}]
}
```

--------------------------------

### Attach files during product creation

Source: https://gumroad.com/api

Associate a file with a new product by passing the file_url in the files array.

```bash
curl https://api.gumroad.com/v2/products \
  -d "access_token=ACCESS_TOKEN" \
  -d "native_type=digital" \
  -d "name=My product" \
  -d "price=500" \
  -d "files[][url]=FILE_URL" \
  -X POST
```

```bash
gumroad products create --type digital \
  --name "My product" \
  --price 5.00 \
  --file ./course.pdf
```

--------------------------------

### Tax Forms API Response Example

Source: https://gumroad.com/api

Example JSON response containing a list of tax forms for a given year.

```json
{
  "success": true,
  "tax_forms": [
    {
      "tax_year": 2025,
      "tax_form_type": "us_1099_k",
      "filed_at": "2026-01-31T00:00:00Z"
    },
    {
      "tax_year": 2025,
      "tax_form_type": "us_1099_misc",
      "filed_at": null
    }
  ]
}
```

--------------------------------

### GET /refund_policy

Source: https://gumroad.com/api

Retrieve the account-level refund policy.

```APIDOC
## GET /refund_policy

### Description
Retrieve the account-level refund policy.

### Method
GET

### Endpoint
https://api.gumroad.com/v2/refund_policy

### Response
#### Success Response (200)
- **success** (boolean) - Whether the request succeeded
- **refund_policy** (object) - The account-level refund policy
- **refund_period** (string) - One of "none", "7", "14", "30", or "183"
- **title** (string) - Display title derived from the refund period
- **fine_print** (string | null) - Optional fine print, with HTML stripped
- **in_effect** (boolean) - Whether this account-level refund policy is currently shown to buyers

#### Response Example
{
  "success": true,
  "refund_policy": {
    "refund_period": "30",
    "title": "30-day money back guarantee",
    "fine_print": "Refund requests are reviewed within 2 business days.",
    "in_effect": true
  }
}
```

--------------------------------

### GET /user

Source: https://gumroad.com/api

Retrieve the user's data.

```APIDOC
## GET /user

### Description
Retrieve the user's data.

### Method
GET

### Endpoint
https://api.gumroad.com/v2/user

### Parameters
#### Query Parameters
- **access_token** (string) - Required - Authentication token.

### Request Example
curl https://api.gumroad.com/v2/user \
  -d "access_token=ACCESS_TOKEN" \
  -X GET

### Response
#### Success Response (200)
- **success** (boolean) - Whether the request succeeded
- **user** (object) - The user object

#### Response Example
{
  "success": true,
  "user": {
    "bio": "a sailor, a tailor",
    "name": "John Smith",
    "twitter_handle": null,
    "user_id": "G_-mnBf9b1j9A7a4ub4nFQ==",
    "email": "johnsmith@gumroad.com",
    "url": "https://gumroad.com/sailorjohn",
    "profile_picture_url": "https://assets.gumroad.com/user/abc/avatar"
  }
}
```

--------------------------------

### Enable a Product via API

Source: https://gumroad.com/api

Endpoint for enabling an existing product.

```http
https://api.gumroad.com/v2/products/:id/enable
```

--------------------------------

### POST /v2/products

Source: https://gumroad.com/api

Creates a new product and attaches files using their canonical URLs.

```APIDOC
## POST /v2/products

### Description
Creates a new product and associates files with it.

### Method
POST

### Endpoint
/v2/products

### Parameters
#### Request Body
- **native_type** (string) - Required - The type of product (e.g., 'digital')
- **name** (string) - Required - The name of the product
- **price** (integer) - Required - The price in cents
- **files[][url]** (string) - Required - The canonical file URL from /v2/files/complete

### Request Example
curl https://api.gumroad.com/v2/products \
  -d "access_token=ACCESS_TOKEN" \
  -d "native_type=digital" \
  -d "name=My product" \
  -d "price=500" \
  -d "files[][url]=FILE_URL" \
  -X POST
```

--------------------------------

### GET /v2/payouts/upcoming

Source: https://gumroad.com/api

Retrieves a list of upcoming payouts and their associated transactions.

```APIDOC
## GET /v2/payouts/upcoming

### Description
Retrieves upcoming payout information for the authenticated user.

### Method
GET

### Endpoint
https://api.gumroad.com/v2/payouts/upcoming

### Parameters
#### Query Parameters
- **access_token** (string) - Required - The access token for authentication.
- **include_transactions** (boolean) - Optional - Whether to include transaction details in the response.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **payouts** (array) - List of upcoming payouts.

#### Response Example
{
  "success": true,
  "payouts": [
    {
      "id": null,
      "amount": "150.00",
      "currency": "USD",
      "status": "payable",
      "created_at": "2021-01-15T19:38:56Z",
      "transactions": [
        {
          "item_name": "Beautiful widget",
          "buyer_name": "Jane Doe",
          "buyer_email": "jane@example.com",
          "taxes": 0.0,
          "shipping": 0.0,
          "sale_price": 200.0,
          "gumroad_fees": 26.6,
          "net_total": 173.4
        }
      ]
    }
  ]
}
```

--------------------------------

### GET /v2/subscribers/:id

Source: https://gumroad.com/api

Retrieves the details of a specific subscriber by their ID.

```APIDOC
## GET /v2/subscribers/:id

### Description
Retrieves the details of a specific subscriber using their unique identifier.

### Method
GET

### Endpoint
https://api.gumroad.com/v2/subscribers/:id

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the subscriber.

#### Query Parameters
- **access_token** (string) - Required - The access token for authentication.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **subscribers** (object) - The subscriber details object containing fields like purchase_ids, created_at, recurrence, license_key, and status.

### Response Example
{
  "success": true,
  "subscribers": {
    "id": "P5ppE6H8XIjy2JSCgUhbAw==",
    "product_id": "0ssD7adjRklGBjS5cwlWPq==",
    "product_name": "Pencil Icon PSD",
    "user_id": "3523953790232",
    "user_email": "calvin@gumroad.com",
    "purchase_ids": ["O4pjE6H8XNjy2JSCgKhbAw=="],
    "created_at": "2015-06-30T17:38:04Z",
    "user_requested_cancellation_at": null,
    "charge_occurrence_count": null,
    "recurrence": "monthly",
    "cancelled_at": null,
    "ended_at": null,
    "failed_at": null,
    "free_trial_ends_at": null,
    "license_key": "85DB562A-C11D4B06-A2335A6B-8C079166",
    "status": "alive"
  }
}
```

--------------------------------

### Fetch Product Data via cURL

Source: https://gumroad.com/api

Example request to retrieve product details using cURL.

```bash
curl https://sahil.gumroad.com/l/pencil.json \
  -X GET
```

--------------------------------

### GET /resource_subscriptions

Source: https://gumroad.com/api

Retrieves a list of all active subscriptions for a specific resource.

```APIDOC
## GET /resource_subscriptions

### Description
Show all active subscriptions of the user for the specified input resource.

### Method
GET

### Endpoint
https://api.gumroad.com/v2/resource_subscriptions

### Parameters
#### Query Parameters
- **access_token** (string) - Required - The user's access token.
- **resource_name** (string) - Required - The resource name to filter by (e.g., "sale", "refund", "dispute").

### Request Example
curl https://api.gumroad.com/v2/resource_subscriptions \
  -d "access_token=ACCESS_TOKEN" \
  -d "resource_name=sale" \
  -X GET

### Response
#### Success Response (200)
- **success** (boolean) - Whether the request succeeded.
- **resource_subscriptions** (array) - Array of resource subscription objects.

#### Response Example
{
  "success": true,
  "resource_subscriptions": [{
    "id": "G_-mnBf9b1j9A7a4ub4nFQ==",
    "resource_name": "sale",
    "post_url": "https://postatmebro.com"
  }]
}
```

--------------------------------

### Create a product offer code

Source: https://gumroad.com/api

Create a new offer code for a specific product using cURL or the Gumroad CLI.

```bash
curl https://api.gumroad.com/v2/products/A-m3CDDC5dlrSdKZp0RFhA==/offer_codes \
  -d "access_token=ACCESS_TOKEN" \
  -d "name=1OFF" \
  -d "amount_off=100" \
  -d "offer_type=cents" \
  -X POST
```

```bash
gumroad offer-codes create --product A-m3CDDC5dlrSdKZp0RFhA== \
  --name 1OFF \
  --amount 1.00
```

--------------------------------

### Fetch Reviews via cURL

Source: https://gumroad.com/api

Example request to retrieve reviews for a product using an access token.

```bash
curl https://api.gumroad.com/v2/products/A-m3CDDC5dlrSdKZp0RFhA==/reviews \
  -d "access_token=ACCESS_TOKEN" \
  -X GET
```

--------------------------------

### GET /:username.json

Source: https://gumroad.com/api

Retrieve a creator's public profile information.

```APIDOC
## GET /:username.json

### Description
Retrieve a creator's public profile — no authentication required. Returns the creator's display information along with products visible in their public profile.

### Method
GET

### Endpoint
https://[username].gumroad.com/.json

### Response
#### Success Response (200)
- **api_version** (number) - The schema version
- **id** (string) - The creator's unique external ID
- **username** (string) - The creator's username
- **name** (string) - The creator's display name
- **bio** (string) - The creator's profile bio
- **avatar_url** (string) - The creator's avatar image URL
- **profile_url** (string) - The full public profile URL
- **products** (array) - Products visible in the creator's public profile

#### Response Example
{
  "api_version": 1,
  "id": "G_-mnBf9b1j9A7a4ub4nFQ==",
  "username": "sahil",
  "name": "Sahil",
  "bio": "I make tools for creators.",
  "avatar_url": "https://public-files.gumroad.com/user/abc/avatar",
  "profile_url": "https://sahil.gumroad.com"
}
```

--------------------------------

### GET /emails/:id

Source: https://gumroad.com/api

Retrieve the details of a specific audience email.

```APIDOC
## GET /emails/:id

### Description
Retrieve the details of a specific audience email. Requires the edit_emails or account scope.

### Method
GET

### Endpoint
https://api.gumroad.com/v2/emails/:id

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier for the email.
```

--------------------------------

### Offer code creation response

Source: https://gumroad.com/api

Example JSON response returned after successfully creating an offer code.

```json
{
  "success": true,
  "offer_code": {
    "id": "mN7CdHiwHaR9FlxKvF-n-g==",
    "name": "1OFF",
    "amount_cents": 100,
    "max_purchase_count": null,
    "minimum_amount_cents": null,
    "times_used": 1
  }
}
```

--------------------------------

### View offer code example response

Source: https://gumroad.com/api

JSON structure returned when viewing a specific offer code.

```json
{
  "success": true,
  "offer_code": {
    "id": "mN7CdHiwHaR9FlxKvF-n-g==",
    "name": "1OFF",
    "amount_cents": 100,
    "max_purchase_count": null,
    "times_used": 1
  }
}
```

--------------------------------

### Enable Product via cURL

Source: https://gumroad.com/api

Use this request to enable a specific product using its unique identifier.

```bash
curl https://api.gumroad.com/v2/products/A-m3CDDC5dlrSdKZp0RFhA==/enable \
  -d "access_token=ACCESS_TOKEN" \
  -X PUT
```

--------------------------------

### GET /products/:product_id/variant_categories

Source: https://gumroad.com/api

Retrieve all of the existing variant categories of a product.

```APIDOC
## GET /products/:product_id/variant_categories

### Description
Retrieve all of the existing variant categories of a product.

### Method
GET

### Endpoint
https://api.gumroad.com/v2/products/:product_id/variant_categories
```

--------------------------------

### GET /v2/products/:id

Source: https://gumroad.com/api

Retrieves the details of a specific product by its ID.

```APIDOC
## GET /v2/products/:id

### Description
Retrieves the details of a specific product using its unique identifier.

### Method
GET

### Endpoint
https://api.gumroad.com/v2/products/:id

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the product.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **product** (object) - The product details object.

#### Response Example
{
  "success": true,
  "product": {
    "id": "A-m3CDDC5dlrSdKZp0RFhA==",
    "name": "Pencil Icon PSD",
    "price": 100,
    "currency": "usd"
  }
}
```

--------------------------------

### List products via Gumroad CLI

Source: https://gumroad.com/api

Retrieve a list of products using the Gumroad command-line interface.

```bash
gumroad products list
```

--------------------------------

### GET /v2/products/:id

Source: https://gumroad.com/api

Retrieve the details of a specific product by its ID.

```APIDOC
## GET /v2/products/:id

### Description
Retrieve the details of a specific product using its unique identifier.

### Method
GET

### Endpoint
https://api.gumroad.com/v2/products/:id

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the product

### Response
#### Success Response (200)
- **success** (boolean) - Whether the request succeeded
- **product** (object) - The product object containing details like name, description, and pricing
```

--------------------------------

### Add a Product Cover cURL Request

Source: https://gumroad.com/api

Example request to add a YouTube video as a product cover.

```bash
curl https://api.gumroad.com/v2/products/A-m3CDDC5dlrSdKZp0RFhA==/covers \
  -d "access_token=ACCESS_TOKEN" \
  -d "url=https://www.youtube.com/watch?v=qKebcV1jv3A" \
  -X POST
```

--------------------------------

### PUT /v2/licenses/enable

Source: https://gumroad.com/api

Enables a license key for a specific product.

```APIDOC
## PUT /v2/licenses/enable

### Description
Enables a license key for a specific product.

### Method
PUT

### Endpoint
https://api.gumroad.com/v2/licenses/enable

### Parameters
#### Request Body
- **access_token** (string) - Required - The access token for authentication.
- **product_id** (string) - Required - The unique ID of the product.
- **license_key** (string) - Required - The license key provided by your customer.

### Request Example
curl https://api.gumroad.com/v2/licenses/enable \
  -d "access_token=ACCESS_TOKEN" \
  -d "product_id=32-nPAicqbLj8B_WswVlMw==" \
  -d "license_key=A1B2C3D4-E5F60718-9ABCDEF0-1234ABCD" \
  -X PUT

### Response
#### Success Response (200)
- **success** (boolean) - Whether the request succeeded
- **uses** (number) - Current number of times this license has been used
- **purchase** (object) - The purchase associated with this license

#### Response Example
{
  "success": true,
  "uses": 3,
  "purchase": {
    "seller_id": "kL0psVL2admJSYRNs-OCMg==",
    "product_id": "32-nPAicqbLj8B_WswVlMw==",
    "product_name": "licenses demo product",
    "permalink": "QMGY",
    "product_permalink": "https://sahil.gumroad.com/l/pencil",
    "email": "customer@example.com",
    "price": 0,
    "gumroad_fee": 0,
    "currency": "usd",
    "quantity": 1,
    "discover_fee_charged": false,
    "can_contact": true,
    "referrer": "direct",
    "card": {
      "visual": null,
      "type": null
    },
    "order_number": 524459935,
    "sale_id": "FO8TXN-dbxYaBdahG97Y-Q==",
    "sale_timestamp": "2021-01-05T19:38:56Z",
    "purchaser_id": "5550321502811",
    "subscription_id": "GDzW4_aBdQc-o7Gbjng7lw==",
    "variants": "",
    "license_key": "85DB562A-C11D4B06-A2335A6B-8C079166",
    "is_multiseat_license": false,
    "ip_country": "United States",
    "recurrence": "monthly",
    "is_gift_receiver_purchase": false,
    "refunded": false,
    "disputed": false,
    "dispute_won": false,
    "id": "FO8TXN-dvaYbBbahG97a-Q==",
    "created_at": "2021-01-05T19:38:56Z",
    "custom_fields": [],
    "chargebacked": false,
    "subscription_ended_at": null,
    "subscription_cancelled_at": null,
    "subscription_failed_at": null
  }
}
```

--------------------------------

### GET /v2/payouts/:payout_id

Source: https://gumroad.com/api

Retrieves the details of a specific payout by its unique identifier.

```APIDOC
## GET /v2/payouts/:payout_id

### Description
Retrieves the details of a specific payout, including status, amount, and associated sales or transaction data.

### Method
GET

### Endpoint
https://api.gumroad.com/v2/payouts/:payout_id

### Parameters
#### Path Parameters
- **payout_id** (string) - Required - The unique identifier for the payout.

#### Query Parameters
- **include_sales** (string) - Optional - Set to "false" to exclude the "sales", "refunded_sales", and "disputed_sales" details from the response. Default: "true".
- **include_transactions** (string) - Optional - Set to "true" to include detailed transaction information in the response. Default: "false".

### Response
#### Success Response (200)
- **success** (boolean) - Whether the request succeeded
- **payout** (object) - The payout object containing details like id, amount, currency, status, created_at, processed_at, payment_processor, and bank/paypal details.
- **sales** (array) - Array of sale IDs (omitted if include_sales is "false").
- **refunded_sales** (array) - Array of refunded sale IDs (omitted if include_sales is "false").
- **disputed_sales** (array) - Array of disputed sale IDs (omitted if include_sales is "false").
- **transactions** (array) - Detailed transaction list (present when include_transactions is "true").
```
Tokens:
Raw