RevKeenDocs
StatusSupport
API Reference

Create a meter price

Create a usage price for a meter with a specific pricing model (per_unit, graduated, volume, package, or percentage). A usage-based subscription has one currency; metered events attributed to it are assumed to be in that currency and are not FX-converted by RevKeen. --- **Related endpoints** - `GET /meters` — List meters - `POST /meters` — Create a meter - `GET /meters/{id}` — Get a meter - `PATCH /meters/{id}` — Update a meter - `GET /meters/{meterId}/prices` — List meter prices - `PATCH /meters/{meterId}/prices/{priceId}` — Update a meter price - `POST /meters/{meterId}/prices/{priceId}/deactivate` — Deactivate a meter 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
/meters/{meterId}/prices

Create a usage price for a meter with a specific pricing model (per_unit, graduated, volume, package, or percentage). A usage-based subscription has one currency; metered events attributed to it are assumed to be in that currency and are not FX-converted by RevKeen.

Related endpoints

  • GET /meters — List meters
  • POST /meters — Create a meter
  • GET /meters/{id} — Get a meter
  • PATCH /meters/{id} — Update a meter
  • GET /meters/{meterId}/prices — List meter prices
  • PATCH /meters/{meterId}/prices/{priceId} — Update a meter price
  • POST /meters/{meterId}/prices/{priceId}/deactivate — Deactivate a meter 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

apiKey
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

Path Parameters

meterId*string

Meter ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Parameters for creating a price attached to a usage meter, defining per-unit cost, tiered tiers, or a percentage rate.

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/meters/string/prices" \
  -H "x-api-key: $REVKEEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "pricing_model": "per_unit",
    "currency": "GBP",
    "unit_amount_minor": 100,
    "unit_amount_decimal": "0.02",
    "flat_fee_minor": 0,
    "package_size": 100,
    "cost_per_unit_minor": 5,
    "name": "Full day",
    "nickname": "holiday-club-full-day",
    "description": "Full-day holiday club session",
    "tiers": [
      {
        "up_to": null,
        "unit_amount_minor": null,
        "unit_amount_decimal": null,
        "flat_amount_minor": null
      }
    ],
    "filter_conditions": [
      {}
    ],
    "filter_priority": 10,
    "pay_in_advance": true,
    "spending_minimum_cents": 50,
    "percentage_rate_bps": 70
  }'
{  "data": {    "property1": null,    "property2": null  }}

Suspend a Direct Debit mandate POST

Suspends an active (or pending-lodgement) mandate. --- **Related endpoints** - `POST /mandates` — Create a Direct Debit mandate - `GET /mandates` — List Direct Debit mandates - `GET /mandates/{id}` — Retrieve a Direct Debit mandate - `POST /mandates/{id}/cancel` — Cancel a Direct Debit mandate - `POST /mandates/{id}/reinstate` — Reinstate a suspended Direct Debit mandate - `POST /mandates/{id}/collections` — Schedule a one-off Direct Debit collection **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).

Create a meter POST

Create a new usage meter. Meters define how usage events are aggregated for billing. --- **Related endpoints** - `GET /meters` — List meters - `GET /meters/{id}` — Get a meter - `PATCH /meters/{id}` — Update a meter - `POST /meters/{meterId}/prices` — Create a meter price - `GET /meters/{meterId}/prices` — List meter prices - `PATCH /meters/{meterId}/prices/{priceId}` — Update a meter price - `POST /meters/{meterId}/prices/{priceId}/deactivate` — Deactivate a meter 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. **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).