List Subscriptions
Returns all subscriptions for a given org id
Request
URLURL
https://vmc.vmware.com/vmc/api/orgs/{org}/subscriptions
Parameters
Parameters
string
org
Required
Organization identifier
Query Parameters
Query Parameters
string
offer_type
Optional
Offer Type
* `ON_DEMAND` - on-demand subscription
* `TERM` - term subscription
* All subscriptions if not specified
Response
Response
Response BodyResponse Body
200 OK returns
array of
SubscriptionDetails
{
"anniversary_billing_date": "string",
"auto_renewed_allowed": "string",
"billing_frequency": "string",
"billing_subscription_id": "string",
"commitment_term": "string",
"commitment_term_uom": "string",
"csp_subscription_id": "string",
"description": "string",
"end_date": "string",
"offer_name": "string",
"offer_type": "enum",
"offer_version": "string",
"product_id": "string",
"product_name": "string",
"quantity": "string",
"region": "string",
"start_date": "string",
"status": "string"
}
string
anniversary_billing_date
Optional
Not available
string
auto_renewed_allowed
Optional
Not available
string
billing_frequency
Optional
The frequency at which the customer is billed. Currently supported values are “Upfront” and “Monthly”
string
billing_subscription_id
Optional
Not available
string
commitment_term
Optional
Not available
string
commitment_term_uom
Optional
unit of measurment for commitment term
string
csp_subscription_id
Optional
Not available
string
description
Optional
Not available
string
end_date
Optional
Not available
string
offer_name
Optional
Not available
string
offer_version
Optional
Not available
string
product_id
Optional
Not available
string
product_name
Optional
Not available
string
quantity
Optional
Not available
string
region
Optional
Not available
string
start_date
Optional
Not available
string
status
Optional
Not available
Possible values are: CREATED, ACTIVATED, FAILED, CANCELLED, EXPIRED, PENDING_PROVISIONING, ORDER_SUBMITTED, SUSPENDED, TERMINATED, UKNOWN
cURL Command
curl https://vmc.vmware.com/vmc/api/orgs/{org}/subscriptions
Errors
Not available
401
The request requires user authentication.
Not available
404
The requested resource could not be found but may be available again in the future.
500
The server encountered an unexpected condition which prevented it from fulfilling the request.
