Create product

Create a new product. Requires 'products:write' scope.

Related endpoints

GET /products — List products
GET /products/{id} — Get product by ID
PATCH /products/{id} — Update product
PUT /products/external/{source}/{externalId} — Upsert product by external ID
PUT /products/external/batch — Batch upsert products by external ID

Common errors

400 invalid_request — malformed payload or failed validation.
401 unauthenticated — missing, malformed, or revoked API key.

Idempotency

Pass an Idempotency-Key header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see the idempotency guide.

Authorization

x-api-key<token>

Your RevKeen API key (powered by Unkey). Get it from Dashboard > Settings > API Keys. Use rk_sandbox_* for test mode and rk_live_* for production.

In: header

Request Body

application/json

Product creation details

TypeScript Definitions

Use the request body type in TypeScript.

product_id*string

Length1 <= length

name*string

Length1 <= length

description?|

kind*string

Value in"subscription" | "one_time" | "usage"

pricing_model*string

Value in"one_time" | "recurring" | "usage"

amount_minor*integer

Range0 <= value

currency?string

Default"USD"

interval?|

interval_count?|

trial_days?integer

Range0 <= value

usage_meter_id?|

slug?string

fulfillment_type?string

Fulfillment type for the product. Defaults to 'none' (service).

Default"none"

Value in"none" | "digital" | "physical"

track_inventory?boolean

Enable a finite purchase cap that blocks purchase once stock reaches zero. One-time products only; requires stock_quantity.

Defaultfalse

stock_quantity?|

Remaining units that can be purchased. Required (non-negative) when track_inventory is true; ignored otherwise.

Range0 <= value

billing_anchor_rule?string

How billing dates are calculated. same_day: Bill on same day as start. day_of_month: Bill on specific day (1-31). last_day: Bill on last day of month.

Value in"same_day" | "day_of_month" | "last_day"

billing_anchor_day?|

Day of month (1-31) when billing_anchor_rule is 'day_of_month'

Range1 <= value <= 31

first_charge_behavior?string

When first payment is collected. immediate: Charge on start. next_anchor: Charge on first scheduled date. prorate: Prorate until first date.

Value in"immediate" | "next_anchor" | "prorate"

end_behavior?string

How subscription ends. until_canceled: Runs forever. fixed_payments: Ends after N billing cycles.

Value in"until_canceled" | "fixed_payments"

max_payments?|

Max billing cycles when end_behavior is 'fixed_payments'

Range1 <= value <= 999

metadata?

Arbitrary key-value metadata for the product

image_url?|

Product image S3 key or public URL (upload via /internal/storage first)

Response Body

`application/json`

Stuck on an error response? Ask the RevKeen assistant to explain it.

curl -X POST "https://api.revkeen.com/v2/products" \
  -H "x-api-key: $REVKEEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "product_id": "string",
    "name": "string",
    "description": null,
    "kind": "subscription",
    "pricing_model": "one_time",
    "amount_minor": 0,
    "currency": "USD",
    "interval": null,
    "interval_count": null,
    "trial_days": 0,
    "usage_meter_id": null,
    "slug": "string",
    "fulfillment_type": "none",
    "track_inventory": false,
    "stock_quantity": null,
    "billing_anchor_rule": "same_day",
    "billing_anchor_day": null,
    "first_charge_behavior": "immediate",
    "end_behavior": "until_canceled",
    "max_payments": null,
    "metadata": {},
    "image_url": null
  }'

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "object": "product",
    "product_id": "string",
    "name": "string",
    "description": "string",
    "kind": "subscription",
    "pricing_model": "one_time",
    "amount_minor": 0,
    "currency": "string",
    "interval": "string",
    "interval_count": 0,
    "trial_days": 0,
    "fulfillment_type": "none",
    "track_inventory": true,
    "stock_quantity": 0,
    "billing_anchor_rule": "same_day",
    "billing_anchor_day": 0,
    "first_charge_behavior": "immediate",
    "end_behavior": "until_canceled",
    "max_payments": 0,
    "usage_meter_id": "string",
    "slug": "string",
    "is_active": true,
    "is_archived": true,
    "image_url": "string",
    "tax_behavior": "string",
    "tax_code": "string",
    "metadata": {},
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

{
  "error": "string"
}

{
  "error": "string"
}

Create product

Authorization

Request Body

Response Body

201application/json

400application/json

401application/json

`application/json`

`application/json`

`application/json`