API Docs
REST API Endpoints

4min
We support a number of both server-side and client-side implementation patterns, including no-code solutions.
We also support both REST and Websocket (JSON RPC) style integrations. If you aren't sure where to start, feel free to contact us and we'll discuss what works best for your use case.
Accounts
POST
Request
Body Parameters
key
required
String
ID of the account
name
optional
String
Name of the account
custom_fields
optional
Object
Custom fields to set for the account. Each custom field is a key: value pair.
account_plans
optional
Array
Array of plans the account is subscribed to. Each array element is an object: { plan_key: "value" }.
feature _overrides
optional
Array
Array of feature overrides to set for the account. Each array element is an object: { feature_key: "value", variant_key: "value" }.
Curl
Ruby
curl --location 'https://<customer>-control.kickplan.dev/api/accounts' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{"key":"acme","name":"Acme","custom_fields":{"salesforce_id": "12345"},"account_plans":[{"plan_key":"essentials"}],"feature _overrides":[{"feature_key":"metrics","variant_key":"true"},{"feature_key":"chat","variant_key":"off"}]}'
curl --location 'https://<customer>-control.kickplan.dev/api/accounts' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{"key":"acme","name":"Acme","custom_fields":{"salesforce_id": "12345"},"account_plans":[{"plan_key":"essentials"}],"feature _overrides":[{"feature_key":"metrics","variant_key":"true"},{"feature_key":"chat","variant_key":"off"}]}'
Responses
200
400
{
  "feature_overrides": ["metrics/true", "chat/off"],
  "inserted_at": "2024-02-22T20:07:44.706979Z", 
  "key": "acme",
  "name": "Acme Inc.",
  "plans": ["essentials"],
  "updated_at": "2024-02-22T20:07:44.706979Z"
}
{
  "feature_overrides": ["metrics/true", "chat/off"],
  "inserted_at": "2024-02-22T20:07:44.706979Z", 
  "key": "acme",
  "name": "Acme Inc.",
  "plans": ["essentials"],
  "updated_at": "2024-02-22T20:07:44.706979Z"
}
﻿
Features
POST
Request
Body Parameters
detailed
optional
Boolean
whether to retrieve all details associated with the feature, or just the value.
context
required
Object
Name of the account
Curl
Ruby
# sample for a Rails app, see Ruby SDK for more

# resolve globally
Kickplan::Features.resolve("upload-contacts")

# resolve for an account
Kickplan::Features.resolve("upload-contacts", { context: { account_key: "acme"}})

# resolve with detailed response
Kickplan::Features.resolve("upload-contacts", detailed: true)

# sample for a Rails app, see Ruby SDK for more

# resolve globally
Kickplan::Features.resolve("upload-contacts")

# resolve for an account
Kickplan::Features.resolve("upload-contacts", { context: { account_key: "acme"}})

# resolve with detailed response
Kickplan::Features.resolve("upload-contacts", detailed: true)
Responses
200
{
    "value": true,
    "metadata": {
        "name": "Upload Contacts"
    },
    "key": "upload-contacts",
    "error_code": null,
    "variant": "true"
}

# response when no account found
{
    "value": false,
    "metadata": {
        "name": "Upload Contacts"
    },
    "key": "upload-contacts",
    "error_code": null,
    "variant": "false"
}
{
    "value": true,
    "metadata": {
        "name": "Upload Contacts"
    },
    "key": "upload-contacts",
    "error_code": null,
    "variant": "true"
}

# response when no account found
{
    "value": false,
    "metadata": {
        "name": "Upload Contacts"
    },
    "key": "upload-contacts",
    "error_code": null,
    "variant": "false"
}
﻿
POST
Request
Body Parameters
detailed
optional
Boolean
whether to retrieve all details associated with the feature, or just the value.
context
required
Object
Name of the account
Curl
Ruby
# sample for a Rails app, see Ruby SDK for more

# resolve all features globally
Kickplan::Features.resolve()

# resolve all features for an account
Kickplan::Features.resolve({ context: { account_key: "acme"}})

# resolve with detailed response
Kickplan::Features.resolve(detailed: true)

# sample for a Rails app, see Ruby SDK for more

# resolve all features globally
Kickplan::Features.resolve()

# resolve all features for an account
Kickplan::Features.resolve({ context: { account_key: "acme"}})

# resolve with detailed response
Kickplan::Features.resolve(detailed: true)
Responses
200
[
  {
    "value": true,
    "key": "upload-contacts",
  },
  {
    "value": false,
    "key": "chat",
  }
]
[
  {
    "value": true,
    "key": "upload-contacts",
  },
  {
    "value": false,
    "key": "chat",
  }
]
﻿
Metrics
POST
Request
Body Parameters
key
required
String
Metric key
value
required
Integer
Metric value
account_key
required
String
Account key
idempotency_key
optional
String
time
optional
String
Datetime in ISO 8601 format.
Curl
Ruby
# sample for a Rails app, see Ruby SDK for more

# set metric for an account
Kickplan::Metrics.set(
  key: "seats", 
  value: "5", 
  account_key: "acme", 
  idempotency_key: "some-key",
  time: "2024-04-29T12:20:34-07:00"
)
# sample for a Rails app, see Ruby SDK for more

# set metric for an account
Kickplan::Metrics.set(
  key: "seats", 
  value: "5", 
  account_key: "acme", 
  idempotency_key: "some-key",
  time: "2024-04-29T12:20:34-07:00"
)
Responses
202

﻿
﻿
Updated 15 Aug 2024
Did this page help you?
Graphql API
Chargebee