Catalog (Beta)

Cloud SKU catalog — attribute filters, search, and per-SKU detail. Returns the public catalog plus the org's own custom-priced SKUs.

List filterable catalog SKU attributes

get

Returns the fields that can be used in the 'filter' parameter of the catalog SKU list endpoint, along with their types.

Path parameters

org_idstring · uuidRequired

Responses

200

OK

application/json

namestringRequired

fieldstringRequired

typestring · enumRequiredPossible values:

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

405

Method not allowed

application/json

409

Conflict

application/json

500

Internal server error

application/json

default

Default error response

application/json

get

/beta/v1/org/{org_id}/catalog/skus/attributes

HTTPcURLJavaScriptPython

GET /beta/v1/org/{org_id}/catalog/skus/attributes HTTP/1.1
Accept: */*

[
  {
    "name": "text",
    "field": "text",
    "type": "boolean"
  }
]

Get valid values for a filterable catalog SKU attribute

get

Returns the distinct values for a given field, scoped to the same filters that would be applied on the list endpoint. Use this to narrow refinements (e.g. ask for valid instance_type values for a given service+region before issuing a list call).

Path parameters

org_idstring · uuidRequired

fieldstring · min: 1Required

Query parameters

providerstring · enumRequired

Cloud provider (aws, azure, gcp)

Example: awsPossible values:

searchstring · nullableOptional

Text search across SKU name, description, service, and the curated attribute fields (e.g. instance_type, region_code).

Default: null

order_bystring · enumOptional

Field to order results by. Includes the numeric specs (ondemand_usage_price, vcpu, memory) for sorting by price or size.

Default: instance_typePossible values:

descbooleanOptional

Sort descending

Default: false

Responses

200

OK

application/json

or

or

or

or

or

or

or

or

or

or

or

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

405

Method not allowed

application/json

409

Conflict

application/json

422

Unprocessable Content

application/json

500

Internal server error

application/json

default

Default error response

application/json

get

/beta/v1/org/{org_id}/catalog/skus/attributes/{field}

HTTPcURLJavaScriptPython

GET /beta/v1/org/{org_id}/catalog/skus/attributes/{field}?provider=aws HTTP/1.1
Accept: */*

{
  "name": "text",
  "field": "text",
  "type": "boolean",
  "filters": [
    {
      "field": "text",
      "value": "text",
      "op": "="
    }
  ]
}

List catalog SKUs

get

Returns SKUs from the public catalog plus the org's custom-priced SKUs, filtered to USD on-demand prices. To restrict to reservable SKUs, pass is_reservable through the filter arg ({"field": "is_reservable", "op": "=", "value": true}).

Path parameters

org_idstring · uuidRequired

Query parameters

providerstring · enumRequired

Cloud provider (aws, azure, gcp)

Example: awsPossible values:

searchstring · nullableOptional

Text search across SKU name, description, service, and the curated attribute fields (e.g. instance_type, region_code).

Default: null

order_bystring · enumOptional

Field to order results by. Includes the numeric specs (ondemand_usage_price, vcpu, memory) for sorting by price or size.

Default: instance_typePossible values:

descbooleanOptional

Sort descending

Default: false

pageinteger · min: 1OptionalDefault: 1

page_sizeinteger · min: 1 · max: 100OptionalDefault: 20

Responses

200

OK

application/json

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

405

Method not allowed

application/json

409

Conflict

application/json

422

Unprocessable Content

application/json

500

Internal server error

application/json

default

Default error response

application/json

get

/beta/v1/org/{org_id}/catalog/skus

HTTPcURLJavaScriptPython

GET /beta/v1/org/{org_id}/catalog/skus?provider=aws HTTP/1.1
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "provider": "aws",
    "provider_sku_id": "text",
    "name": "text",
    "family": "text",
    "service": "text",
    "provider_service": "text",
    "region_code": "text",
    "full_region_name": "text",
    "instance_type": "text",
    "instance_type_family": "text",
    "usage_type": "text",
    "operation": "text",
    "operating_system": "text",
    "tenancy": "text",
    "database_engine": "text",
    "database_edition": "text",
    "cache_engine": "text",
    "is_multi_az": true,
    "is_current_generation": true,
    "license_model": "text",
    "pre_installed_sw": "text",
    "processor_architecture": "text",
    "vcpu": 1,
    "memory": 1,
    "is_reservable": true,
    "is_public": true,
    "ondemand_usage_unit": "text",
    "ondemand_usage_price": 1,
    "price_currency": "text"
  }
]

Get catalog SKU detail

get

Returns the full SKU record including hardware specs and (when available) the on-demand pricing terms with tiered price dimensions. Direct-id lookup doesn't apply the list endpoint's has_ondemand_terms/price_currency=USD guards, so ondemand_terms may be null and price_currency may be non-USD for SKUs that wouldn't surface in the list. The SKU must be in the public catalog or owned by the requesting org.

Path parameters

org_idstring · uuidRequired

sku_idstring · uuidRequired

Responses

200

OK

application/json

idstring · uuidOptional

Catalog SKU id

providerstring · enumOptional

Cloud provider (aws, azure, gcp)

Possible values:

provider_sku_idstringOptional

Provider's own SKU identifier

namestring · nullableOptional

familystring · nullableOptional

Product family (e.g. 'Compute Instance')

servicestring · nullableOptional

Full service name (e.g. 'Amazon Elastic Compute Cloud - Compute')

provider_servicestring · nullableOptional

Provider service code (e.g. 'AmazonEC2')

region_codestring · nullableOptional

Region code (e.g. 'us-east-1')

full_region_namestring · nullableOptional

Full region name (e.g. 'US East (N. Virginia)')

instance_typestring · nullableOptional

instance_type_familystring · nullableOptional

usage_typestring · nullableOptional

Provider billing usage type (e.g. 'BoxUsage:m5.large'). The canonical join key against AWS Cost Explorer / billing line items — useful for crossing between catalog and cost data.

operationstring · nullableOptional

Provider billing operation code (e.g. 'RunInstances:0002'). Lets the agent spot at-a-glance whether a SKU is the plain default operation or a more specific variant within a usage_type.

operating_systemstring · nullableOptional

tenancystring · nullableOptional

database_enginestring · nullableOptional

database_editionstring · nullableOptional

cache_enginestring · nullableOptional

is_multi_azboolean · nullableOptional

is_current_generationboolean · nullableOptional

license_modelstring · nullableOptional

pre_installed_swstring · nullableOptional

processor_architecturestring · nullableOptional

CPU architecture (e.g. 'x86_64', 'arm64')

vcpunumber · nullableOptional

memorynumber · nullableOptional

Memory in bytes (not GB). Divide by 2**30 for GiB / 1e9 for GB if presenting to the user.

is_reservablebooleanOptional

Whether this SKU has at least one reserved-term offering

is_publicbooleanOptional

True for public-catalog SKUs (the standard provider catalog). False when this row is the requesting org's own custom-priced SKU (tied to a specific integration; drill into catalog_sku_details for the integration_id).

ondemand_usage_unitstring · nullableOptional

ondemand_usage_pricenumber · nullableOptional

On-demand unit price in price_currency

price_currencystring · nullableOptional

descriptionstring · nullableOptional

location_typestring · nullableOptional

availability_zonestring · nullableOptional

physical_processorstring · nullableOptional

clock_speedstring · nullableOptional

processor_featuresstring · nullableOptional

network_performancestring · nullableOptional

storagestring · nullableOptional

dedicated_ebs_throughputstring · nullableOptional

iostring · nullableOptional

tax_typestring · nullableOptional

has_ondemand_termsbooleanOptional

normalization_size_factornumber · nullableOptional

AWS instance-size flexibility unit. Used internally to size convertible RIs across the family; not generally user-facing.

is_byolbooleanOptional

Whether this SKU is a Bring-Your-Own-License variant. Derived from license_model.

integration_idstring · uuid · nullableOptional

Integration this SKU's custom pricing is tied to. Null for public-catalog SKUs (the default scope of the list endpoint). Set when the SKU id resolves to a custom-priced SKU on the requesting org — direct-id detail lookups support both public and the org's own custom-priced SKUs.

end_datestring · date-time · nullableOptional

Date after which this SKU is no longer available.

publication_datestring · date-time · nullableOptional

When this SKU version was published by the provider.

updated_atstring · date · nullableOptional

When this SKU was last refreshed in our catalog.

ondemand_termsany ofOptional

object · nullableOptional

or

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

405

Method not allowed

application/json

409

Conflict

application/json

500

Internal server error

application/json

default

Default error response

application/json

get

/beta/v1/org/{org_id}/catalog/skus/{sku_id}

HTTPcURLJavaScriptPython

GET /beta/v1/org/{org_id}/catalog/skus/{sku_id} HTTP/1.1
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "provider": "aws",
  "provider_sku_id": "text",
  "name": "text",
  "family": "text",
  "service": "text",
  "provider_service": "text",
  "region_code": "text",
  "full_region_name": "text",
  "instance_type": "text",
  "instance_type_family": "text",
  "usage_type": "text",
  "operation": "text",
  "operating_system": "text",
  "tenancy": "text",
  "database_engine": "text",
  "database_edition": "text",
  "cache_engine": "text",
  "is_multi_az": true,
  "is_current_generation": true,
  "license_model": "text",
  "pre_installed_sw": "text",
  "processor_architecture": "text",
  "vcpu": 1,
  "memory": 1,
  "is_reservable": true,
  "is_public": true,
  "ondemand_usage_unit": "text",
  "ondemand_usage_price": 1,
  "price_currency": "text",
  "description": "text",
  "location_type": "text",
  "availability_zone": "text",
  "physical_processor": "text",
  "clock_speed": "text",
  "processor_features": "text",
  "network_performance": "text",
  "storage": "text",
  "dedicated_ebs_throughput": "text",
  "io": "text",
  "tax_type": "text",
  "has_ondemand_terms": true,
  "normalization_size_factor": 1,
  "is_byol": true,
  "integration_id": "123e4567-e89b-12d3-a456-426614174000",
  "end_date": "2026-05-17T01:06:03.585Z",
  "publication_date": "2026-05-17T01:06:03.585Z",
  "updated_at": "2026-05-17",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "ondemand_terms": {}
}

Compare commitment offers for a hypothetical CatalogSKU + quantity

get

Returns every (offer, lease) candidate available for the SKU, sized to the requested quantity, with monthly-rate financials, discount rate, breakeven days, and upfront cost. Hypothetical and not tied to existing commitments — for swapping a line item's offer, use /commitment-plans/{plan_id}/comparison. Returns 400 when the SKU is not reservable (is_reservable=false) or has no on-demand price (ondemand_usage_price null/zero) — savings can't be quoted against a missing baseline.

Path parameters

org_idstring · uuidRequired

sku_idstring · uuidRequired

Query parameters

quantityinteger · min: 1Optional

Number of SKU units to hypothetically commit to (≥1). Defaults to 1 — discount rates and breakeven days are quantity-invariant, so default=1 answers pricing-comparison questions cleanly. Pass an explicit quantity when the user wants absolute dollar figures (monthly savings, upfront cost) sized to a real purchase. For compute this is instance count; for non-compute SKUs the unit is the SKU's ondemand_usage_unit.

Default: 1

only_most_flexible_commitment_typebooleanOptional

When true (default), candidates[] and targets[] are restricted to the most flexible commitment type available for the SKU's service. For EC2 SKUs that means Compute Savings Plans only — EC2 Reserved Instances and EC2 Instance Savings Plans are excluded because they bind to a single instance family + region, while Compute SPs cover any EC2 / Fargate / Lambda usage. Same default-deemphasize spirit as payment_options=['no_upfront']. Pass false when the user explicitly asks about EC2 RIs, instance-family commitments, standard vs convertible, or 'all options.' For non-EC2 SKUs this is a no-op today (only one commitment-type family appears in candidates per service).

Default: true

Responses

200

OK

application/json

sku_idstring · uuidRequired

The CatalogSKU id compared.

quantityintegerRequired

Quantity hypothetically committed.

400

Bad Request

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

405

Method not allowed

application/json

409

Conflict

application/json

422

Unprocessable Content

application/json

500

Internal server error

application/json

default

Default error response

application/json

get

/beta/v1/org/{org_id}/catalog/skus/{sku_id}/offer-comparison

HTTPcURLJavaScriptPython

GET /beta/v1/org/{org_id}/catalog/skus/{sku_id}/offer-comparison HTTP/1.1
Accept: */*

{
  "sku_id": "123e4567-e89b-12d3-a456-426614174000",
  "quantity": 1,
  "ondemand_baseline": {
    "monthly_cost": 1,
    "ondemand_usage_unit": "text",
    "ondemand_usage_price": 1
  },
  "candidates": [
    {
      "offer_id": "123e4567-e89b-12d3-a456-426614174000",
      "offer": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "provider": "aws",
        "type": "text",
        "region": "text",
        "duration_seconds": 1,
        "instance_type": "text",
        "instance_family": "text",
        "offering_class": "standard",
        "payment_option": "no_upfront",
        "plan_type": "text",
        "product_description": "text",
        "display_name": "text",
        "is_flexible": true
      },
      "lease_menu_item_id": "123e4567-e89b-12d3-a456-426614174000",
      "selected_amount": 1,
      "contract_term": "one_year_gris",
      "payment_option": "no_upfront",
      "discount_rate": 1,
      "breakeven_days": 1,
      "commitment_upfront_cost": 1,
      "commitment_financials_monthly_rate": {
        "commitment_cost": {
          "total": 1,
          "breakdown": {
            "cloud_provider_cost": {
              "total": 1,
              "breakdown": {
                "recurring": 1,
                "amortized_upfront": 1
              }
            },
            "archera_premium": 1
          }
        },
        "commitment_savings": {
          "net": 1,
          "gross": 1
        },
        "covered_ondemand_cost": 1
      }
    }
  ],
  "targets": [
    {
      "contract_term": "one_year_gris",
      "payment_option": "no_upfront",
      "actual_term": "one_year_gris",
      "actual_payment_option": "no_upfront",
      "actual_term_reason": "exact_match",
      "candidate": {
        "offer_id": "123e4567-e89b-12d3-a456-426614174000",
        "offer": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "provider": "aws",
          "type": "text",
          "region": "text",
          "duration_seconds": 1,
          "instance_type": "text",
          "instance_family": "text",
          "offering_class": "standard",
          "payment_option": "no_upfront",
          "plan_type": "text",
          "product_description": "text",
          "display_name": "text",
          "is_flexible": true
        },
        "lease_menu_item_id": "123e4567-e89b-12d3-a456-426614174000",
        "selected_amount": 1,
        "contract_term": "one_year_gris",
        "payment_option": "no_upfront",
        "discount_rate": 1,
        "breakeven_days": 1,
        "commitment_upfront_cost": 1,
        "commitment_financials_monthly_rate": {
          "commitment_cost": {
            "total": 1,
            "breakdown": {
              "cloud_provider_cost": {
                "total": 1,
                "breakdown": {
                  "recurring": 1,
                  "amortized_upfront": 1
                }
              },
              "archera_premium": 1
            }
          },
          "commitment_savings": {
            "net": 1,
            "gross": 1
          },
          "covered_ondemand_cost": 1
        }
      },
      "commitment_financials_monthly_rate": {
        "commitment_cost": {
          "total": 1,
          "breakdown": {
            "cloud_provider_cost": {
              "total": 1,
              "breakdown": {
                "recurring": 1,
                "amortized_upfront": 1
              }
            },
            "archera_premium": 1
          }
        },
        "commitment_savings": {
          "net": 1,
          "gross": 1
        },
        "covered_ondemand_cost": 1
      },
      "commitment_upfront_cost": 1,
      "delta_vs_ondemand": {
        "monthly_net_savings": 1,
        "monthly_commitment_cost": 1,
        "upfront_cost": 1
      }
    }
  ]
}