List billing addons and compute instance selections
get
/v1/projects/{ref}/billing/addonsReturns the billing addons that are currently applied, including the active compute instance size, and lists every addon option that can be provisioned with pricing metadata.
The fine-grained token must include the following permissions to access this endpoint:
- infra_add_ons_read
Path parameters
- refRequiredstring
Project ref
Response codes
- 200
- 401
- 403
- 429
- 500
Response (200)
{ "selected_addons": [ { "type": "custom_domain", "variant": { "id": "ci_micro", "name": "lorem", "price": { "description": "lorem", "type": "fixed", "interval": "monthly", "amount": 42 }, "meta": "lorem" } } ], "available_addons": [ { "type": "custom_domain", "name": "lorem", "variants": [ { "id": "ci_micro", "name": "lorem", "price": { "description": "lorem", "type": "fixed", "interval": "monthly", "amount": 42 }, "meta": "lorem" } ] } ]}{ "type": "object", "properties": { "selected_addons": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "custom_domain", "compute_instance", "pitr", "ipv4", "auth_mfa_phone", "auth_mfa_web_authn", "log_drain", "etl_pipeline" ] }, "variant": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "enum": [ "ci_micro", "ci_small", "ci_medium", "ci_large", "ci_xlarge", "ci_2xlarge", "ci_4xlarge", "ci_8xlarge", "ci_12xlarge", "ci_16xlarge", "ci_24xlarge", "ci_24xlarge_optimized_cpu", "ci_24xlarge_optimized_memory", "ci_24xlarge_high_memory", "ci_48xlarge", "ci_48xlarge_optimized_cpu", "ci_48xlarge_optimized_memory", "ci_48xlarge_high_memory" ] }, { "type": "string", "enum": [ "cd_default" ] }, { "type": "string", "enum": [ "pitr_7", "pitr_14", "pitr_28" ] }, { "type": "string", "enum": [ "ipv4_default" ] }, { "type": "string", "enum": [ "auth_mfa_phone_default" ] }, { "type": "string", "enum": [ "auth_mfa_web_authn_default" ] }, { "type": "string", "enum": [ "log_drain_default" ] }, { "type": "string", "enum": [ "etl_pipeline_default" ] } ] }, "name": { "type": "string" }, "price": { "type": "object", "properties": { "description": { "type": "string" }, "type": { "type": "string", "enum": [ "fixed", "usage" ] }, "interval": { "type": "string", "enum": [ "monthly", "hourly" ] }, "amount": { "type": "number" } }, "required": [ "description", "type", "interval", "amount" ] }, "meta": { "description": "Any JSON-serializable value", "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ], "nullable": true }, { "type": "array", "items": { "$ref": "#/components/schemas/JsonValue_Output" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/JsonValue_Output" } } ] } }, "required": [ "id", "name", "price" ] } }, "required": [ "type", "variant" ] } }, "available_addons": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "custom_domain", "compute_instance", "pitr", "ipv4", "auth_mfa_phone", "auth_mfa_web_authn", "log_drain", "etl_pipeline" ] }, "name": { "type": "string" }, "variants": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "enum": [ "ci_micro", "ci_small", "ci_medium", "ci_large", "ci_xlarge", "ci_2xlarge", "ci_4xlarge", "ci_8xlarge", "ci_12xlarge", "ci_16xlarge", "ci_24xlarge", "ci_24xlarge_optimized_cpu", "ci_24xlarge_optimized_memory", "ci_24xlarge_high_memory", "ci_48xlarge", "ci_48xlarge_optimized_cpu", "ci_48xlarge_optimized_memory", "ci_48xlarge_high_memory" ] }, { "type": "string", "enum": [ "cd_default" ] }, { "type": "string", "enum": [ "pitr_7", "pitr_14", "pitr_28" ] }, { "type": "string", "enum": [ "ipv4_default" ] }, { "type": "string", "enum": [ "auth_mfa_phone_default" ] }, { "type": "string", "enum": [ "auth_mfa_web_authn_default" ] }, { "type": "string", "enum": [ "log_drain_default" ] }, { "type": "string", "enum": [ "etl_pipeline_default" ] } ] }, "name": { "type": "string" }, "price": { "type": "object", "properties": { "description": { "type": "string" }, "type": { "type": "string", "enum": [ "fixed", "usage" ] }, "interval": { "type": "string", "enum": [ "monthly", "hourly" ] }, "amount": { "type": "number" } }, "required": [ "description", "type", "interval", "amount" ] }, "meta": { "description": "Any JSON-serializable value", "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ], "nullable": true }, { "type": "array", "items": { "$ref": "#/components/schemas/JsonValue_Output" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/JsonValue_Output" } } ] } }, "required": [ "id", "name", "price" ] } } }, "required": [ "type", "name", "variants" ] } } }, "required": [ "selected_addons", "available_addons" ]}