Skip to main content
API docs by Redocly

Smarthands Support Plans (2.0-beta)

Download OpenAPI specification:Download

URL: https://docs.equinix.com/api-support.htm Terms of Service

The Smart Hands Support plan API allows users to retrieve information of their purchased plan. Information includes but is not limited to plan name, plan type, purchased minutes, consumed minutes, and remaining minutes for Smart Hands. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.

Smart Hands Support Plans

Smart Hands Support Plans

Retrieve Smart Hands support plans

This method retrieves all the available Smart Hands support plans and its remaining minutes to consume for a user with Smart Hands support plans viewing permission.

Authorizations:
BearerAuth
query Parameters
accountNumbers
Array of strings

List of accounts to be filtered

ibxs
Array of strings

List of IBXs to be filtered

offset
integer >= 0
Default: 0

Use offset to control the number of records to be skipped in the response.

limit
integer [ 1 .. 200 ]
Default: 10

Use limit to restrict the number of records in the response.

sorts
Array of strings
Items Enum: "START_DATE" "-START_DATE" "END_DATE" "-END_DATE" "ACCOUNT_NUMBER" "-ACCOUNT_NUMBER" "ID" "-ID" "PLAN_NAME" "-PLAN_NAME"

Sort the users in the response in a particular order. For descending order, prefix the field name with '-'.

planIds
Array of strings [ 1 .. 10 ] items

List of PlanIds to be filtered

Responses

Response Schema: application/json
Array of objects (support plan details response)
Array
id
string

Unique identifier for the specific plan. Note that id can be repeated for rollover plans or plan assignment.

accountNumber
string

Account number of the owner of support plan

planName
string

Name of support plan

productCode
string

Equinix product catalog code

ibxs
Array of strings

List of IBXs where support plans can be used

ibxSpecific
boolean

When true, support plans can only be used on a specific IBX.

planFrequency
string
Enum: "MONTHLY" "ANNUAL" "MONTHLY_ROLLOVER"

Plan frequency

purchasedMinutes
integer

Shows the number of minutes purchased for a specific plan

assignedMinutes
integer

Shows the number of minutes assigned for a specific plan when plan is pro-rated. Plans are pro-rated when they are not purchased on the 1st of the month.

consumedMinutes
integer

Shows the number of minutes consumed for a specific plan

remainingMinutes
integer

Shows the number of minutes remaining for a specific plan

previousConsumedMinutes
integer

Shows the number of minutes consumed in the previous month. This is only applicable for MONTHLY and MONTHLY_ROLLOVER

currentConsumedMinutes
integer

Shows the number of minutes consumed in the current month. This is only applicable for MONTHLY and MONTHLY_ROLLOVER

prepaidConsumedMinutes
integer

Shows the number of minutes consumed for prepaid plans. This is only applicable if plan frequency is of ANNUAL

transitionMinutes
integer

Shows the number of minutes assigned to your end customer. Applicable to resellers only.

startDate
string <date>

Plan start date in YYYY-MM-DD format

endDate
string <date>

Plan end date YYYY-MM-DD format

status
string
Enum: "ACTIVE" "CANCELLED"

Status of support plan. This can be of ACTIVE or CANCELLED

createdDateTime
string <date-time>

Shows the date and time when support plan was created in ISO 8601 format

updatedDateTime
string <date-time>

Shows the date and time when support plan was last updated in ISO 8601 format.

object (assignment)

Customer assignment details. This information's is available for reseller

object (pagination)

Pagination

offset
integer
limit
integer
total
integer
next
string
previous
string

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}