Addons6

Alerts1

AlertSettings5

Checkout3

Costs7

Coupon Associations2

Coupons6

Credit Grants6

Credit Notes4

Customers11

Entitlements8

Environments1

Events8

Features5

Groups4

Integrations4

Invoices14

Marketplace1

Payments6

Plans7

Price Units7

Prices7

RBAC2

Scheduled Tasks8

Secrets3

Subscriptions27

Tasks6

Tax Associations5

Tax Rates5

Tenants3

Usage Records1

Users8

Wallets11

Webhook Events57

Workflows1

Prices

Get price by lookup key

Use when resolving a price by external id (e.g. from your catalog or CMS). Ideal for integrations.

get/prices/lookup/{lookup_key}

Path parameters

lookup_keystring required

Lookup key

Response

amountstring

Amount stored in main currency units (e.g., dollars, not cents) For USD: 12.50 means $12.50

billing_cadence'RECURRING'

billing_model'FLAT_FEE' | 'PACKAGE' | 'TIERED'

billing_period_countinteger

BillingPeriodCount is the count of the billing period ex 1, 3, 6, 12

conversion_ratestring

ConversionRate is the conversion rate of the price unit to the fiat currency

created_atstring date-time

created_bystring

currencystring

Currency 3 digit ISO currency code in lowercase ex usd, eur, gbp

descriptionstring

Description of the price

display_amountstring

DisplayAmount is the formatted amount with currency symbol For USD: $12.50

display_namestring

DisplayName is the name of the price

display_price_unit_amountstring

DisplayPriceUnitAmount is the formatted amount of the price unit

end_datestring date-time

EndDate is the end date of the price

entity_idstring

EntityID holds the value of the "entity_id" field.

entity_type'PLAN' | 'SUBSCRIPTION' | 'ADDON' | 'PRICE' | 'COSTSHEET'

environment_idstring

EnvironmentID is the environment identifier for the price

group_idstring

GroupID references the group this price belongs to

idstring

ID uuid identifier for the price

invoice_cadence'ARREAR' | 'ADVANCE'

lookup_keystring

LookupKey used for looking up the price in the database

metadataPriceJSONBMetadata

meter_idstring

MeterID is the id of the meter for usage based pricing

min_quantitystring nullable

MinQuantity is the minimum quantity of the price

parent_price_idstring

ParentPriceID references the root price (always set for price lineage tracking)

price_unitstring

PriceUnit is the code of the price unit (e.g., 'btc', 'eth')

price_unit_amountstring

PriceUnitAmount is the amount of the price unit

price_unit_idstring

PriceUnitID is the id of the price unit (for CUSTOM type)

price_unit_type'FIAT' | 'CUSTOM'

sequenceinteger

Sequence is the monotonic stamp bumped on every state change that subscription line items need to react to. Read by the plan-price sync; set by the database (DEFAULT nextval) on create and by the price repository on termination / compatibility-affecting edits.

start_datestring date-time

StartDate is the start date of the price

status'published' | 'deleted' | 'archived'

tenant_idstring

tier_mode'VOLUME' | 'SLAB'

trial_period_daysinteger

TrialPeriodDays is the number of days for the trial period Note: This is only applicable for recurring prices (BILLING_CADENCE_RECURRING)

type'USAGE' | 'FIXED'

updated_atstring date-time

updated_bystring

Example response

{
  "addon": {
    "entitlements": [
      {
        "feature": {
          "meter": {
            "created_at": "2024-03-20T15:04:05Z",
            "event_name": "api_request",
            "id": "550e8400-e29b-41d4-a716-446655440000",
            "name": "API Usage Meter",
            "status": "published",
            "tenant_id": "tenant123",
            "updated_at": "2024-03-20T15:04:05Z"
          }
        }
      }
    ]
  },
  "meter": {
    "created_at": "2024-03-20T15:04:05Z",
    "event_name": "api_request",
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "API Usage Meter",
    "status": "published",
    "tenant_id": "tenant123",
    "updated_at": "2024-03-20T15:04:05Z"
  },
  "plan": {
    "entitlements": [
      {
        "feature": {
          "meter": {
            "created_at": "2024-03-20T15:04:05Z",
            "event_name": "api_request",
            "id": "550e8400-e29b-41d4-a716-446655440000",
            "name": "API Usage Meter",
            "status": "published",
            "tenant_id": "tenant123",
            "updated_at": "2024-03-20T15:04:05Z"
          }
        }
      }
    ]
  }
}

Changes

Changed in 15 of the 110 revisions of this API.535561

Sep 1, 2026e1d4e27b56771See the full diff
- ○
  added the optional property bucket_size to the response with the 200 status
  response-optional-property-added
Aug 24, 20269cd0dab91f5c1See the full diff
- ○
  added the optional property plan/price_sync_status to the response with the 200 status
  response-optional-property-added
Aug 24, 202666536658bde61See the full diff
- ○
  added the optional property feature to the response with the 200 status
  response-optional-property-added
Aug 21, 2026d567e8585c2e1See the full diff
- ●
  removed the optional property plan/price_sync_status from the response with the 200 status
  response-optional-property-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 21, 2026edf928b9b7452See the full diff
- ○
  added the non-success response with the status 404
  response-non-success-status-added
- ○
  added the optional property plan/price_sync_status to the response with the 200 status
  response-optional-property-added
Jul 15, 2026f8ecf435d25d31See the full diff
- ●
  added the new ADDON enum value to the plan/credit_grants/items/scope response property for the response status 200
  response-property-enum-value-added
- ●
  added the new not_implemented enum value to the code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new not_implemented enum value to the code response property for the response status 500
  response-property-enum-value-added
- ○
  added the optional property plan/credit_grants/items/addon_id to the response with the 200 status
  response-optional-property-added
Jul 9, 2026646d6658479b1See the full diff
- ○
  the billing_period_count response's property default value 1 was removed for the status 200
  response-property-default-value-removed
Jul 9, 20267d57386313c7182517See the full diff
- ▲
  the entity_type response's property type/format changed from / to string/ for status 200
  response-property-type-changed
- ▲
  the invoice_cadence response's property type/format changed from / to string/ for status 200
  response-property-type-changed
- ▲
  the metadata response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the meter/aggregation response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the meter/filters/items/ response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the meter/reset_usage response's property type/format changed from / to string/ for status 200
  response-property-type-changed
- ▲
  the plan/credit_grants/items/metadata response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the plan/credit_grants/items/status response's property type/format changed from / to string/ for status 200
  response-property-type-changed
- ▲
  the plan/metadata response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the plan/status response's property type/format changed from / to string/ for status 200
  response-property-type-changed
- ▲
  the price_unit_tiers/items/ response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the price_unit_type response's property type/format changed from / to string/ for status 200
  response-property-type-changed
- ▲
  the pricing_unit/metadata response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the pricing_unit/status response's property type/format changed from / to string/ for status 200
  response-property-type-changed
- ▲
  the status response's property type/format changed from / to string/ for status 200
  response-property-type-changed
- ▲
  the tiers/items/ response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the transform_quantity response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the type response's property type/format changed from / to string/ for status 200
  response-property-type-changed
- ●
  added the new ADDON enum value to the entity_type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new ADVANCE enum value to the invoice_cadence response property for the response status 200
  response-property-enum-value-added
- ●
  added the new ARREAR enum value to the invoice_cadence response property for the response status 200
  response-property-enum-value-added
- ●
  added the new BILLING_PERIOD enum value to the meter/reset_usage response property for the response status 200
  response-property-enum-value-added
- ●
  added the new COSTSHEET enum value to the entity_type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new CUSTOM enum value to the price_unit_type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new FIAT enum value to the price_unit_type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new FIXED enum value to the type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new NEVER enum value to the meter/reset_usage response property for the response status 200
  response-property-enum-value-added
- ●
  added the new PLAN enum value to the entity_type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new PRICE enum value to the entity_type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new SUBSCRIPTION enum value to the entity_type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new USAGE enum value to the type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new archived enum value to the plan/credit_grants/items/status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new archived enum value to the plan/status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new archived enum value to the pricing_unit/status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new archived enum value to the status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new deleted enum value to the plan/credit_grants/items/status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new deleted enum value to the plan/status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new deleted enum value to the pricing_unit/status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new deleted enum value to the status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new published enum value to the plan/credit_grants/items/status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new published enum value to the plan/status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new published enum value to the pricing_unit/status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new published enum value to the status response property for the response status 200
  response-property-enum-value-added
- ○
  added the optional property meter/aggregation/bucket_size to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property meter/aggregation/expression to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property meter/aggregation/field to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property meter/aggregation/group_by to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property meter/aggregation/multiplier to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property meter/aggregation/type to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property meter/filters/items/key to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property meter/filters/items/values to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property price_unit_tiers/items/flat_amount to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property price_unit_tiers/items/unit_amount to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property price_unit_tiers/items/up_to to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property tiers/items/flat_amount to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property tiers/items/unit_amount to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property tiers/items/up_to to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property transform_quantity/divide_by to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property transform_quantity/round to the response with the 200 status
  response-optional-property-added
- ○
  the billing_period_count response's property default value 1 was added for the status 200
  response-property-default-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 9, 20264b1a811c4179351625See the full diff
- ▲
  the created_at response's property type/format changed from string/date-time to string/ for status 200
  response-property-type-changed
- ▲
  the end_date response's property type/format changed from string/date-time to string/ for status 200
  response-property-type-changed
- ▲
  the entity_type response's property type/format changed from string/ to / for status 200
  response-property-type-changed
- ▲
  the group/created_at response's property type/format changed from string/date-time to string/ for status 200
  response-property-type-changed
- ▲
  the group/updated_at response's property type/format changed from string/date-time to string/ for status 200
  response-property-type-changed
- ▲
  the invoice_cadence response's property type/format changed from string/ to / for status 200
  response-property-type-changed
- ▲
  the metadata response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  the meter/aggregation response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  the meter/created_at response's property type/format changed from string/date-time to string/ for status 200
  response-property-type-changed
- ▲
  the meter/filters/items/ response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  the meter/reset_usage response's property type/format changed from string/ to / for status 200
  response-property-type-changed
- ▲
  the meter/updated_at response's property type/format changed from string/date-time to string/ for status 200
  response-property-type-changed
- ▲
  the plan/created_at response's property type/format changed from string/date-time to string/ for status 200
  response-property-type-changed
- ▲
  the plan/credit_grants/items/created_at response's property type/format changed from string/date-time to string/ for status 200
  response-property-type-changed
- ▲
  the plan/credit_grants/items/credit_grant_anchor response's property type/format changed from string/date-time to string/ for status 200
  response-property-type-changed
- ▲
  the plan/credit_grants/items/end_date response's property type/format changed from string/date-time to string/ for status 200
  response-property-type-changed
- ▲
  the plan/credit_grants/items/metadata response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  the plan/credit_grants/items/start_date response's property type/format changed from string/date-time to string/ for status 200
  response-property-type-changed
- ▲
  the plan/credit_grants/items/status response's property type/format changed from string/ to / for status 200
  response-property-type-changed
- ▲
  the plan/credit_grants/items/updated_at response's property type/format changed from string/date-time to string/ for status 200
  response-property-type-changed
- ▲
  the plan/metadata response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  the plan/status response's property type/format changed from string/ to / for status 200
  response-property-type-changed
- ▲
  the plan/updated_at response's property type/format changed from string/date-time to string/ for status 200
  response-property-type-changed
- ▲
  the price_unit_tiers/items/ response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  the price_unit_type response's property type/format changed from string/ to / for status 200
  response-property-type-changed
- ▲
  the pricing_unit/created_at response's property type/format changed from string/date-time to string/ for status 200
  response-property-type-changed
- ▲
  the pricing_unit/metadata response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  the pricing_unit/status response's property type/format changed from string/ to / for status 200
  response-property-type-changed
- ▲
  the pricing_unit/updated_at response's property type/format changed from string/date-time to string/ for status 200
  response-property-type-changed
- ▲
  the start_date response's property type/format changed from string/date-time to string/ for status 200
  response-property-type-changed
- ▲
  the status response's property type/format changed from string/ to / for status 200
  response-property-type-changed
- ▲
  the tiers/items/ response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  the transform_quantity response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  the type response's property type/format changed from string/ to / for status 200
  response-property-type-changed
- ▲
  the updated_at response's property type/format changed from string/date-time to string/ for status 200
  response-property-type-changed
- ●
  removed the optional property meter/aggregation/bucket_size from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property meter/aggregation/expression from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property meter/aggregation/field from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property meter/aggregation/group_by from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property meter/aggregation/multiplier from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property meter/aggregation/type from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property meter/filters/items/key from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property meter/filters/items/values from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property price_unit_tiers/items/flat_amount from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property price_unit_tiers/items/unit_amount from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property price_unit_tiers/items/up_to from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property tiers/items/flat_amount from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property tiers/items/unit_amount from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property tiers/items/up_to from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property transform_quantity/divide_by from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property transform_quantity/round from the response with the 200 status
  response-optional-property-removed
- ○
  removed the ADDON enum value from the entity_type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the ADVANCE enum value from the invoice_cadence response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the ARREAR enum value from the invoice_cadence response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the BILLING_PERIOD enum value from the meter/reset_usage response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the COSTSHEET enum value from the entity_type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the CUSTOM enum value from the price_unit_type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the FIAT enum value from the price_unit_type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the FIXED enum value from the type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the NEVER enum value from the meter/reset_usage response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the PLAN enum value from the entity_type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the PRICE enum value from the entity_type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the SUBSCRIPTION enum value from the entity_type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the USAGE enum value from the type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the archived enum value from the plan/credit_grants/items/status response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the archived enum value from the plan/status response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the archived enum value from the pricing_unit/status response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the archived enum value from the status response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the deleted enum value from the plan/credit_grants/items/status response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the deleted enum value from the plan/status response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the deleted enum value from the pricing_unit/status response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the deleted enum value from the status response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the published enum value from the plan/credit_grants/items/status response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the published enum value from the plan/status response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the published enum value from the pricing_unit/status response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the published enum value from the status response property for the response status 200
  response-property-enum-value-removed
This revision also has 121 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 3, 20267adf4f33ea1a1See the full diff
- ○
  added the optional property sequence to the response with the 200 status
  response-optional-property-added

Full history (15 revisions)