Interface SupportPlan

All Known Implementing Classes:
SupportPlanJson
public interface SupportPlan
A Smart Hands support plan retrieved from the Equinix Customer Portal Support Plans v2 API (GET /colocations/v2/supportPlans).

  • Method Details

    • getId

      String getId()
      Returns the unique identifier of the plan. May repeat across entries for rollover plans or plan assignment.
      Returns:
      the plan id

    • getAccountNumber

      String getAccountNumber()
      Returns the account number that owns the support plan.
      Returns:
      the account number

    • getPlanName

      String getPlanName()
      Returns the name of the support plan.
      Returns:
      the plan name

    • getProductCode

      String getProductCode()
      Returns the Equinix product catalog code for the plan.
      Returns:
      the product code

    • getIbxs

      List<String> getIbxs()
      Returns the IBXs where the support plan can be used.
      Returns:
      the list of IBX codes, or null if not provided

    • getIbxSpecific

      Boolean getIbxSpecific()
      Indicates whether the plan can only be used on a specific IBX.
      Returns:
      true when IBX-specific

    • getPlanFrequency

      PlanFrequency getPlanFrequency()
      Returns the billing frequency of the plan.
      Returns:
      the plan frequency

    • getPurchasedMinutes

      Integer getPurchasedMinutes()
      Returns the number of minutes purchased for the plan.
      Returns:
      the purchased minutes, or null if not provided

    • getAssignedMinutes

      Integer getAssignedMinutes()
      Returns the number of minutes assigned for a pro-rated plan.
      Returns:
      the assigned minutes, or null if not provided

    • getConsumedMinutes

      Integer getConsumedMinutes()
      Returns the number of minutes consumed for the plan.
      Returns:
      the consumed minutes, or null if not provided

    • getRemainingMinutes

      Integer getRemainingMinutes()
      Returns the number of minutes remaining for the plan.
      Returns:
      the remaining minutes, or null if not provided

    • getPreviousConsumedMinutes

      Integer getPreviousConsumedMinutes()
      Returns the number of minutes consumed in the previous month (MONTHLY/MONTHLY_ROLLOVER only).
      Returns:
      the previous consumed minutes, or null if not provided

    • getCurrentConsumedMinutes

      Integer getCurrentConsumedMinutes()
      Returns the number of minutes consumed in the current month (MONTHLY/MONTHLY_ROLLOVER only).
      Returns:
      the current consumed minutes, or null if not provided

    • getPrepaidConsumedMinutes

      Integer getPrepaidConsumedMinutes()
      Returns the number of minutes consumed for prepaid (ANNUAL) plans.
      Returns:
      the prepaid consumed minutes, or null if not provided

    • getTransitionMinutes

      Integer getTransitionMinutes()
      Returns the number of minutes assigned to an end customer (resellers only).
      Returns:
      the transition minutes, or null if not provided

    • getStartDate

      String getStartDate()
      Returns the plan start date in YYYY-MM-DD format.
      Returns:
      the start date

    • getEndDate

      String getEndDate()
      Returns the plan end date in YYYY-MM-DD format.
      Returns:
      the end date

    • getStatus

      SupportPlanStatus getStatus()
      Returns the status of the support plan.
      Returns:
      the plan status

    • getCreatedDateTime

      String getCreatedDateTime()
      Returns the date and time the support plan was created, in ISO 8601 format.
      Returns:
      the created date-time

    • getUpdatedDateTime

      String getUpdatedDateTime()
      Returns the date and time the support plan was last updated, in ISO 8601 format.
      Returns:
      the updated date-time

    • getAssignment

      SupportPlanAssignment getAssignment()
      Returns the customer assignment details (resellers only).
      Returns:
      the assignment, or null if not assigned