List Offer Instances

List Offer Instances

List all offers available for the specific product type in the specific region

Request
URI
GET
https://vmc.vmware.com/vmc/api/orgs/{org}/subscriptions/offer-instances
COPY
Path Parameters
string
org
Required

Organization identifier

Query Parameters
string
region
Required

Region for the offer

string
product_type
Required

Type of the product in offers. This has been deprecated. Please use product & type parameters

string
product
Optional

The product that you are trying to purchase, eg. host. This needs to be accompanied by the type parameter

string
type
Optional

The type/flavor of the product you are trying it purchase,eg. an r5.metal host. This needs to be accompanied by the product parameter.


Authentication
This operation uses the following authentication methods.
Responses
200

Success

Returns OfferInstancesHolder of type(s) application/json
{
    "on_demand": {
        "product": "HOST",
        "product_type": null,
        "name": "VMware Cloud on AWS",
        "currency": "USD",
        "region": "US_WEST_2",
        "unit_price": "8.3681",
        "monthly_cost": "6108.7130",
        "version": "1.0",
        "type": "i3.metal",
        "description": "VMware Cloud on AWS On-Demand"
    },
    "offers": [
        {
            "description": "VMware Cloud on Amazon Web Services",
            "product": "HOST",
            "product_type": null,
            "name": "VMware Cloud on AWS",
            "region": "US_WEST_2",
            "commitment_term": 12,
            "unit_price": "51987.0",
            "currency": "USD",
            "version": "1.0",
            "offer_context_id": null,
            "product_charge_id": null,
            "type": "i3.metal",
            "product_id": "VMC-AWS"
        },
        {
            "description": "VMware Cloud on Amazon Web Services",
            "product": "HOST",
            "product_type": null,
            "name": "VMware Cloud on AWS",
            "region": "US_WEST_2",
            "commitment_term": 36,
            "unit_price": "109366.0",
            "currency": "USD",
            "version": "1.0",
            "offer_context_id": null,
            "product_charge_id": null,
            "type": "i3.metal",
            "product_id": "VMC-AWS"
        }
    ]
}
on_demand
Required

on_demand

offers
Required

offers


400

Bad Request. Type of the product not supported.

Returns ErrorResponse of type(s) application/json
{
    "status": 0,
    "path": "string",
    "retryable": false,
    "error_code": "string",
    "error_messages": [
        "string"
    ]
}
integer
status
Required

HTTP status code

string
path
Required

Originating request URI

boolean
retryable
Required

If true, client should retry operation

string
error_code
Required

unique error code

array of string
error_messages
Required

localized error messages


401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure