List products
List all products of a platform.
Responses
- 200
- 400
- 401
- 403
- 404
- 500
- default
A successful response.
application/json
Schema
Example (from schema)
Schema
- Array [
- Array [
- ]
- Array [
- ]
- ]
products object[]
id string
name string
title string
description string
plan_ids string[]
state string
prices object[]
id string
product_id string
provider_id string
name string
interval known intervals are "day", "week", "month", and "year"
usage_type usage_type known types are "licensed" and "metered"
billing_scheme billing_scheme known schemes are "tiered" and "flat"
state string
currency currency like "usd", "eur", "gbp"
amount int64
metered_aggregate metered_aggregate known aggregations are "sum", "last_during_period" and "max"
tier_mode tier_mode known modes are "graduated" and "volume"
metadata object
created_at date-time
updated_at date-time
behavior string
features object[]
id string
name machine friendly name
product_ids string[]
title human friendly name
metadata object
created_at date-time
updated_at date-time
behavior_config object
credit_amount int64
seat_limit int64
min_quantity int64
max_quantity int64
metadata object
created_at date-time
updated_at date-time
{
"products": [
{
"id": "string",
"name": "string",
"title": "string",
"description": "string",
"plan_ids": [
"string"
],
"state": "string",
"prices": [
{
"id": "string",
"product_id": "string",
"provider_id": "string",
"name": "string",
"interval": "string",
"usage_type": "string",
"billing_scheme": "string",
"state": "string",
"currency": "string",
"amount": "string",
"metered_aggregate": "string",
"tier_mode": "string",
"metadata": {},
"created_at": "2024-07-13T09:54:48.223Z",
"updated_at": "2024-07-13T09:54:48.223Z"
}
],
"behavior": "string",
"features": [
{
"id": "string",
"name": "string",
"product_ids": [
"string"
],
"title": "string",
"metadata": {},
"created_at": "2024-07-13T09:54:48.223Z",
"updated_at": "2024-07-13T09:54:48.223Z"
}
],
"behavior_config": {
"credit_amount": "string",
"seat_limit": "string",
"min_quantity": "string",
"max_quantity": "string"
},
"metadata": {},
"created_at": "2024-07-13T09:54:48.223Z",
"updated_at": "2024-07-13T09:54:48.223Z"
}
]
}
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...