Developer Documentation
List Subscriptions
Returns all subscriptions for a given org id
Request
URLURL
https://vmc.vmware.com/vmc/api/orgs/{org}/subscriptions
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Organization identifier |
Query Parameters
Query Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| optional |
|
string | 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"
}| Property Name | Type | Description |
|---|---|---|
| anniversary_billing_date | string | Not available |
| auto_renewed_allowed | string | Not available |
| billing_frequency | string |
The frequency at which the customer is billed. Currently supported values are “Upfront” and “Monthly” |
| billing_subscription_id | string | Not available |
| commitment_term | string | Not available |
| commitment_term_uom | string |
unit of measurment for commitment term |
| csp_subscription_id | string | Not available |
| description | string | Not available |
| end_date | string | Not available |
| offer_name | string | Not available |
| offer_type | OfferType |
Not available
Possible values are: |
| offer_version | string | Not available |
| product_id | string | Not available |
| product_name | string | Not available |
| quantity | string | Not available |
| region | string | Not available |
| start_date | string | Not available |
| status | string |
Not available
Possible values are: ACTIVATED, CANCELLED, CREATED, EXPIRED, FAILED, ORDER_SUBMITTED, PENDING_PROVISIONING, SUSPENDED, TERMINATED, UKNOWN |
Errors
| Code | Returns | Description |
|---|---|---|
| 401 | Nothing | Unauthorized |
| 404 | Nothing | Not Found |
| 500 | ErrorResponse | The server encountered an unexpected condition which prevented it from fulfilling the request. |
