Get entitlements

Authorizations

x-api-key

string

header

required

Enter your API key in the format x-api-key <api-key>*

Query Parameters

end_time

string

expand

string

feature_ids

string[]

feature_type

enum<string>

Available options:

metered,

boolean,

static

is_enabled

boolean

limit

integer

Required range: 1 < x < 1000

offset

integer

Required range: x > 0

order

enum<string>

Available options:

asc,

desc

plan_ids

string[]

Specific filters for entitlements

sort

string

start_time

string

status

enum<string>

Available options:

published,

deleted,

archived

Response

200 - application/json

items

object[]

items.created_at

string

items.created_by

string

items.feature

object

items.feature_id

string

items.feature_type

enum<string>

Available options:

metered,

boolean,

static

items.id

string

items.is_enabled

boolean

items.is_soft_limit

boolean

items.plan

object

items.plan.created_at

string

items.plan.created_by

string

items.plan.description

string

items.plan.entitlements

object[]

items.plan.entitlements.created_at

string

items.plan.entitlements.created_by

string

items.plan.entitlements.feature

object

items.plan.entitlements.feature_id

string

items.plan.entitlements.feature_type

enum<string>

Available options:

metered,

boolean,

static

items.plan.entitlements.id

string

items.plan.entitlements.is_enabled

boolean

items.plan.entitlements.is_soft_limit

boolean

items.plan.entitlements.plan

object

items.plan.entitlements.plan_id

string

items.plan.entitlements.static_value

string

items.plan.entitlements.status

enum<string>

Available options:

published,

deleted,

archived

items.plan.entitlements.tenant_id

string

items.plan.entitlements.updated_at

string

items.plan.entitlements.updated_by

string

items.plan.entitlements.usage_limit

integer

items.plan.entitlements.usage_reset_period

enum<string>

Available options:

MONTHLY,

ANNUAL,

WEEKLY,

DAILY

items.plan.id

string

items.plan.invoice_cadence

enum<string>

Available options:

ARREAR,

ADVANCE

items.plan.lookup_key

string

items.plan.name

string

items.plan.prices

object[]

items.plan.prices.amount

number

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

items.plan.prices.billing_cadence

any

items.plan.prices.billing_model

any

items.plan.prices.billing_period

any

items.plan.prices.billing_period_count

integer

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

items.plan.prices.created_at

string

items.plan.prices.created_by

string

items.plan.prices.currency

string

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

items.plan.prices.description

string

Description of the price

items.plan.prices.display_amount

string

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

items.plan.prices.filter_values

object

FilterValues are the filter values for the price in case of usage based pricing

items.plan.prices.id

string

ID uuid identifier for the price

items.plan.prices.lookup_key

string

LookupKey used for looking up the price in the database

items.plan.prices.metadata

object

Metadata is a jsonb field for additional information

items.plan.prices.meter

object

items.plan.prices.meter_id

string

MeterID is the id of the meter for usage based pricing

items.plan.prices.plan_id

string

PlanID is the id of the plan for plan based pricing

items.plan.prices.status

enum<string>

Available options:

published,

deleted,

archived

items.plan.prices.tenant_id

string

items.plan.prices.tier_mode

any

items.plan.prices.tiers

object[]

Tiers are the tiers for the price when BillingModel is TIERED

items.plan.prices.transform_quantity

object

Transform is the quantity transformation in case of PACKAGE billing model

items.plan.prices.type

any

items.plan.prices.updated_at

string

items.plan.prices.updated_by

string

items.plan.status

enum<string>

Available options:

published,

deleted,

archived

items.plan.tenant_id

string

items.plan.trial_period

integer

items.plan.updated_at

string

items.plan.updated_by

string

items.plan_id

string

items.static_value

string

items.status

enum<string>

Available options:

published,

deleted,

archived

items.tenant_id

string

items.updated_at

string

items.updated_by

string

items.usage_limit

integer

items.usage_reset_period

enum<string>

Available options:

MONTHLY,

ANNUAL,

WEEKLY,

DAILY

pagination

object

API Documentation

Auth

Customers

Invoices

Wallets

Entitlements

Environments

Events

Features

Meters

Plans

Prices

Subscriptions

Tenants

Users

Authorizations

Query Parameters

Response