API Reference

create plan

post
https://live.kable.io/api/v1/plans/create

Create a plan.

Body Params
string
required
string
required

A human-readable name for the plan, visible on dashboards, invoices, and reports.

string

An identifier for the plan as defined by your API.

string

A human-readable description for the plan, visible on dashboards, invoices, and reports.

string

An additional identifier for the plan, defined by you, that is not visible to customers. If you have different Monthly Active Users Plans for different cohorts of customers, this is a useful place to differentiate those.

string
enum
required

The type of plan.

Allowed:
string

An identifier of the dimension along which usage is aggregated in this plan.

string

The aggregation along which usage metrics are calculated in this plan, relevant only for usage plans.

string
enum

The billing interval for the plan.

Allowed:
metadata
object

Arbitrary key-value pairs to attach to the object that can be useful for controlling functionality inside your API.

price
object
required

The monthly price of the plan.

Headers
string
required

Your Kable client ID, found in the dashboard of your Kable account.

string
required

Your LIVE or TEST secret key.

Responses

Updated over 3 years ago

Language
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated over 3 years ago