List plans
List all plans.
Responses
- 200
- 400
- 401
- 403
- 404
- 500
- default
A successful response.
application/json
Schema
Example (from schema)
Schema
- Array [
- Array [
- Array [
- ]
- ]
- ]
plans object[]
id string
name string
title string
description string
features object[]
id string
name string
title string
description string
planIds string[]
state string
prices object[]
id string
featureId string
providerId string
name string
interval known intervals are "day", "week", "month", and "year"
usageType usage_type known types are "licensed" and "metered"
billingScheme billing_scheme known schemes are "tiered" and "flat"
state string
currency currency like "usd", "eur", "gbp"
amount int64
meteredAggregate metered_aggregate known aggregations are "sum", "last_during_period" and "max"
tierMode tier_mode known modes are "graduated" and "volume"
metadata object
createdAt date-time
updatedAt date-time
creditAmount int64
behavior string
metadata object
createdAt date-time
updatedAt date-time
interval known intervals are "day", "week", "month", and "year"
metadata object
createdAt date-time
updatedAt date-time
{
  "plans": [
    {
      "id": "string",
      "name": "string",
      "title": "string",
      "description": "string",
      "features": [
        {
          "id": "string",
          "name": "string",
          "title": "string",
          "description": "string",
          "planIds": [
            "string"
          ],
          "state": "string",
          "prices": [
            {
              "id": "string",
              "featureId": "string",
              "providerId": "string",
              "name": "string",
              "interval": "string",
              "usageType": "string",
              "billingScheme": "string",
              "state": "string",
              "currency": "string",
              "amount": "string",
              "meteredAggregate": "string",
              "tierMode": "string",
              "metadata": {},
              "createdAt": "2024-01-01T17:13:19.563Z",
              "updatedAt": "2024-01-01T17:13:19.563Z"
            }
          ],
          "creditAmount": "string",
          "behavior": "string",
          "metadata": {},
          "createdAt": "2024-01-01T17:13:19.563Z",
          "updatedAt": "2024-01-01T17:13:19.563Z"
        }
      ],
      "interval": "string",
      "metadata": {},
      "createdAt": "2024-01-01T17:13:19.563Z",
      "updatedAt": "2024-01-01T17:13:19.563Z"
    }
  ]
}
Bad Request - The request was malformed or contained invalid parameters.
application/json
Schema
Example (from schema)
Schema
- Array [
- ]
code int32
message string
details object[]
@type string
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
Unauthorized - Authentication is required
application/json
Schema
Example (from schema)
Schema
- Array [
- ]
code int32
message string
details object[]
@type string
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
Forbidden - User does not have permission to access the resource
application/json
Schema
Example (from schema)
Schema
- Array [
- ]
code int32
message string
details object[]
@type string
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
Not Found - The requested resource was not found
application/json
Schema
Example (from schema)
Schema
- Array [
- ]
code int32
message string
details object[]
@type string
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
Internal Server Error. Returned when theres is something wrong with Frontier server.
application/json
Schema
Example (from schema)
Schema
- Array [
- ]
code int32
message string
details object[]
@type string
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
An unexpected error response.
application/json
Schema
Example (from schema)
Schema
- Array [
- ]
code int32
message string
details object[]
@type string
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
Loading...