Subscriptions API
Subscription management API is used for viewing and managing IoT subscriptions, eUICCs, profiles, and connectivity subscriptions.
GET endpoints in this API are designed with a high degree of flexibility. This section will explain how to make use of this.
A GET request with no query parameters set will return information associated with the requested resource. This information is found in the attributes property in the response body. All properties marked as required will be returned.
Some GET requests support the query parameter extendWith. If set, the response body may contain additional data in the attributes property. If the query parameter is not provided then only the properties marked as required are returned in attributes. Even if you provide values in extendWith you may not get the property you are asking for. Check the schema definitions of properties provided by extendWith to determine when it is provided. Using the extendWith query parameter may result in significantly longer response times, so only include this query parameter if you need it.
Each GET response body contains a property named relationships which contains URL paths to all related resources. These paths can be used to perform HTTP GET requests in order to fetch the data belonging to the related resource.
Each GET request supports the query parameter include with different values being allowed on different endpoints. Setting the include query parameter will result in the attributes property being added to the corresponding relationship. This is great if you know that you need information which is spread out across many different resources. Instead of making multiple API requests you can use the include query parameter to get a lot of data at once in the relationships property. Note that using this query parameter may lead to longer response times so only include what you actually need.
Authentication
- Token Authorizer
| Security Scheme Type: | http |
|---|---|
| HTTP Authorization Scheme: | bearer |
| Bearer format: | JWT |