add customer plan(s)

post https://live.kable.io/api/v1/customers/{customerId}/plans/add

Add a plan(s) to a customer.

Note that customer plans can also be added and removed manually from within the Customers tab of your Kable dashboard.

Responses

Response body

object

kableClientId

string

required

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

customerId

string

required

A Kable-defined identifier for the customer.

clientId

string

required

A unique identifier for the customer, defined by you.

companyName

string

required

The name of the customer.

currency

string

required

Three-letter ISO currency code

USD CAD MXN EUR GBP JPY INR CNY AUD NZD AED

status

string

required

The status of the customer.

ACTIVE CANCELLED

nextInvoiceDate

date-time

The date at which the customer's next invoice will occur.

billingContact

object

A point of contact for invoices and other billing-related communications.

firstName

string

Contact's first name.

lastName

string

Contact's last name.

string

Contact's email address.

phone

string

Contact's phone number.

addressLine1

string

First line of contact's mailing address.

addressLine2

string

Second line of contact's mailing address.

city

string

City of contact's mailing address.

state

string

State of contact's mailing address.

postalCode

string

Postal code of contact's mailing address.

country

string

Country of contact's mailing address.

plans

array of objects

required

The customer's plans.

plans*

object

planId

string

required

A Kable-defined identifier for the plan.

name

string

required

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

externalId

string

An identifier for the plan as defined by your API.

description

string

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

nickname

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.

type

string

required

The type of plan.

USAGE SUBCRIPTION

dimensionId

string

required

An identifier of the dimension along which usage is aggregated in this plan, relevant only for usage plans.

aggregation

string

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

interval

string

required

The billing interval for the plan.

MONTH

metadata

object

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

Has additional fields

price

object

required

The monthly price of the plan.

entitlements

array of objects

required

The entitlements associated with this plan.

entitlements*

object

name

string

required

The name of the entitlement

entitlementId

string

required

A Kable-defined identifier for the entitlement.

externalId

string

required

An identifier for the entitlement as defined by your API.

datatype

string

required

The type of data supported by the entitlement.

description

string

required

A description of the entitlement.

created

date-time

required

Date at which entity was first created

modified

date-time

required

Date at which entity was last modified

value

object

required

The value of the entitlement.

Has additional fields

created

date-time

required

Date at which entity was first created

modified

date-time

required

Date at which entity was last modified

addedDate

date-time

required

endedDate

date-time

periodStartDate

date-time

periodEndDate

date-time

bundles

array of objects

required

The customer's bundles.

bundles*

object

bundleId

string

required

A Kable-defined identifier for the bundle.

name

string

required

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

externalId

string

An identifier for the bundle as defined by your API.

description

string

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

nickname

string

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

currency

string

required

Three-letter ISO currency code

USD CAD MXN EUR GBP JPY INR CNY AUD NZD AED

plans

array of objects

The plans included in this bundle.

plans

object

planId

string

required

A Kable-defined identifier for the plan.

name

string

required

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

externalId

string

An identifier for the plan as defined by your API.

description

string

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

nickname

string

type

string

required

The type of plan.

USAGE SUBCRIPTION

dimensionId

string

required

An identifier of the dimension along which usage is aggregated in this plan, relevant only for usage plans.

aggregation

string

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

interval

string

required

The billing interval for the plan.

MONTH

metadata

object

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

Has additional fields

price

object

required

The monthly price of the plan.

entitlements

array of objects

required

The entitlements associated with this plan.

entitlements*

object

name

string

required

The name of the entitlement

entitlementId

string

required

A Kable-defined identifier for the entitlement.

externalId

string

required

An identifier for the entitlement as defined by your API.

datatype

string

required

The type of data supported by the entitlement.

description

string

required

A description of the entitlement.

created

date-time

required

Date at which entity was first created

modified

date-time

required

Date at which entity was last modified

value

object

required

The value of the entitlement.

Has additional fields

created

date-time

required

Date at which entity was first created

modified

date-time

required

Date at which entity was last modified

metadata

object

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

Has additional fields

created

date-time

required

Date at which entity was first created

modified

date-time

required

Date at which entity was last modified

entitlements

array of objects

required

The customer's entitlements.

entitlements*

object

name

string

required

The name of the entitlement

entitlementId

string

required

A Kable-defined identifier for the entitlement.

externalId

string

required

An identifier for the entitlement as defined by your API.

datatype

string

required

The type of data supported by the entitlement.

description

string

required

A description of the entitlement.

created

date-time

required

Date at which entity was first created

modified

date-time

required

Date at which entity was last modified

value

object

required

The value of the entitlement.

Has additional fields

created

date-time

required

Date at which entity was first created

modified

date-time

required

Date at which entity was last modified

Language

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://live.kable.io/api/v1/customers/customerId/plans/add \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Customer plan successfully added

401Unauthorized

500Something went wrong