• Register



Get a specific plan endpoint or a list of plan endpoints  Please see Fetching Objects for an overview of how the fetch method works.

NOTE:This method is available when API Packager is turned on for a customer. Please contact Support or your Account Manager if you have any questions about API Packager.


plan_endpoint id

An integer representing the unique id of the plan_endpoint to fetch.  You may also pass a json object with a field of id to identify the plan_endpoint you wish to fetch.


An plan_endpoint object, as described by the object.describe call. NULL is returned if the plan_endpoint could not be found.


A Sample JSON-RPC plan_endpoint.fetch Request


The JSON-RPC Response

"result": true,
"error": null,
"id": 1

Permissions Required

The user who owns the key used to authenticate the plan_endpoint.fetch call must be a member of one of the following roles

  • Administrator
  • API Manager

See authentication.


In addition to the standard json-rpc errors and authentication errors, application.fetch may also return these errors:

HTTP Status Code JSON-RPC Code Error Message Description
400 1002 Field "id" is required You've passed an object to trigger the alternative object identifier syntax, but that object does not contain an id field.

Docs Navigation