Skip to content

List plans

Request

This endpoint retrieves a list of available plans. It allows users to specify pagination and filter out archived plans.

Security
ApiKeyAuth
Query
archivedboolean

When true, only archived plans are returned. When false, only non archived plans are returned. When absent all are returned.

page_sizestring, [ 1 .. 25 ]

Number of items to be returned in a single page

Default:10
pagestring

A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call.

labelstring(Label)

Filter plans by label. Allowed values are Green, Aqua, Blue, Voilet, Red, Grey, Orange

Enum:"Green""Aqua""Blue""Voilet""Red""Grey""Orange"
search_querystring

Query to search the plans by name

country_iso_2string

Comma separated list of countryIso2 e.g. countryIso2=FR,IN

GET
/v3/plans
curl -i -X GET \
  'https://api.tellisim.com/v3/plans?archived=true&page_size=10&page=string&label=Green&search_query=string&country_iso_2=string&key=YOUR_API_KEY_HERE'

Responses

Successful response containing a list of plans. The optional fields are returned for labels on which throttling or recurring is enabled.

Bodyapplication/json
errorbooleanrequired

Indicates if there was an error in the request

Example:false
dataArray of objects(Plan)required

An array of plan objects returned by the request

next_pagestring or nullrequired

Token for the next page of results, if available

Example:null
Response
{
  "error": false,
  "data": [
    { … }
  ],
  "next_page": null
}