plan.delete

Description

Delete a plan  Please see Deleting Objects for an overview of how the update 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 application to delete. You may also pass a json object with a field of id to identify the plan you wish to delete.

Response

Delete returns null on success.

Examples

A Sample JSON-RPC plan.delete Request

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

The JSON-RPC Response

{
    "result":null,
    "error":null,
    "id":53
}

Permissions Required

The user who owns the key used to authenticate the plan.delete 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:

HTTP Status Code JSON-RPC Code Error Message Description
500 2003 Delete Failed The object could not be deleted.  This is the error message of last resort for object deletions and usually indicates a systems integration failure, invalid internal data, or a transient issue.  These errors are logged by Mashery.

Docs Navigation