Retrieve a Plan

get

https://api.brilo.tech/api/plans/

Fetches the specific details, pricing structures, and configuration of a single plan using its unique ID.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

duration

string

enum

length ≥ 1

Filter to plans that have this duration.

monthly - Monthly
quarterly - Quarterly
yearly - Yearly

Allowed:

exclude_tags

array of strings

Filter to plans that do not have any of the tags in this list.

exclude_tags

include_tags

array of strings

Filter to plans that have any of the tags in this list.

include_tags

include_tags_all

array of strings

Filter to plans that have all of the tags in this list.

include_tags_all

version_currency_code

string

length ≥ 1

Filter to versions that have the currency specified by this currency code.

version_custom_type

string

enum

length ≥ 1

Defaults to all

Filter to versions that have this custom type. If you choose custom_only, you will only see versions that have target customers. If you choose public_only, you will only see versions that do not have target customers.

custom_only - Custom Only
public_only - Public Only
all - All

Allowed:

version_status

array of strings

Defaults to active,not_started,ended

Filter to versions that have this status. Ended means it has an active_to date in the past. Not started means it has an active_from date in the future or null.

version_status

Allowed:

Response

200