Custom Fields

Custom fields allow you to collect additional information from buyers when they purchase your products. You can collect text, long text, checkboxes, file uploads, and terms acceptance.

List Custom Fields

Retrieve all custom fields for a product.

GET /v2/products/:product_id/custom_fields

Path Parameters

string

required

The unique identifier of the product

Response

boolean

Whether the request was successful

array

Array of custom field objects

Show custom_field properties

string

Unique identifier for the custom field

string

Name or label of the custom field

string

Type of custom field. One of: text, long_text, checkbox, terms, file

boolean

Whether the field is required for purchase

boolean

Whether the field applies to all products

boolean

Whether to collect this field for each product in a multi-product purchase

array

Array of product IDs that use this custom field

curl https://api.gumroad.com/v2/products/product_id/custom_fields \
  -H "Authorization: Bearer <access_token>"

{
  "success": true,
  "custom_fields": [
    {
      "id": "cf_abc123",
      "name": "Company Name",
      "type": "text",
      "required": true,
      "global": false,
      "collect_per_product": false,
      "products": ["prod_xyz"]
    },
    {
      "id": "cf_def456",
      "name": "https://example.com/terms",
      "type": "terms",
      "required": true,
      "global": false,
      "collect_per_product": false,
      "products": ["prod_xyz"]
    }
  ]
}

Create Custom Field

Add a new custom field to a product.

POST /v2/products/:product_id/custom_fields

Path Parameters

string

required

The unique identifier of the product

Body Parameters

string

required

The name or label for the custom field. For terms type fields, this should be a valid URL to your terms and conditions.

string

default:"text"

The type of custom field. Options:

text - Single line text input
long_text - Multi-line text area
checkbox - Checkbox input
terms - Terms acceptance (name must be a valid URL)
file - File upload

boolean

default:"false"

Whether the field is required. Pass "true" or "false" as a string.

The name parameter can also be passed as url or label for backwards compatibility.

Response

boolean

Whether the request was successful

object

The created custom field object

curl -X POST https://api.gumroad.com/v2/products/product_id/custom_fields \
  -H "Authorization: Bearer <access_token>" \
  -d "name=Company Name" \
  -d "type=text" \
  -d "required=true"

{
  "success": true,
  "custom_field": {
    "id": "cf_abc123",
    "name": "Company Name",
    "type": "text",
    "required": true,
    "global": false,
    "collect_per_product": false,
    "products": ["prod_xyz"]
  }
}

Update Custom Field

Update the required status of a custom field.

PUT /v2/products/:product_id/custom_fields/:id

Path Parameters

string

required

The unique identifier of the product

string

required

The name of the custom field to update (not the ID)

Body Parameters

boolean

Whether the field is required. Pass "true" or "false" as a string.

Response

boolean

Whether the request was successful

object

The updated custom field object

curl -X PUT https://api.gumroad.com/v2/products/product_id/custom_fields/Company%20Name \
  -H "Authorization: Bearer <access_token>" \
  -d "required=false"

{
  "success": true,
  "custom_field": {
    "id": "cf_abc123",
    "name": "Company Name",
    "type": "text",
    "required": false,
    "global": false,
    "collect_per_product": false,
    "products": ["prod_xyz"]
  }
}

Delete Custom Field

Remove a custom field from a product.

DELETE /v2/products/:product_id/custom_fields/:id

Path Parameters

string

required

The unique identifier of the product

string

required

The name of the custom field to delete (not the ID)

Response

boolean

Whether the request was successful

curl -X DELETE https://api.gumroad.com/v2/products/product_id/custom_fields/Company%20Name \
  -H "Authorization: Bearer <access_token>"

{
  "success": true
}

Error Codes

Bad Request - Missing required parameters or invalid custom field name

Unauthorized - Invalid or missing access token

Forbidden - Insufficient permissions (requires edit_products scope)

Not Found - Product or custom field not found

Getting Started

Products

Sales

Licenses

Subscribers

Other Resources

List Custom Fields

Path Parameters

Response

Create Custom Field

Path Parameters

Body Parameters

Response

Update Custom Field

Path Parameters

Body Parameters

Response

Delete Custom Field

Path Parameters

Response

Error Codes

​List Custom Fields

​Path Parameters

​Response

​Create Custom Field

​Path Parameters

​Body Parameters

​Response

​Update Custom Field

​Path Parameters

​Body Parameters

​Response

​Delete Custom Field

​Path Parameters

​Response

​Error Codes

List Custom Fields

Path Parameters

Response

Create Custom Field

Path Parameters

Body Parameters

Response

Update Custom Field

Path Parameters

Body Parameters

Response

Delete Custom Field

Path Parameters

Response

Error Codes