RevKeenDocs
StatusSupport
API Reference

Create a price

Creates a new price for a product. Supports fixed, pay-what-you-want, and free pricing models. --- **Related endpoints** - `GET /prices` — List prices - `GET /prices/{id}` — Retrieve a price - `PATCH /prices/{id}` — Update 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).

POST
/prices

Creates a new price for a product. Supports fixed, pay-what-you-want, and free pricing models.

Related endpoints

  • GET /prices — List prices
  • GET /prices/{id} — Retrieve a price
  • PATCH /prices/{id} — Update 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.

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

Price creation details

TypeScript Definitions

Use the request body type in TypeScript.

Parameters for creating a new price. Specify the product, amount, currency, and billing interval.

Response Body

application/json

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/prices" \
  -H "x-api-key: $REVKEEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "product_id": "00000000-0000-0000-0000-000000000000",
    "currency": "usd",
    "unit_amount": 0,
    "type": "one_time",
    "pricing_model": "fixed",
    "interval": "day",
    "interval_count": 0,
    "trial_period_days": 0,
    "start_rule": "immediate",
    "minimum_amount": 0,
    "maximum_amount": 0,
    "suggested_amount": 0,
    "preset_amounts": [
      0
    ],
    "name": "string",
    "nickname": "string",
    "description": "string",
    "lookup_key": "string",
    "billing_scheme": "per_unit",
    "tiers_mode": "graduated",
    "tiers": [
      {
        "up_to": null,
        "unit_amount_minor": null,
        "unit_amount_decimal": null,
        "flat_amount_minor": null
      }
    ],
    "transform_quantity": {
      "divide_by": 0,
      "round": "up"
    },
    "percentage_rate_bps": 70,
    "metadata": {}
  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "object": "price",  "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",  "active": true,  "currency": "string",  "unit_amount": 0,  "unit_amount_decimal": "string",  "type": "one_time",  "pricing_model": "fixed",  "interval": "day",  "interval_count": 0,  "trial_period_days": 0,  "start_rule": "immediate",  "minimum_amount": 0,  "maximum_amount": 0,  "suggested_amount": 0,  "preset_amounts": [    0  ],  "name": "string",  "nickname": "string",  "description": "string",  "version": 1,  "lookup_key": "string",  "billing_scheme": "per_unit",  "tiers_mode": "graduated",  "tiers": [    {      "up_to": 1,      "unit_amount_minor": 0,      "unit_amount_decimal": "string",      "flat_amount_minor": 0    }  ],  "transform_quantity": {    "divide_by": 1,    "round": "up"  },  "percentage_rate_bps": 0,  "pay_in_advance": true,  "spending_minimum_cents": 0,  "metadata": {},  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}

Archive a price DELETE

Archives a price by setting active to false. The price remains in the system but cannot be used for new purchases. --- **Related endpoints** - `GET /prices` — List prices - `POST /prices` — Create a price - `GET /prices/{id}` — Retrieve a price - `PATCH /prices/{id}` — Update a price **Common errors** - `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).

Retrieve a price GET

Retrieves a price by its ID. --- **Related endpoints** - `GET /prices` — List prices - `POST /prices` — Create a price - `PATCH /prices/{id}` — Update a price - `DELETE /prices/{id}` — Archive a price **Common errors** - `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.