Offer Codes

Offer codes (also called discount codes) allow you to provide discounts to customers. You can create both percentage-based and fixed-amount discounts, and make them universal (apply to all products) or product-specific.

List Offer Codes

Retrieve all offer codes for a product, including universal offer codes.

GET /v2/products/:product_id/offer_codes

Path Parameters

string

required

The unique identifier of the product

Response

boolean

Whether the request was successful

array

Array of offer code objects

Show offer_code properties

string

Unique identifier for the offer code

string

The discount code that customers will use

integer

Maximum number of times this code can be used (null for unlimited)

boolean

Whether the code applies to all of your products

integer

Number of times the code has been used

integer

Percentage discount (present for percentage-based codes)

integer

Fixed discount amount in cents (present for fixed-amount codes)

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

{
  "success": true,
  "offer_codes": [
    {
      "id": "offer_abc123",
      "name": "SAVE20",
      "max_purchase_count": 100,
      "universal": false,
      "times_used": 15,
      "percent_off": 20
    },
    {
      "id": "offer_def456",
      "name": "DOLLAR5",
      "max_purchase_count": null,
      "universal": true,
      "times_used": 42,
      "amount_cents": 500
    }
  ]
}

Get Offer Code

Retrieve details for a specific offer code.

GET /v2/products/:product_id/offer_codes/:id

Path Parameters

string

required

The unique identifier of the product

string

required

The unique identifier of the offer code

Response

boolean

Whether the request was successful

object

The offer code object

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

{
  "success": true,
  "offer_code": {
    "id": "offer_abc123",
    "name": "SAVE20",
    "max_purchase_count": 100,
    "universal": false,
    "times_used": 15,
    "percent_off": 20
  }
}

Create Offer Code

Create a new offer code for a product.

POST /v2/products/:product_id/offer_codes

Path Parameters

string

required

The unique identifier of the product

Body Parameters

string

required

The discount code that customers will use (letters, numbers, dashes, and underscores only)

string

required

Type of discount: percent for percentage-based or fixed for fixed-amount

integer

required

For percentage discounts: the percentage (0-100) For fixed discounts: can be used instead of amount_cents

integer

For fixed discounts: the discount amount in cents (alternative to amount_off)

boolean

default:"false"

Whether the code applies to all of your products. Pass "true" or "false" as a string.

integer

Maximum number of times this code can be used (omit for unlimited)

You must provide either amount_off or amount_cents when creating an offer code. For percentage discounts, use amount_off. For fixed-amount discounts, use either parameter.

Response

boolean

Whether the request was successful

object

The created offer code object

curl -X POST https://api.gumroad.com/v2/products/product_id/offer_codes \
  -H "Authorization: Bearer <access_token>" \
  -d "name=SAVE20" \
  -d "offer_type=percent" \
  -d "amount_off=20" \
  -d "max_purchase_count=100"

curl -X POST https://api.gumroad.com/v2/products/product_id/offer_codes \
  -H "Authorization: Bearer <access_token>" \
  -d "name=DOLLAR5" \
  -d "offer_type=fixed" \
  -d "amount_cents=500" \
  -d "universal=true"

{
  "success": true,
  "offer_code": {
    "id": "offer_abc123",
    "name": "SAVE20",
    "max_purchase_count": 100,
    "universal": false,
    "times_used": 0,
    "percent_off": 20
  }
}

Update Offer Code

Update an existing offer code’s maximum purchase count.

PUT /v2/products/:product_id/offer_codes/:id

Path Parameters

string

required

The unique identifier of the product

string

required

The unique identifier of the offer code

Body Parameters

integer

Maximum number of times this code can be used

Response

boolean

Whether the request was successful

object

The updated offer code object

curl -X PUT https://api.gumroad.com/v2/products/product_id/offer_codes/offer_abc123 \
  -H "Authorization: Bearer <access_token>" \
  -d "max_purchase_count=200"

{
  "success": true,
  "offer_code": {
    "id": "offer_abc123",
    "name": "SAVE20",
    "max_purchase_count": 200,
    "universal": false,
    "times_used": 15,
    "percent_off": 20
  }
}

Delete Offer Code

Soft delete an offer code (marks it as deleted but preserves data).

DELETE /v2/products/:product_id/offer_codes/:id

Path Parameters

string

required

The unique identifier of the product

string

required

The unique identifier of the offer code

Response

boolean

Whether the request was successful

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

{
  "success": true
}

Error Codes

Bad Request - Missing required offer code parameters (amount_off or amount_cents)

Unauthorized - Invalid or missing access token

Forbidden - Insufficient permissions (requires edit_products scope for create/update/delete)

Not Found - Product or offer code not found

Unprocessable Entity - Invalid offer code parameters (e.g., discount exceeds product price)

Getting Started

Products

Sales

Licenses

Subscribers

Other Resources

List Offer Codes

Path Parameters

Response

Get Offer Code

Path Parameters

Response

Create Offer Code

Path Parameters

Body Parameters

Response

Update Offer Code

Path Parameters

Body Parameters

Response

Delete Offer Code

Path Parameters

Response

Error Codes

​List Offer Codes

​Path Parameters

​Response

​Get Offer Code

​Path Parameters

​Response

​Create Offer Code

​Path Parameters

​Body Parameters

​Response

​Update Offer Code

​Path Parameters

​Body Parameters

​Response

​Delete Offer Code

​Path Parameters

​Response

​Error Codes

List Offer Codes

Path Parameters

Response

Get Offer Code

Path Parameters

Response

Create Offer Code

Path Parameters

Body Parameters

Response

Update Offer Code

Path Parameters

Body Parameters

Response

Delete Offer Code

Path Parameters

Response

Error Codes