Back to top

Plans

Plan Management (Device)

Retrieve all plans
GET
/plans

Provides a listing of available services plans available to provision your device on.

  • Parameters
  • include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide
  • Response  200   ok
  • {
    	"plans": [
    		{
    			"id": "string",
    			"slug": "string",
    			"name": "string",
    			"description": "string",
    			"line": "string",
    			"specs": "object",
    			"pricing": "object",
    			"available_in": [
    				{
    					"href": "string"
    				}
    			]
    		}
    	]
    }
  • Response  401   unauthorized
Retrieve all plans visible by the project
GET
/projects/{id}/plans

Returns a listing of available services plans available for the given project

  • Parameters
  • id
    string  (required) in path

    Project UUID

    include
    string in query

    related attributes to include

    page
    integer in query

    page to display, default to 1, max 100_000

    per_page
    integer in query

    items per page, default to 10, max 1_000

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide
  • Response  200   ok
  • {
    	"plans": [
    		{
    			"id": "string",
    			"slug": "string",
    			"name": "string",
    			"description": "string",
    			"line": "string",
    			"specs": "object",
    			"pricing": "object",
    			"available_in": [
    				{
    					"href": "string"
    				}
    			]
    		}
    	]
    }
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found