plan.create

Description

Create a plan  Please see Creating Objects for an overview of how the create 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

An plan object, as described by the object.describe call. If a field in the plan object is ommitted, a default value will be used if possible. If extra fields are passed, they will be ignored.

Response

An plan object, as described by the object.describe call. This is actual plan that was created.

Examples

A Sample JSON-RPC plan.create Request

{
    "method":"plan.create",
    "id":8,
    "params":[{"name":"Production Plan",
    "description":"Get developers off this plan after 90 days",
    "notes":"",
    "is_public":true,
    "order_max":4,
    "order_moderation_threshold":0,
    "is_moderated":true,
    "qps_limit_ceiling":2,
    "qps_limit_key_override_allowed":true,
    "rate_limit_ceiling":5000,
    "rate_limit_period":"day",
    "rate_limit_key_override_allowed":true,
    "plan_filter":"",
    "qps_limit_exempt":false,
    "rate_limit_exempt":false,
    "package":{"id":19}}]
}

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.create 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: