Skip to main content
GET
/
prices
Get prices
curl --request GET \
  --url https://api.cloud.flexprice.io/v1/prices \
  --header 'x-api-key: <api-key>'
{
  "items": [
    {
      "addon": {
        "created_at": "<string>",
        "created_by": "<string>",
        "description": "<string>",
        "entitlements": [
          {
            "addon": {},
            "created_at": "<string>",
            "created_by": "<string>",
            "display_order": 123,
            "entity_id": "<string>",
            "entity_type": "PLAN",
            "environment_id": "<string>",
            "feature": {
              "alert_settings": {
                "alert_enabled": true,
                "critical": {
                  "condition": "above",
                  "threshold": 123
                },
                "info": {
                  "condition": "above",
                  "threshold": 123
                },
                "warning": {
                  "condition": "above",
                  "threshold": 123
                }
              },
              "created_at": "<string>",
              "created_by": "<string>",
              "description": "<string>",
              "environment_id": "<string>",
              "id": "<string>",
              "lookup_key": "<string>",
              "metadata": {},
              "meter": {
                "aggregation": {
                  "bucket_size": "MINUTE",
                  "field": "<string>",
                  "multiplier": 123,
                  "type": "COUNT"
                },
                "created_at": "2024-03-20T15:04:05Z",
                "event_name": "api_request",
                "filters": [
                  {
                    "key": "<string>",
                    "values": [
                      "<any>"
                    ]
                  }
                ],
                "id": "550e8400-e29b-41d4-a716-446655440000",
                "name": "API Usage Meter",
                "reset_usage": "BILLING_PERIOD",
                "status": "published",
                "tenant_id": "tenant123",
                "updated_at": "2024-03-20T15:04:05Z"
              },
              "meter_id": "<string>",
              "name": "<string>",
              "status": "published",
              "tenant_id": "<string>",
              "type": "metered",
              "unit_plural": "<string>",
              "unit_singular": "<string>",
              "updated_at": "<string>",
              "updated_by": "<string>"
            },
            "feature_id": "<string>",
            "feature_type": "metered",
            "id": "<string>",
            "is_enabled": true,
            "is_soft_limit": true,
            "parent_entitlement_id": "<string>",
            "plan": {
              "created_at": "<string>",
              "created_by": "<string>",
              "credit_grants": [
                {
                  "cadence": "ONETIME",
                  "created_at": "<string>",
                  "created_by": "<string>",
                  "credits": 123,
                  "environment_id": "<string>",
                  "expiration_duration": 123,
                  "expiration_duration_unit": "DAY",
                  "expiration_type": "NEVER",
                  "id": "<string>",
                  "metadata": {},
                  "name": "<string>",
                  "period": "DAILY",
                  "period_count": 123,
                  "plan_id": "<string>",
                  "priority": 123,
                  "scope": "PLAN",
                  "status": "published",
                  "subscription_id": "<string>",
                  "tenant_id": "<string>",
                  "updated_at": "<string>",
                  "updated_by": "<string>"
                }
              ],
              "description": "<string>",
              "display_order": 123,
              "entitlements": [
                {}
              ],
              "environment_id": "<string>",
              "id": "<string>",
              "lookup_key": "<string>",
              "metadata": {},
              "name": "<string>",
              "prices": [
                {}
              ],
              "status": "published",
              "tenant_id": "<string>",
              "updated_at": "<string>",
              "updated_by": "<string>"
            },
            "plan_id": "<string>",
            "static_value": "<string>",
            "status": "published",
            "tenant_id": "<string>",
            "updated_at": "<string>",
            "updated_by": "<string>",
            "usage_limit": 123,
            "usage_reset_period": "MONTHLY"
          }
        ],
        "environment_id": "<string>",
        "id": "<string>",
        "lookup_key": "<string>",
        "metadata": {},
        "name": "<string>",
        "prices": [
          {}
        ],
        "status": "published",
        "tenant_id": "<string>",
        "type": "onetime",
        "updated_at": "<string>",
        "updated_by": "<string>"
      },
      "amount": 123,
      "billing_cadence": "RECURRING",
      "billing_model": "FLAT_FEE",
      "billing_period": "MONTHLY",
      "billing_period_count": 123,
      "conversion_rate": 123,
      "created_at": "<string>",
      "created_by": "<string>",
      "currency": "<string>",
      "description": "<string>",
      "display_amount": "<string>",
      "display_price_unit_amount": "<string>",
      "end_date": "<string>",
      "entity_id": "<string>",
      "entity_type": "PLAN",
      "environment_id": "<string>",
      "group": {
        "created_at": "<string>",
        "entity_ids": [
          "<string>"
        ],
        "entity_type": "<string>",
        "id": "<string>",
        "lookup_key": "<string>",
        "metadata": {},
        "name": "<string>",
        "status": "<string>",
        "updated_at": "<string>"
      },
      "group_id": "<string>",
      "id": "<string>",
      "invoice_cadence": "ARREAR",
      "lookup_key": "<string>",
      "metadata": {},
      "meter": {
        "aggregation": {
          "bucket_size": "MINUTE",
          "field": "<string>",
          "multiplier": 123,
          "type": "COUNT"
        },
        "created_at": "2024-03-20T15:04:05Z",
        "event_name": "api_request",
        "filters": [
          {
            "key": "<string>",
            "values": [
              "<string>"
            ]
          }
        ],
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "API Usage Meter",
        "reset_usage": "BILLING_PERIOD",
        "status": "published",
        "tenant_id": "tenant123",
        "updated_at": "2024-03-20T15:04:05Z"
      },
      "meter_id": "<string>",
      "parent_price_id": "<string>",
      "plan": {
        "created_at": "<string>",
        "created_by": "<string>",
        "credit_grants": [
          {
            "cadence": "ONETIME",
            "created_at": "<string>",
            "created_by": "<string>",
            "credits": 123,
            "environment_id": "<string>",
            "expiration_duration": 123,
            "expiration_duration_unit": "DAY",
            "expiration_type": "NEVER",
            "id": "<string>",
            "metadata": {},
            "name": "<string>",
            "period": "DAILY",
            "period_count": 123,
            "plan_id": "<string>",
            "priority": 123,
            "scope": "PLAN",
            "status": "published",
            "subscription_id": "<string>",
            "tenant_id": "<string>",
            "updated_at": "<string>",
            "updated_by": "<string>"
          }
        ],
        "description": "<string>",
        "display_order": 123,
        "entitlements": [
          {}
        ],
        "environment_id": "<string>",
        "id": "<string>",
        "lookup_key": "<string>",
        "metadata": {},
        "name": "<string>",
        "prices": [
          {}
        ],
        "status": "published",
        "tenant_id": "<string>",
        "updated_at": "<string>",
        "updated_by": "<string>"
      },
      "plan_id": "<string>",
      "price_unit": "<string>",
      "price_unit_amount": 123,
      "price_unit_id": "<string>",
      "price_unit_tiers": [
        {
          "flat_amount": 123,
          "unit_amount": 123,
          "up_to": 123
        }
      ],
      "price_unit_type": "FIAT",
      "pricing_unit": {
        "base_currency": "<string>",
        "code": "<string>",
        "conversion_rate": 123,
        "created_at": "<string>",
        "created_by": "<string>",
        "environment_id": "<string>",
        "id": "<string>",
        "name": "<string>",
        "precision": 123,
        "status": "published",
        "symbol": "<string>",
        "tenant_id": "<string>",
        "updated_at": "<string>",
        "updated_by": "<string>"
      },
      "start_date": "<string>",
      "status": "published",
      "tenant_id": "<string>",
      "tier_mode": "VOLUME",
      "tiers": [
        {
          "flat_amount": 123,
          "unit_amount": 123,
          "up_to": 123
        }
      ],
      "transform_quantity": {
        "divide_by": 123,
        "round": "<string>"
      },
      "trial_period": 123,
      "type": "USAGE",
      "updated_at": "<string>",
      "updated_by": "<string>"
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

Authorizations

​
x-api-key
string
header
required

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

Query Parameters

​
allow_expired_prices
boolean
default:false
​
end_time
string
​
entity_ids
string[]
​
entity_type
enum<string>
Available options:
PLAN,
SUBSCRIPTION,
ADDON,
PRICE,
COSTSHEET
​
expand
string
​
limit
integer
Required range: 1 <= x <= 1000
​
meter_ids
string[]
​
offset
integer
Required range: x >= 0
​
order
enum<string>
Available options:
asc,
desc
​
parent_price_id
string
​
plan_ids
string[]

Price override filtering fields

​
price_ids
string[]
​
sort
string
​
start_date_lt
string
​
start_time
string
​
status
enum<string>
Available options:
published,
deleted,
archived
​
subscription_id
string

Response

OK

​
items
object[]
​
pagination
object