[{"label":"Latest (v1.1)","version":"latest"}]
vmc

List Offer Instances

Description

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

Request

Request

URL

URL


get
https://vmc.vmware.com/vmc/api/orgs/{org}/subscriptions/offer-instances
Copy

Path Parameters

Path Parameters

string
org Required

Organization identifier


Query Parameters

Query Parameters

string
product Optional

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


string
product_type Required

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


string
region Required

Region for the offer


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

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

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

Holder for the term offer instances.


on_demand Required

Holder for the on-demand offer instance.

Errors

Errors

ErrorResponse
400

Bad Request. Type of the product not supported.


401

Unauthorized


403

Forbidden

Code Samples

Code Samples

PowerCLI Client SDK Example

Invoke-OrgsOrgSubscriptionsOfferInstancesGet -Org "MyOrg" -Region "MyRegion" -ProductType "MyProductType" -Product "MyProduct" -Type "MyType"

cURL Command

curl https://vmc.vmware.com/vmc/api/orgs/{org}/subscriptions/offer-instances?product_type=string&region=string
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-vmc-ui-servicename: offer-instances
x-vmw-vapi-methodname: list


Feedback

Was this page helpful?