Introduction

The Creem API is built on REST principles and uses HTTPS for all requests. It returns JSON-encoded responses and uses standard HTTP status codes.

Base URL

All API requests are made to the following base URLs:

Production
Test Mode

https://api.creem.io/v1

https://test-api.creem.io/v1

The test and production environments are completely isolated. Data created in test mode does not affect your production environment, and API keys are not interchangeable between environments.

Authentication

All API requests must include your API key in the x-api-key header.

curl -X GET https://api.creem.io/v1/products \
  -H "x-api-key: creem_YOUR_API_KEY"

You can find your API keys in the Developers section of your dashboard.

Never expose your API keys in client-side code, public repositories, or logs. Keep them server-side only.

Test Mode

Test mode gives you a full sandbox environment to build and test your integration without processing real payments.

	Production	Test Mode
Base URL	`https://api.creem.io/v1`	`https://test-api.creem.io/v1`
API Keys	Found in dashboard (production mode)	Found in dashboard (test mode toggle)
Payments	Real charges	Simulated with test cards
Data	Live data	Isolated sandbox data

To activate test mode, toggle Test Mode in the bottom of the left sidebar of your dashboard.

Test Cards

Use these card numbers to simulate different payment scenarios. All cards work with any future expiration date, any CVV, and any billing information. Click a card number to copy it.

Card Number	Behavior
	Successful payment
	Card declined
	Insufficient funds
	Incorrect CVC

Using Test Mode in Code

curl -X POST https://test-api.creem.io/v1/checkouts \
  -H "x-api-key: YOUR_TEST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "product_id": "prod_YOUR_PRODUCT_ID",
    "success_url": "https://yoursite.com/success"
  }'

import { Creem } from "creem";

const creem = new Creem({
  apiKey: process.env.CREEM_API_KEY!,
  server: process.env.NODE_ENV === "production" ? "prod" : "test",
});

const checkout = await creem.checkouts.create({
  productId: "prod_abc123",
  successUrl: "https://yoursite.com/success",
});

import { Checkout } from "@creem_io/nextjs";

export const GET = Checkout({
  apiKey: process.env.CREEM_API_KEY!,
  testMode: process.env.NODE_ENV !== "production",
  defaultSuccessUrl: "/success",
});

Webhooks

Creem sends real-time event notifications to your server via webhooks. Webhook payloads are signed using HMAC-SHA256 so you can verify their authenticity. Signature verification: Every webhook request includes a creem-signature header. Verify it using your webhook secret (found in Developers > Webhook) before processing the payload:

import { verifyWebhookSignature } from "creem/webhooks";

await verifyWebhookSignature(rawBody, request.headers, {
  secret: process.env.CREEM_WEBHOOK_SECRET!,
});

Supported events:

Event	Description
`checkout.completed`	A checkout session was completed
`subscription.active`	A new subscription was created
`subscription.paid`	A subscription payment was collected
`subscription.canceled`	A subscription was canceled
`subscription.scheduled_cancel`	A subscription is scheduled for cancellation at period end
`subscription.past_due`	A subscription payment failed
`subscription.expired`	A subscription period ended without payment
`subscription.trialing`	A subscription started a trial
`subscription.paused`	A subscription was paused
`subscription.update`	A subscription was updated
`refund.created`	A refund was issued
`dispute.created`	A dispute was opened by a customer

Retry policy: If your endpoint doesn’t respond with HTTP 200, Creem retries at 30 seconds, 1 minute, 5 minutes, and 1 hour. You can also resend events manually from the dashboard.

Full Webhooks Guide

Detailed setup instructions, signature verification, and event payload examples.

Response Codes

Status	Description
`200`	Successful request
`400`	Invalid parameters or validation error
`401`	Missing API key
`403`	Invalid API key or insufficient permissions
`404`	Resource not found
`429`	Rate limit exceeded
`500`	Internal server error

Every error response includes a trace_id you can share with support for faster debugging. See Error Handling for details.

SDKs & Libraries

TypeScript SDK

Core SDK for Node.js and TypeScript projects

Next.js Adapter

Drop-in checkout and webhook helpers for Next.js

Better Auth Plugin

Integrate Creem billing with Better Auth

CLI

Manage products and checkouts from the terminal

API Documentation

Checkout

Product

Customer

Transactions

License

Discount Code

Subscription

Stats

Customer Credits

Moderation

Introduction

Base URL

Authentication

Test Mode

Test Cards

Using Test Mode in Code

Webhooks

Full Webhooks Guide

Response Codes

SDKs & Libraries

TypeScript SDK

Next.js Adapter

Better Auth Plugin

CLI

​Base URL

​Authentication

​Test Mode

​Test Cards

​Using Test Mode in Code

​Webhooks

Full Webhooks Guide

​Response Codes

​SDKs & Libraries

TypeScript SDK

Next.js Adapter

Better Auth Plugin

CLI

Base URL

Authentication

Test Mode

Test Cards

Using Test Mode in Code

Webhooks

Response Codes

SDKs & Libraries