Skip to content

Introduction.md

Latest commit

 

History

History
73 lines (54 loc) · 2.17 KB

Introduction.md

File metadata and controls

73 lines (54 loc) · 2.17 KB

Introduction

Kickplan takes care of the complex business logic for monetization, using our SDK, your application only needs to manage access to features and track value metrics. These functions are keyed by account. For detailed terminology, please consult our documentation.

Configuration

To import the package using CommonJS

const { KickplanApi } = require('@kickplan/sdk-typescript')

Or in ES6

import { KickplanApi } from '@kickplan/sdk-typescript'

After importing, please initialize your client:

const kickplan = new KickplanApi({
  apiKey: 'YOUR_API_KEY_HERE',
  baseUrl: 'YOUR_URL_HERE'
})

.env variables are also supported via KICKPLAN_API_KEY and KICKPLAN_BASE_URL respectively.

Available Resources

Features

Manage and check feature availability for accounts. Use this to determine which features are accessible to specific accounts.

await kickplan.features.resolveWithAccount(featureKey, accountKey)

Accounts

Handle account operations including creation, updates, and management of account-specific settings.

await kickplan.accounts.create({
  key: "unique-account-id",
  name: "Account Name"
})

Metrics

Track and set key metrics for accounts.

await kickplan.metrics.setMetricsKey({
  key: "metric-key",
  value: "metric-value",
  timestamp: new Date()
})

Billable Objects

Manage billable entities within your application. These are used to track metrics and billing events over multiple billing cycles.

await kickplan.billableObjects.create({
  key: "billable-object-key",
  type: "billable-object-type",
  parameters: {
    // additional parameters
  }
})

For detailed API documentation and advanced usage of each resource, please refer to our API Reference.