creem
v1.13.0
Published
Official TypeScript SDK and MCP server for the Creem API
Keywords
Readme
Creem
Developer-friendly & type-safe Typescript SDK specifically catered to leverage creem API.
Summary
Creem API: Creem is an all-in-one platform for managing subscriptions and recurring revenue, tailored specifically for today's SaaS companies. It enables you to boost revenue, enhance customer retention, and scale your operations seamlessly.
For more information about the API: Creem Documentation
Table of Contents
SDK Installation
The SDK can be installed with either npm, pnpm, bun or yarn package managers.
NPM
npm add creemPNPM
pnpm add creemBun
bun add creemYarn
yarn add creem[!NOTE] This package is published with CommonJS and ES Modules (ESM) support.
Model Context Protocol (MCP) Server
This SDK is also an installable MCP server where the various SDK methods are exposed as tools that can be invoked by AI applications.
Node.js v20 or greater is required to run the MCP server from npm.
Add the following server definition to your claude_desktop_config.json file:
{
"mcpServers": {
"Creem": {
"command": "npx",
"args": [
"-y", "--package", "creem",
"--",
"mcp", "start",
"--api-key", "..."
]
}
}
}Create a .cursor/mcp.json file in your project root with the following content:
{
"mcpServers": {
"Creem": {
"command": "npx",
"args": [
"-y", "--package", "creem",
"--",
"mcp", "start",
"--api-key", "..."
]
}
}
}You can also run MCP servers as a standalone binary with no additional dependencies. You must pull these binaries from available Github releases:
curl -L -o mcp-server \
https://github.com/{org}/{repo}/releases/download/{tag}/mcp-server-bun-darwin-arm64 && \
chmod +x mcp-serverIf the repo is a private repo you must add your Github PAT to download a release -H "Authorization: Bearer {GITHUB_PAT}".
{
"mcpServers": {
"Todos": {
"command": "./DOWNLOAD/PATH/mcp-server",
"args": [
"start"
]
}
}
}For a full list of server arguments, run:
npx -y --package creem -- mcp start --helpRequirements
For supported JavaScript runtimes, please consult RUNTIMES.md.
SDK Example Usage
Example
import { Creem } from "creem";
const creem = new Creem({
apiKey: process.env["CREEM_API_KEY"] ?? "",
});
async function run() {
const result = await creem.products.search();
for await (const page of result) {
console.log(page);
}
}
run();
Authentication
Per-Client Security Schemes
This SDK supports the following security scheme globally:
| Name | Type | Scheme | Environment Variable |
| -------- | ------ | ------- | -------------------- |
| apiKey | apiKey | API key | CREEM_API_KEY |
To authenticate with the API the apiKey parameter must be set when initializing the SDK client instance. For example:
import { Creem } from "creem";
const creem = new Creem({
apiKey: process.env["CREEM_API_KEY"] ?? "",
});
async function run() {
const result = await creem.products.search();
for await (const page of result) {
console.log(page);
}
}
run();
Available Resources and Operations
Affiliates
- createInvite - Create an affiliate invitation
- listInvites - List affiliate invitations
- list - List all affiliates
- retrieve - Retrieve an affiliate
- listCommissions - List affiliate commissions
Checkouts
CustomerCredits
- createAccount - Create a customer credits account
- listAccounts - List customer credits accounts
- getAccount - Retrieve a customer credits account
- getAccountBalance - Get account balance
- listEntries - List account entries
- freezeAccount - Freeze an account
- unfreezeAccount - Unfreeze an account
- creditAccount - Credit an account
- debitAccount - Debit an account
- reverseTransaction - Reverse a transaction
- closeAccount - Close an account
- postTransaction - Post a transaction
- listTransactionsByReference - List transactions by reference
- getTransaction - Retrieve a transaction
- reverseTransactionById - Reverse a transaction
Customers
- list - List all customers
- getOrders - List customer orders
- listSubscriptions - List customer subscriptions
- listLicenses - List customer licenses
- retrieve - Retrieve a customer
- create - Create a customer
- update - Update a customer
- generateBillingLinks - Generate Customer Links
Discounts
- search - Search discounts
- get - Retrieve discount
- create - Create a discount.
- delete - Delete a discount.
Events
- ingestEvents - Ingest usage events
- previewEvents - Preview usage events
- listEvents - List usage events
Licenses
- activate - Activates a license key.
- deactivate - Deactivate a license key instance.
- validate - Validates a license key or instance.
- listInstances - List license instances.
Meters
- createMeter - Create a meter
- listMeters - List meters
- previewMeter - Preview an unsaved meter definition
- getMeter - Retrieve a meter
- updateMeter - Update a meter
- previewExistingMeter - Preview an existing meter
- getConsumedUnits - Get consumed units for a customer
- archiveMeter - Archive a meter
- unarchiveMeter - Unarchive a meter
Moderation
- screenPrompt - Screen a prompt
Products
- search - List all products
- create - Creates a new product.
- get - Get a product by ID
- update - Update a product
- archive - Archive a product
Splits
Stats
- getSummary - Get store metrics summary
Subscriptions
- get - Retrieve a subscription
- search - List all subscriptions
- cancel - Cancel a subscription.
- update - Update a subscription.
- upgrade - Upgrade a subscription to a different product
- pause - Pause a subscription.
- resume - Resume a subscription.
Transactions
Webhooks
- list - List webhook endpoints
- create - Create a webhook endpoint
- get - Retrieve a webhook endpoint
- update - Update a webhook endpoint
- delete - Delete a webhook endpoint
- getSecret - Retrieve a webhook signing secret
- listPendingEvents - List pending events for a CLI webhook endpoint
- acknowledgeEvent - Acknowledge a CLI webhook event
Standalone functions
All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.
To read more about standalone functions, check FUNCTIONS.md.
affiliatesCreateInvite- Create an affiliate invitationaffiliatesList- List all affiliatesaffiliatesListCommissions- List affiliate commissionsaffiliatesListInvites- List affiliate invitationsaffiliatesRetrieve- Retrieve an affiliatecheckoutsCreate- Creates a new checkout session.checkoutsRetrieve- Retrieve a checkout session.customerCreditsCloseAccount- Close an accountcustomerCreditsCreateAccount- Create a customer credits accountcustomerCreditsCreditAccount- Credit an accountcustomerCreditsDebitAccount- Debit an accountcustomerCreditsFreezeAccount- Freeze an accountcustomerCreditsGetAccount- Retrieve a customer credits accountcustomerCreditsGetAccountBalance- Get account balancecustomerCreditsGetTransaction- Retrieve a transactioncustomerCreditsListAccounts- List customer credits accountscustomerCreditsListEntries- List account entriescustomerCreditsListTransactionsByReference- List transactions by referencecustomerCreditsPostTransaction- Post a transactioncustomerCreditsReverseTransaction- Reverse a transactioncustomerCreditsReverseTransactionById- Reverse a transactioncustomerCreditsUnfreezeAccount- Unfreeze an accountcustomersCreate- Create a customercustomersGenerateBillingLinks- Generate Customer LinkscustomersGetOrders- List customer orderscustomersList- List all customerscustomersListLicenses- List customer licensescustomersListSubscriptions- List customer subscriptionscustomersRetrieve- Retrieve a customercustomersUpdate- Update a customerdiscountsCreate- Create a discount.discountsDelete- Delete a discount.discountsGet- Retrieve discountdiscountsSearch- Search discountseventsIngestEvents- Ingest usage eventseventsListEvents- List usage eventseventsPreviewEvents- Preview usage eventslicensesActivate- Activates a license key.licensesDeactivate- Deactivate a license key instance.licensesListInstances- List license instances.licensesValidate- Validates a license key or instance.metersArchiveMeter- Archive a metermetersCreateMeter- Create a metermetersGetConsumedUnits- Get consumed units for a customermetersGetMeter- Retrieve a metermetersListMeters- List metersmetersPreviewExistingMeter- Preview an existing metermetersPreviewMeter- Preview an unsaved meter definitionmetersUnarchiveMeter- Unarchive a metermetersUpdateMeter- Update a metermoderationScreenPrompt- Screen a promptproductsArchive- Archive a productproductsCreate- Creates a new product.productsGet- Get a product by IDproductsSearch- List all productsproductsUpdate- Update a productsplitsCreate- Create a splitsplitsDelete- Delete a splitsplitsList- List all splitssplitsRetrieve- Retrieve a splitstatsGetSummary- Get store metrics summarysubscriptionsCancel- Cancel a subscription.subscriptionsGet- Retrieve a subscriptionsubscriptionsPause- Pause a subscription.subscriptionsResume- Resume a subscription.subscriptionsSearch- List all subscriptionssubscriptionsUpdate- Update a subscription.subscriptionsUpgrade- Upgrade a subscription to a different producttransactionsGetById- Get a transaction by IDtransactionsRefund- Refund a paymenttransactionsSearch- List all transactionswebhooksAcknowledgeEvent- Acknowledge a CLI webhook eventwebhooksCreate- Create a webhook endpointwebhooksDelete- Delete a webhook endpointwebhooksGet- Retrieve a webhook endpointwebhooksGetSecret- Retrieve a webhook signing secretwebhooksList- List webhook endpointswebhooksListPendingEvents- List pending events for a CLI webhook endpointwebhooksUpdate- Update a webhook endpoint
Pagination
Some of the endpoints in this SDK support pagination. To use pagination, you
make your SDK calls as usual, but the returned response object will also be an
async iterable that can be consumed using the for await...of
syntax.
Here's an example of one such pagination call:
import { Creem } from "creem";
const creem = new Creem({
apiKey: process.env["CREEM_API_KEY"] ?? "",
});
async function run() {
const result = await creem.products.search();
for await (const page of result) {
console.log(page);
}
}
run();
Retries
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
import { Creem } from "creem";
const creem = new Creem({
apiKey: process.env["CREEM_API_KEY"] ?? "",
});
async function run() {
const result = await creem.products.search(undefined, undefined, undefined, {
retries: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
});
for await (const page of result) {
console.log(page);
}
}
run();
If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
import { Creem } from "creem";
const creem = new Creem({
retryConfig: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
apiKey: process.env["CREEM_API_KEY"] ?? "",
});
async function run() {
const result = await creem.products.search();
for await (const page of result) {
console.log(page);
}
}
run();
Error Handling
CreemError is the base class for all HTTP error responses. It has the following properties:
| Property | Type | Description |
| ------------------- | ---------- | --------------------------------------------------------------------------------------- |
| error.message | string | Error message |
| error.statusCode | number | HTTP response status code eg 404 |
| error.headers | Headers | HTTP response headers |
| error.body | string | HTTP body. Can be empty string if no body is returned. |
| error.rawResponse | Response | Raw HTTP response |
| error.data$ | | Optional. Some errors may contain structured data. See Error Classes. |
Example
import { Creem } from "creem";
import * as errors from "creem/models/errors";
const creem = new Creem({
apiKey: process.env["CREEM_API_KEY"] ?? "",
});
async function run() {
try {
const result = await creem.customerCredits.createAccount({
customerId: "cust_abc123",
initialBalance: "300",
});
console.log(result);
} catch (error) {
// The base class for HTTP error responses
if (error instanceof errors.CreemError) {
console.log(error.message);
console.log(error.statusCode);
console.log(error.body);
console.log(error.headers);
// Depending on the method different errors may be thrown
if (error instanceof errors.CustomerCreditsErrorResponseDto) {
console.log(error.data$.error); // components.CustomerCreditsErrorDetailDto
}
}
}
}
run();
Error Classes
Primary error:
CreemError: The base class for HTTP error responses.
Network errors:
ConnectionError: HTTP client was unable to make a request to a server.RequestTimeoutError: HTTP request timed out due to an AbortSignal signal.RequestAbortedError: HTTP request was aborted by the client.InvalidRequestError: Any input used to create a request is invalid.UnexpectedClientError: Unrecognised or unexpected error.
Inherit from CreemError:
CustomerCreditsErrorResponseDto: Applicable to 8 of 79 methods.*UsageMeteringErrorApiResponseDto: Applicable to 6 of 79 methods.*ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. Seeerror.rawValuefor the raw value anderror.pretty()for a nicely formatted multi-line string.
* Check the method documentation to see if the error is applicable.
Server Selection
Select Server by Name
You can override the default server globally by passing a server name to the server: keyof typeof ServerList optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers:
| Name | Server | Description |
| ------ | --------------------------- | -------------------------------------------------------------------- |
| prod | https://api.creem.io | Production — live API for processing real transactions and data. |
| test | https://test-api.creem.io | Test — sandbox API for development and testing with no real charges. |
Example
import { Creem } from "creem";
const creem = new Creem({
server: "prod",
apiKey: process.env["CREEM_API_KEY"] ?? "",
});
async function run() {
const result = await creem.products.search();
for await (const page of result) {
console.log(page);
}
}
run();
Override Server URL Per-Client
The default server can also be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:
import { Creem } from "creem";
const creem = new Creem({
serverURL: "https://api.creem.io",
apiKey: process.env["CREEM_API_KEY"] ?? "",
});
async function run() {
const result = await creem.products.search();
for await (const page of result) {
console.log(page);
}
}
run();
Custom HTTP Client
The TypeScript SDK makes API calls using an HTTPClient that wraps the native
Fetch API. This
client is a thin wrapper around fetch and provides the ability to attach hooks
around the request lifecycle that can be used to modify the request or handle
errors and response.
The HTTPClient constructor takes an optional fetcher argument that can be
used to integrate a third-party HTTP client or when writing tests to mock out
the HTTP client and feed in fixtures.
The following example shows how to:
- route requests through a proxy server using undici's ProxyAgent
- use the
"beforeRequest"hook to add a custom header and a timeout to requests - use the
"requestError"hook to log errors
import { Creem } from "creem";
import { ProxyAgent } from "undici";
import { HTTPClient } from "creem/lib/http";
const dispatcher = new ProxyAgent("http://proxy.example.com:8080");
const httpClient = new HTTPClient({
// 'fetcher' takes a function that has the same signature as native 'fetch'.
fetcher: (input, init) =>
// 'dispatcher' is specific to undici and not part of the standard Fetch API.
fetch(input, { ...init, dispatcher } as RequestInit),
});
httpClient.addHook("beforeRequest", (request) => {
const nextRequest = new Request(request, {
signal: request.signal || AbortSignal.timeout(5000)
});
nextRequest.headers.set("x-custom-header", "custom value");
return nextRequest;
});
httpClient.addHook("requestError", (error, request) => {
console.group("Request Error");
console.log("Reason:", `${error}`);
console.log("Endpoint:", `${request.method} ${request.url}`);
console.groupEnd();
});
const sdk = new Creem({ httpClient: httpClient });Debugging
You can setup your SDK to emit debug logs for SDK requests and responses.
You can pass a logger that matches console's interface as an SDK option.
[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
import { Creem } from "creem";
const sdk = new Creem({ debugLogger: console });You can also enable a default debug logger by setting an environment variable CREEM_DEBUG to true.
Development
Maturity
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
Contributions
While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.
