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

vmc

Get Subscription

Description

Get subscription details for a given subscription id

Request

URL

get

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

Copy

Path Parameters

string

org Required

Organization identifier

string

subscription Required

SubscriptionId for an sddc.

Authentication

This operation uses the following authentication methods.

api_key

Response

Response Body

200 OK

Returns 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

OfferType Enum

offer_type Optional

Possible values are: TERM , ON_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: CREATED , ACTIVATED , FAILED , CANCELLED , EXPIRED , PENDING_PROVISIONING , ORDER_SUBMITTED , SUSPENDED , TERMINATED , UKNOWN

Errors

404

Not Found

ErrorResponse

500

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

Code Samples

cURL Command

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

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:

x-vmc-ui-servicename: subscription
x-vmw-vapi-methodname: get

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

vmc

Subscription Operations

post

Create Subscriptions

get

Get Subscription

get

Get Subscriptions

get

List Offer Instances

get

List Products

Get Subscription

Request

URL

Path Parameters

Authentication

api_key

Response

Response Body

200 OK

Errors

Code Samples

cURL Command

Vendor Extensions

On This Page

Subscription Operations

Was this page helpful?