Network Edge APIs | Equinix Product Documentation

Get Agreement Status

Call this API to find out the status of your agreement, whether it is valid or not, or to just read the agreement terms.

Security

BearerAuth

accountNumberstring

Unique identifier of the customer account.

Example:accountNumber=123456

Payload

// No request payload

Successfully retrieved Status

Bodyapplication/json

errorMessagestring

Error message if agreement is invalid

Example:"null"

isValidbooleanrequired

Whether the agreement is valid

Example:true

termsstring

Agreement terms

Example:"null"

termsVersionIDstring

Agreement terms version ID

Example:"null"

Response

{
  "errorMessage": "null",
  "isValid": true,
  "terms": "null",
  "termsVersionID": "null"
}