Customers
Who are the consumers of your API?
Customers are the consumers of your API.
They can be developers, applications, businesses, or anyone who uses your API. When a new customer signs up to use your API, you should create a customer on Kable.
Customers can be created from the Customers tab in your dashboard or programmatically through the API.
Name | API Field | Description |
---|---|---|
ID | customerId | A Kable-defined identifier for each customer (which you don't need to store). |
Client ID | clientId | A unique, immutable identifier for the customer, defined by you. This should correspond to the customer identifier inside your API. When recording usage metrics in Kable, you must include the customer's clientId in every usage event. |
Name | companyName | A human-readable name of the customer. Customer names will appear in dashboards, on invoices, and in reports. |
Currency | currency | The customer's default currency. Only one currency per customer is supported. |
Status | status | The customer's current state. Valid values are ACTIVE and CANCELLED . |
Next Invoice Date | nextInvoiceDate | The date of the customer's next invoice, if any. |
Plans | plans | A collection of plans to which this customer is currently subscribed. Learn more about plans here. |
Updated 10 months ago