Create Subscriptions

Create Subscriptions

Initiates the creation of a subscription

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

Organization identifier.


Request Body

subscriptionRequest

SubscriptionRequest of type(s) application/json
Required

Show optional properties

{
    "product_type": "host - deprecated",
    "region": "US_WEST_2",
    "commitment_term": "12",
    "offer_name": "VMware Cloud on AWS",
    "offer_version": "1.0",
    "quantity": 1
}
{
    "product": "string",
    "product_type": "string",
    "product_id": "string",
    "billing_frequency": "string",
    "region": "string",
    "commitment_term": "string",
    "offer_context_id": "string",
    "offer_version": "string",
    "offer_name": "string",
    "quantity": 0,
    "type": "string",
    "price": 0,
    "product_charge_id": "string"
}
string
product
Optional

The product for which subscription needs to be created. Refer /vmc/api/orgs/{orgId}/products.

string
product_type
Required

Old identifier for product. Deprecarted. See product and type

string
product_id
Optional

product_id

string
billing_frequency
Optional

Frequency of the billing.

string
region
Required

region

string
commitment_term
Required

commitment_term

string
offer_context_id
Optional

offer_context_id

string
offer_version
Required

offer_version

string
offer_name
Required

offer_name

integer
quantity
Required

quantity

string
type
Optional

The type of the product for which the subscription needs to be created.

integer
price
Optional

price

string
product_charge_id
Optional

product_charge_id

Authentication
This operation uses the following authentication methods.
Responses
202

Accepted

Returns Task of type(s) application/json
This response body class contains all of the following: AbstractEntity
{
    "updated": "string",
    "user_id": "string",
    "updated_by_user_id": "string",
    "created": "string",
    "version": 5,
    "updated_by_user_name": "string",
    "user_name": "string",
    "id": "1d1c83ee-e0b7-4de9-b660-9a9ca1d22f32",
    "status": "string",
    "localized_error_message": "string",
    "resource_id": "string",
    "parent_task_id": "string",
    "task_version": "string",
    "correlation_id": "string",
    "start_resource_entity_version": 0,
    "sub_status": "string",
    "task_type": "string",
    "start_time": "string",
    "task_progress_phases": [
        {
            "id": "string",
            "name": "string",
            "progress_percent": 0
        }
    ],
    "error_message": "string",
    "org_id": "1d1c83ee-e0b7-4de9-b660-9a9ca1d22f32",
    "end_resource_entity_version": 5,
    "service_errors": [
        {
            "default_message": "string",
            "original_service": "string",
            "localized_message": "string",
            "original_service_error_code": "string"
        }
    ],
    "org_type": "string",
    "estimated_remaining_minutes": 4,
    "params": {},
    "progress_percent": 75,
    "phase_in_progress": "string",
    "resource_type": "string",
    "end_time": "string"
}

401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

500

Server error. Check retryable flag to see if request should be retried.

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