List plans
This endpoint returns a list of all plans for an account in a list format.
The list of plans is ordered starting from the most recently created plan.
The response also includes pagination_metadata
,
which lets the caller retrieve the next page of results if they exist.
Query Parameters
Default value: 20
Possible values: [active
, archived
, draft
]
- 200
- 400
- 401
- 404
- 409
- 413
- 429
- 500
OK
Response Headers
Schema
- Array [
- Array [
- ]
- Array [
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- ]
- ]
data object[] required
metadata object required
User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to null
, and the entire metadata mapping can be cleared by setting metadata
to null
.
Possible values: [active
, archived
, draft
]
maximum object nullable
Maximum amount applied
List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
minimum object nullable
Minimum amount applied
List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
discount object nullable
Possible values: [percentage
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Possible values: <= 1
Only available if discount_type is percentage
. This is a number between 0 and 1.
Possible values: [trial
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is trial
Only available if discount_type is trial
Possible values: [usage
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is usage
. Number of usage units that this discount is for
Possible values: [amount
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is amount
.
product object required
trial_config object required
Possible values: [days
]
plan_phases object[] nullable required
How many terms of length duration_unit
this phase is active for. If null, this phase is evergreen and active indefinitely
Possible values: [daily
, monthly
, quarterly
, annual
]
Determines the ordering of the phase in a plan's lifecycle. 1 = first phase.
minimum object nullable
Minimum amount applied
List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
maximum object nullable
Maximum amount applied
List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
discount object nullable
Possible values: [percentage
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Possible values: <= 1
Only available if discount_type is percentage
. This is a number between 0 and 1.
Possible values: [trial
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is trial
Only available if discount_type is trial
Possible values: [usage
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is usage
. Number of usage units that this discount is for
Possible values: [amount
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is amount
.
base_plan object nullable
An optional user-defined ID for this plan resource, used throughout the system as an alias for this Plan. Use this field to identify a plan by an existing identifier in your system.
The parent plan id if the given plan was created by overriding one or more of the parent's prices
An optional user-defined ID for this plan resource, used throughout the system as an alias for this Plan. Use this field to identify a plan by an existing identifier in your system.
An ISO 4217 currency string or custom pricing unit (credits
) for this plan's prices.
An ISO 4217 currency string for which this plan is billed in. Matches currency
unless currency
is a custom pricing unit.
Determines the difference between the invoice issue date and the due date. A value of "0" here signifies that invoices are due on issue, whereas a value of "30" means that the customer has a month to pay the invoice before its overdue. Note that individual subscriptions or invoices may set a different net terms configuration.
The default memo text on the invoices corresponding to subscriptions on this plan. Note that each subscription may configure its own memo.
prices object[] required
Prices for this plan. If the plan has phases, this includes prices across all phases of the plan.
Possible values: [usage_price
, fixed_price
]
Possible values: [unit
]
Possible values: [one_time
, monthly
, quarterly
, annual
]
billable_metric object nullable
item object required
discount object nullable
Possible values: [percentage
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Possible values: <= 1
Only available if discount_type is percentage
. This is a number between 0 and 1.
Possible values: [trial
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is trial
Only available if discount_type is trial
Possible values: [usage
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is usage
. Number of usage units that this discount is for
Possible values: [amount
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is amount
.
minimum object nullable
Minimum amount applied
List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
maximum object nullable
Maximum amount applied
List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
unit_config object required
Rate per unit of usage
Multiplier to scale rated quantity by
Possible values: [usage_price
, fixed_price
]
Possible values: [package
]
Possible values: [one_time
, monthly
, quarterly
, annual
]
billable_metric object nullable
item object required
discount object nullable
Possible values: [percentage
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Possible values: <= 1
Only available if discount_type is percentage
. This is a number between 0 and 1.
Possible values: [trial
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is trial
Only available if discount_type is trial
Possible values: [usage
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is usage
. Number of usage units that this discount is for
Possible values: [amount
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is amount
.
minimum object nullable
Minimum amount applied
List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
maximum object nullable
Maximum amount applied
List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
package_config object required
A currency amount to rate usage by
An integer amount to represent package size. For example, 1000 here would divide usage by 1000 before multiplying by package_amount in rating
Possible values: [usage_price
, fixed_price
]
Possible values: [matrix
]
Possible values: [one_time
, monthly
, quarterly
, annual
]
billable_metric object nullable
item object required
discount object nullable
Possible values: [percentage
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Possible values: <= 1
Only available if discount_type is percentage
. This is a number between 0 and 1.
Possible values: [trial
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is trial
Only available if discount_type is trial
Possible values: [usage
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is usage
. Number of usage units that this discount is for
Possible values: [amount
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is amount
.
minimum object nullable
Minimum amount applied
List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
maximum object nullable
Maximum amount applied
List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
matrix_config object required
One or two event property values to evaluate matrix groups by
Default per unit rate for any usage not bucketed into a specified matrix_value
matrix_values object[] required
Matrix values for specified matrix grouping keys
Unit price for the specified dimension_values
Optional multiplier to scale rated quantities by
One or two matrix keys to filter usage to this Matrix value by. For example, ["region", "tier"] could be used to filter cloud usage by a cloud region and an instance tier.
Default optional multiplier to scale rated quantities that fall into the default bucket by
Possible values: [usage_price
, fixed_price
]
Possible values: [tiered
]
Possible values: [one_time
, monthly
, quarterly
, annual
]
billable_metric object nullable
item object required
discount object nullable
Possible values: [percentage
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Possible values: <= 1
Only available if discount_type is percentage
. This is a number between 0 and 1.
Possible values: [trial
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is trial
Only available if discount_type is trial
Possible values: [usage
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is usage
. Number of usage units that this discount is for
Possible values: [amount
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is amount
.
minimum object nullable
Minimum amount applied
List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
maximum object nullable
Maximum amount applied
List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
tiered_config object required
tiers object[] required
Tiers for rating based on total usage quantities into the specified tier
Inclusive tier starting value
Exclusive tier ending value. If null, this is treated as the last tier
Amount per unit
Possible values: [usage_price
, fixed_price
]
Possible values: [tiered_bps
]
Possible values: [one_time
, monthly
, quarterly
, annual
]
billable_metric object nullable
item object required
discount object nullable
Possible values: [percentage
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Possible values: <= 1
Only available if discount_type is percentage
. This is a number between 0 and 1.
Possible values: [trial
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is trial
Only available if discount_type is trial
Possible values: [usage
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is usage
. Number of usage units that this discount is for
Possible values: [amount
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is amount
.
minimum object nullable
Minimum amount applied
List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
maximum object nullable
Maximum amount applied
List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
tiered_bps_config object required
tiers object[] required
Tiers for a Graduated BPS pricing model, where usage is bucketed into specified tiers
Inclusive tier starting value
Exclusive tier ending value
Per-event basis point rate
Per unit maximum to charge
Possible values: [usage_price
, fixed_price
]
Possible values: [bps
]
Possible values: [one_time
, monthly
, quarterly
, annual
]
billable_metric object nullable
item object required
discount object nullable
Possible values: [percentage
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Possible values: <= 1
Only available if discount_type is percentage
. This is a number between 0 and 1.
Possible values: [trial
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is trial
Only available if discount_type is trial
Possible values: [usage
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is usage
. Number of usage units that this discount is for
Possible values: [amount
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is amount
.
minimum object nullable
Minimum amount applied
List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
maximum object nullable
Maximum amount applied
List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
bps_config object required
Basis point take rate per event
Optional currency amount maximum to cap spend per event
Possible values: [usage_price
, fixed_price
]
Possible values: [bulk_bps
]
Possible values: [one_time
, monthly
, quarterly
, annual
]
billable_metric object nullable
item object required
discount object nullable
Possible values: [percentage
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Possible values: <= 1
Only available if discount_type is percentage
. This is a number between 0 and 1.
Possible values: [trial
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is trial
Only available if discount_type is trial
Possible values: [usage
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is usage
. Number of usage units that this discount is for
Possible values: [amount
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is amount
.
minimum object nullable
Minimum amount applied
List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
maximum object nullable
Maximum amount applied
List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
bulk_bps_config object required
tiers object[] required
Tiers for a bulk BPS pricing model where all usage is aggregated to a single tier based on total volume
Upper bound for tier
Basis points to rate on
The maximum amount to charge for any one event
Possible values: [usage_price
, fixed_price
]
Possible values: [bulk
]
Possible values: [one_time
, monthly
, quarterly
, annual
]
billable_metric object nullable
item object required
discount object nullable
Possible values: [percentage
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Possible values: <= 1
Only available if discount_type is percentage
. This is a number between 0 and 1.
Possible values: [trial
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is trial
Only available if discount_type is trial
Possible values: [usage
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is usage
. Number of usage units that this discount is for
Possible values: [amount
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is amount
.
minimum object nullable
Minimum amount applied
List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
maximum object nullable
Maximum amount applied
List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
bulk_config object required
tiers object[] required
Bulk tiers for rating based on total usage volume
Upper bound for this tier
Amount per unit
Possible values: [usage_price
, fixed_price
]
Possible values: [test_rating_function
]
Possible values: [one_time
, monthly
, quarterly
, annual
]
billable_metric object nullable
item object required
discount object nullable
Possible values: [percentage
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Possible values: <= 1
Only available if discount_type is percentage
. This is a number between 0 and 1.
Possible values: [trial
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is trial
Only available if discount_type is trial
Possible values: [usage
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is usage
. Number of usage units that this discount is for
Possible values: [amount
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is amount
.
minimum object nullable
Minimum amount applied
List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
maximum object nullable
Maximum amount applied
List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
test_rating_function_config object required
Possible values: [usage_price
, fixed_price
]
Possible values: [fivetran_example
]
Possible values: [one_time
, monthly
, quarterly
, annual
]
billable_metric object nullable
item object required
discount object nullable
Possible values: [percentage
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Possible values: <= 1
Only available if discount_type is percentage
. This is a number between 0 and 1.
Possible values: [trial
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is trial
Only available if discount_type is trial
Possible values: [usage
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is usage
. Number of usage units that this discount is for
Possible values: [amount
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is amount
.
minimum object nullable
Minimum amount applied
List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
maximum object nullable
Maximum amount applied
List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
fivetran_example_config object required
Possible values: [usage_price
, fixed_price
]
Possible values: [threshold_total_amount
]
Possible values: [one_time
, monthly
, quarterly
, annual
]
billable_metric object nullable
item object required
discount object nullable
Possible values: [percentage
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Possible values: <= 1
Only available if discount_type is percentage
. This is a number between 0 and 1.
Possible values: [trial
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is trial
Only available if discount_type is trial
Possible values: [usage
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is usage
. Number of usage units that this discount is for
Possible values: [amount
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is amount
.
minimum object nullable
Minimum amount applied
List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
maximum object nullable
Maximum amount applied
List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
threshold_total_amount_config object required
Possible values: [usage_price
, fixed_price
]
Possible values: [tiered_package
]
Possible values: [one_time
, monthly
, quarterly
, annual
]
billable_metric object nullable
item object required
discount object nullable
Possible values: [percentage
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Possible values: <= 1
Only available if discount_type is percentage
. This is a number between 0 and 1.
Possible values: [trial
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is trial
Only available if discount_type is trial
Possible values: [usage
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is usage
. Number of usage units that this discount is for
Possible values: [amount
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is amount
.
minimum object nullable
Minimum amount applied
List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
maximum object nullable
Maximum amount applied
List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
tiered_package_config object required
Possible values: [usage_price
, fixed_price
]
Possible values: [tiered_with_minimum
]
Possible values: [one_time
, monthly
, quarterly
, annual
]
billable_metric object nullable
item object required
discount object nullable
Possible values: [percentage
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Possible values: <= 1
Only available if discount_type is percentage
. This is a number between 0 and 1.
Possible values: [trial
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is trial
Only available if discount_type is trial
Possible values: [usage
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is usage
. Number of usage units that this discount is for
Possible values: [amount
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is amount
.
minimum object nullable
Minimum amount applied
List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
maximum object nullable
Maximum amount applied
List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
tiered_with_minimum_config object required
Possible values: [usage_price
, fixed_price
]
Possible values: [package_with_allocation
]
Possible values: [one_time
, monthly
, quarterly
, annual
]
billable_metric object nullable
item object required
discount object nullable
Possible values: [percentage
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Possible values: <= 1
Only available if discount_type is percentage
. This is a number between 0 and 1.
Possible values: [trial
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is trial
Only available if discount_type is trial
Possible values: [usage
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is usage
. Number of usage units that this discount is for
Possible values: [amount
]
List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
Only available if discount_type is amount
.
minimum object nullable
Minimum amount applied
List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
maximum object nullable
Maximum amount applied
List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
package_with_allocation_config object required
pagination_metadata object required
{
"data": [
{
"metadata": {},
"id": "string",
"name": "string",
"description": "string",
"maximum_amount": "string",
"minimum_amount": "string",
"created_at": "2023-12-02T00:01:08.325Z",
"status": "active",
"maximum": {
"maximum_amount": "string",
"applies_to_price_ids": [
"string"
]
},
"minimum": {
"minimum_amount": "string",
"applies_to_price_ids": [
"string"
]
},
"discount": {
"discount_type": "percentage",
"applies_to_price_ids": [
"h74gfhdjvn7ujokd",
"7hfgtgjnbvc3ujkl"
],
"reason": "string",
"percentage_discount": 0.15
},
"product": {
"created_at": "2023-12-02T00:01:08.326Z",
"id": "string",
"name": "string"
},
"trial_config": {
"trial_period": 0,
"trial_period_unit": "days"
},
"plan_phases": [
{
"id": "string",
"description": "string",
"duration": 0,
"duration_unit": "daily",
"name": "string",
"order": 0,
"minimum": {
"minimum_amount": "string",
"applies_to_price_ids": [
"string"
]
},
"maximum": {
"maximum_amount": "string",
"applies_to_price_ids": [
"string"
]
},
"maximum_amount": "string",
"minimum_amount": "string",
"discount": {
"discount_type": "percentage",
"applies_to_price_ids": [
"h74gfhdjvn7ujokd",
"7hfgtgjnbvc3ujkl"
],
"reason": "string",
"percentage_discount": 0.15
}
}
],
"base_plan": {
"id": "m2t5akQeh2obwxeU",
"external_plan_id": "m2t5akQeh2obwxeU",
"name": "Example plan"
},
"base_plan_id": "string",
"external_plan_id": "string",
"currency": "string",
"invoicing_currency": "string",
"net_terms": 0,
"default_invoice_memo": "string",
"prices": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
]
}
],
"pagination_metadata": {
"has_more": true,
"next_cursor": "string"
}
}
Bad Request
Response Headers
Schema
Possible values: [https://docs.withorb.com/reference/error-responses#400-constraint-violation
]
Possible values: [400
]
Possible values: [https://docs.withorb.com/reference/error-responses#400-duplicate-resource-creation
]
Possible values: [400
]
Possible values: [https://docs.withorb.com/reference/error-responses#400-request-validation-errors
]
Possible values: [400
]
{}
Unauthorized
Response Headers
Schema
Possible values: [https://docs.withorb.com/reference/error-responses#401-authentication-error
]
Possible values: [401
]
{
"type": "https://docs.withorb.com/reference/error-responses#401-authentication-error",
"status": 401,
"detail": "string",
"title": "string"
}
Not Found
Response Headers
Schema
Possible values: [https://docs.withorb.com/reference/error-responses#404-feature-not-available
]
Possible values: [400
]
Possible values: [https://docs.withorb.com/reference/error-responses#404-resource-not-found
]
Possible values: [404
]
Possible values: [https://docs.withorb.com/reference/error-responses#404-url-not-found
]
Possible values: [404
]
{}
Conflict
Response Headers
Schema
Possible values: [https://docs.withorb.com/reference/error-responses#409-resource-conflict
]
Possible values: [409
]
{
"type": "https://docs.withorb.com/reference/error-responses#409-resource-conflict",
"status": 409,
"detail": "string",
"title": "string"
}
Request Entity Too Large
Response Headers
Schema
Possible values: [https://docs.withorb.com/reference/error-responses#413-request-too-large
]
Possible values: [413
]
Possible values: [https://docs.withorb.com/reference/error-responses#413-resource-too-large
]
Possible values: [413
]
{}
Too Many Requests
Response Headers
Schema
Possible values: [https://docs.withorb.com/reference/error-responses#429-too-many-requests
]
Possible values: [429
]
{
"type": "https://docs.withorb.com/reference/error-responses#429-too-many-requests",
"status": 429,
"detail": "string",
"title": "string"
}
Internal Server Error
Response Headers
Schema
Possible values: [https://docs.withorb.com/reference/error-responses#500-internal-server-error
]
{
"type": "https://docs.withorb.com/reference/error-responses#500-internal-server-error",
"status": 0,
"detail": "string",
"title": "string"
}