RevKeenDocs
StatusSupport
API Reference

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 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. **Idempotency** Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).

POST
/products

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 authentication_error — missing, invalid, expired, or revoked credential. Codes: authentication_failed, invalid_api_key, expired_api_key, api_key_revoked, session_invalid, merchant_required. Carries a WWW-Authenticate: Bearer challenge.

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 merchant API key. Create and manage keys in Dashboard → Settings → Developer. Use rk_sandbox_* for staging/test and rk_live_* for production. The same key may be sent as Authorization: Bearer <key> if that suits your HTTP client better. A missing, invalid, expired, or revoked key returns 401 with a WWW-Authenticate: Bearer challenge; a valid key without the required scope returns 403.

In: header

Request Body

application/json

Product creation details

TypeScript Definitions

Use the request body type in TypeScript.

Parameters for creating a new product, including name, billing type, and pricing.

Response Body

application/json

application/json

application/json

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"  }}

Update a price PATCH

Updates a price. Only certain fields can be updated (active, name, nickname, lookup_key, metadata). Core pricing fields are immutable. --- **Related endpoints** - `GET /prices` — List prices - `POST /prices` — Create a price - `GET /prices/{id}` — Retrieve a price - `DELETE /prices/{id}` — Archive a price **Common errors** - `400 invalid_request` — malformed payload or failed validation. - `401 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. **Idempotency** Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).

Batch upsert products by external ID PUT

Create or update multiple products by external system ID. Supports up to 100 products per request with stale update protection. --- **Related endpoints** - `GET /products` — List products - `POST /products` — Create product - `GET /products/{id}` — Get product by ID - `PATCH /products/{id}` — Update product - `PUT /products/external/{source}/{externalId}` — Upsert product by external ID **Common errors** - `400 invalid_request` — malformed payload or failed validation. - `401 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. - `403 authorization_error` — the caller is identified but the action is denied. Codes include `insufficient_permissions`, `ip_not_allowed`, `merchant_mismatch`, and `origin_not_allowed`. **Idempotency** Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).