Get Subscription

Get Subscription

Get subscription details for a given subscription id

Request
URI
GET
https://{api_host}/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.
Responses
200

Success

Returns SubscriptionDetails of type(s) application/json 
{
    "status": "string",
    "anniversary_billing_date": "string",
    "end_date": "string",
    "billing_frequency": "string",
    "auto_renewed_allowed": "string",
    "commitment_term": "string",
    "csp_subscription_id": "string",
    "billing_subscription_id": "string",
    "offer_version": "string",
    "offer_type": "string",
    "description": "string",
    "product_id": "string",
    "region": "string",
    "product_name": "string",
    "offer_name": "string",
    "commitment_term_uom": "string",
    "start_date": "string",
    "quantity": "string"
}
string
status
Optional

status

Possible values are : CREATED, ACTIVATED, FAILED, CANCELLED, EXPIRED, PENDING_PROVISIONING, ORDER_SUBMITTED, SUSPENDED, TERMINATED, UKNOWN,
string
anniversary_billing_date
Optional

anniversary_billing_date

string
end_date
Optional

end_date

string
billing_frequency
Optional

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

string
auto_renewed_allowed
Optional

auto_renewed_allowed

string
commitment_term
Optional

commitment_term

string
csp_subscription_id
Optional

csp_subscription_id

string
billing_subscription_id
Optional

billing_subscription_id

string
offer_version
Optional

offer_version

string
offer_type
Optional

offer_type

Possible values are : TERM, ON_DEMAND,
string
description
Optional

description

string
product_id
Optional

product_id

string
region
Optional

region

string
product_name
Optional

product_name

string
offer_name
Optional

offer_name

string
commitment_term_uom
Optional

unit of measurment for commitment term

string
start_date
Optional

start_date

string
quantity
Optional

quantity


404

Not Found

Operation doesn't return any data structure

500

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

Returns ErrorResponse of type(s) application/json 
"ErrorResponse Object"
integer
status
Required

HTTP status code

string
path
Required

Originating request URI

boolean
retryable
Required

If true, client should retry operation

string
error_code
Required

unique error code

array of string
error_messages
Required

localized error messages


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/vmc/api/orgs/{org}/subscriptions/{subscription}
On This Page
Subscription Operations
GET
List Offer Instances
GET
Get Subscription
GET
List Products
POST
Create Subscriptions
GET
Get Subscriptions