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

Get Subscriptions

Description

Returns default billing account subscriptions for a given org id

Request

Request

URL

URL


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

Path Parameters

Path 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

Possible values are: TERMON_DEMAND


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns array of SubscriptionDetails of type(s) application/json
{
	"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": "TERM",
	"offer_version": "string",
	"product_id": "string",
	"product_name": "string",
	"quantity": "string",
	"region": "string",
	"start_date": "string",
	"status": "CREATED"
}
string
anniversary_billing_date Optional

string
auto_renewed_allowed Optional

string
billing_frequency Optional

The frequency at which the customer is billed. Currently supported values are “Upfront” and “Monthly”


string
billing_subscription_id Optional

string
commitment_term Optional

string
commitment_term_uom Optional

unit of measurment for commitment term


string
csp_subscription_id Optional

string
description Optional

string
end_date Optional

string
offer_name Optional

offer_type Optional

Possible values are: TERMON_DEMAND


string
offer_version Optional

string
product_id Optional

string
product_name Optional

string
quantity Optional

string
region Optional

string
start_date Optional

string
status Optional

Possible values are: CREATEDACTIVATEDFAILEDCANCELLEDEXPIREDPENDING_PROVISIONINGORDER_SUBMITTEDSUSPENDEDTERMINATEDUKNOWN

Errors

Errors

401

Unauthorized


404

Not Found


500

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

Code Samples

Code Samples

cURL Command

curl https://vmc.vmware.com/vmc/api/orgs/{org}/subscriptions
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-vmc-ui-servicename: subscriptions
x-vmw-vapi-methodname: get


Feedback

Was this page helpful?