List subscriptions
List subscriptions of a billing account.
Path Parameters
org_id string required
billing_id string required
ID of the billing account to list subscriptions for
Query Parameters
state string
Filter subscriptions by state
plan string
Responses
- 200
- 400
- 401
- 403
- 404
- 500
- default
A successful response.
application/json
Schema
Example (from schema)
Schema
- Array [
- Array [
- ]
- ]
subscriptions object[]
id string
customer_id string
provider_id string
plan_id string
state string
trial_days int32
metadata object
created_at date-time
updated_at date-time
canceled_at date-time
ended_at date-time
phases object[]
effective_at date-time
plan_id string
{
"subscriptions": [
{
"id": "string",
"customer_id": "string",
"provider_id": "string",
"plan_id": "string",
"state": "string",
"trial_days": 0,
"metadata": {},
"created_at": "2024-01-24T15:23:30.686Z",
"updated_at": "2024-01-24T15:23:30.686Z",
"canceled_at": "2024-01-24T15:23:30.686Z",
"ended_at": "2024-01-24T15:23:30.686Z",
"phases": [
{
"effective_at": "2024-01-24T15:23:30.686Z",
"plan_id": "string"
}
]
}
]
}
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...