plan.fetch

Description

Get a specific plan or a list of plans  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.

Parameters

plan id

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

Response

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

Examples

A Sample JSON-RPC plan.fetch Request

{
    "method":"plan.fetch",
    "id":53,
    "params":[{"id":48}]
}

The JSON-RPC Response

{
    "result":{"id":48,
    "name":"Production",
    "description":"Production plan",
    "notes":"Get developers off this plan after 90 days",
    "rate_limit_ceiling":5000,
    "rate_limit_exempt":false,
    "rate_limit_order_override_allowed":true,
    "rate_limit_key_override_allowed":true,
    "rate_limit_period":"day",
    "qps_limit_ceiling":2,
    "qps_limit_exempt":false,
    "qps_limit_order_override_allowed":true,
    "qps_limit_key_override_allowed":true,
    "order_max":4,
    "order_moderation_threshold":0,
    "response_filter_override_allowed":true,
    "created":"2012-06-27T01:18:03Z",
    "updated":"2012-06-27T01:18:27Z",
    "is_public":true,
    "is_moderated":true,
    "priority":0,
    "status":"active",
    "limits":[{"period":"second",
    "source":"plan",
    "ceiling":2},{"period":"day",
    "source":"plan",
    "ceiling":5000}],
    "object_type":"plan"},
    "error":null,
    "id":16
}

Permissions Required

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

• Administrator
• API Manager

See authentication.

Errors

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