Equinix Fabric API v4 | Equinix Product Documentation

Marketplace Subscriptions

Operations

Get Subscription

Request

The API provides capability to get subscription

Security

BearerAuth

Path

subscriptionIdstring, (uuid)required

Subscription UUID

Example:557400f8-d360-11e9-bb65-2a2ae2dbcce4

Payload

// No request payload

Responses

Successful operation

Bodyapplication/json

hrefstring, (uri)

Subscription URL

uuidstring, (uuid)

Unique identifier of the Subscription

statestring(SubscriptionState)required

Subscription State

Enum:"ACTIVE""EXPIRED""CANCELLED""GRACE_PERIOD"

marketplacestringrequired

Marketplace Type

Enum:"AWS""GCP""AZURE""REDHAT"

offerTypestring

Marketplace Offer Type

Enum:"PUBLIC""PRIVATE_OFFER"

isAutoRenewboolean

Is Auto Renewal Enabled

Example:true

offerIdstring

Marketplace Offer Id

trialobject(SubscriptionTrial)

Free Trial Subscription

metroCodesArray of strings

List of available metro

entitlementsArray of objects(SubscriptionEntitlementResponse)required

List of entitlements associated with the subscription

changelogobject(Changelog)

Change log

Response

{
  "href": "https://api.equinix.com/fabric/v4/marketplaceSubscriptions/c5557b51-7938-4f7d-afaa-41b930903a5e",
  "uuid": "c5557b51-7938-4f7d-afaa-41b930903a5e",
  "state": "ACTIVE",
  "marketplace": "AWS",
  "offerType": "PRIVATE_OFFER",
  "isAutoRenew": false,
  "offerId": "offer-wqquayy2jy25o",
  "trial": {
    "enabled": true
  },
  "metroCodes": [
    "SV",
    "DC"
  ],
  "entitlements": [
    { … },
    { … },
    { … }
  ],
  "changelog": {
    "createdBy": "adminuser",
    "createdDateTime": "2020-05-21T10:30:00Z",
    "updatedBy": "adminuser",
    "updatedDateTime": "2020-05-21T10:30:00Z"
  }
}