[{"label":"Latest (v1.1)","version":"latest"}]
vmc
Create Subscriptions
DescriptionInitiates the creation of a subscription
Request
URLURL
https://vmc.vmware.com/vmc/api/orgs/{org}/subscriptions
Path Parameters
Path Parameters
string
org
Required
Organization identifier
Request Body
Request Body
{
"commitment_term": "12",
"offer_name": "VMware Cloud on AWS",
"offer_version": "1.0",
"product_type": "host - deprecated",
"quantity": 1,
"region": "US_WEST_2"
}
string
product_type
Required
Old identifier for product. Deprecarted. See product and type
string
commitment_term
Required
string
region
Required
string
offer_name
Required
string
offer_version
Required
integer
quantity
Required
string
billing_frequency
Optional
Frequency of the billing.
string
product_charge_id
Optional
string
product_id
Optional
string
product
Optional
The product for which subscription needs to be created. Refer /vmc/api/orgs/{orgId}/products.
integer
price
Optional
string
offer_context_id
Optional
string
type
Optional
The type of the product for which the subscription needs to be created.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
202 Accepted
Returns
Task
of type(s) application/json
This response body class contains all of the following:
AbstractEntity, InlineTask1
Errors
401
Unauthorized
403
Forbidden
ErrorResponse
500
Server error. Check retryable flag to see if request should be retried.
Code Samples
PowerCLI Client SDK Example
$SubscriptionRequest = Initialize-SubscriptionRequest -Product "MyProduct" -ProductType "MyProductType" -ProductId "MyProductId" -BillingFrequency "MyBillingFrequency" -Region "MyRegion" -CommitmentTerm "MyCommitmentTerm" -OfferContextId "MyOfferContextId" -OfferVersion "MyOfferVersion" -OfferName "MyOfferName" -Quantity 0 -Type "MyType" -Price 0 -ProductChargeId "MyProductChargeId"
Invoke-OrgsOrgSubscriptionsPost -Org "MyOrg" -SubscriptionRequest $SubscriptionRequest
cURL Command
curl -X POST -H "Content-Type: application/json" -d '{"billing_frequency":"MONTHLY","commitment_term":"12","offer_name":"VMware Cloud on AWS","offer_version":"1.0","product":"host","product_type":"host - deprecated","quantity":1,"region":"US_WEST_2","type":"i3.metal"}' https://vmc.vmware.com/vmc/api/orgs/{org}/subscriptions
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmc-ui-servicename: subscriptions
x-vmw-vapi-methodname: create
[{"label":"Latest (v1.1)","version":"latest"}]
vmc
On This Page
Subscription Operations
post
get
get
