---
canonical_url: "https://docs.composio.dev/toolkits/creem"
markdown_url: "https://docs.composio.dev/toolkits/creem.md"
product: "platform"
version: null
last_updated: null
---

# Creem

Creem is a merchant-of-record platform for managing products, checkouts, subscriptions, customers, licenses, discounts, transactions, refunds, and revenue operations.

- **Category:** payment processing
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 48
- **Triggers:** 0
- **Slug:** `CREEM`
- **Version:** 00000000_00

## Tools

### Activate License

**Slug:** `CREEM_ACTIVATE_LICENSE`

Activate a Creem license key for a named device or instance. This mutates the license entitlement by consuming an activation slot and can prevent other devices from activating when the license reaches its limit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `key` | string | Yes | License key to activate. |
| `instance_name` | string | Yes | Label for the new device or instance in Creem. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Archive Product

**Slug:** `CREEM_ARCHIVE_PRODUCT`

Archive a product so it can no longer be purchased. This is a destructive soft-delete: the product remains available for historical orders and subscriptions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `product_id` | string | Yes | The unique ID of the product to archive. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cancel Subscription

**Slug:** `CREEM_CANCEL_SUBSCRIPTION`

Cancel an active Creem subscription immediately, at the end of its current billing period, or according to the store default. This is a destructive financial operation; confirm the subscription and timing before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `timing` | string ("immediate" | "end_of_period" | "store_default") | No | When to cancel: immediate cancels now, end_of_period cancels after the current billing period, and store_default uses the store's billing setting. |
| `subscription_id` | string | Yes | Unique identifier of the subscription to cancel. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Close Credit Account

**Slug:** `CREEM_CLOSE_CREDIT_ACCOUNT`

Experimental Creem API: permanently close a credit account in the connected production store. This irreversible action cannot be undone; confirm the account ID before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | string | Yes | Unique identifier of the credit account to permanently close. Confirm the production account before calling because closure cannot be undone. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Checkout

**Slug:** `CREEM_CREATE_CHECKOUT`

Create a live checkout session in the connected Creem production store for a one-time payment or subscription. The returned checkout_url can accept a real customer payment. custom_price overrides the product's per-unit price for this checkout and must be reviewed carefully before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `units` | number | No | Number of product units in the order. |
| `customer` | object | No | Customer data used to prefill the checkout page. |
| `metadata` | object | No | Checkout metadata as arbitrary key-value pairs. |
| `product_id` | string | Yes | ID of the product associated with the checkout session. |
| `request_id` | string | No | Identifier used to track this checkout request. |
| `success_url` | string | No | URL to redirect the customer to after checkout completes. |
| `custom_field` | array | No | Deprecated. Use custom_fields instead. Custom fields to collect, up to 3. |
| `custom_price` | integer | No | Live per-unit price override in cents, using the product currency. Only supported for one-time products. This changes what the customer will pay: units multiplied by custom_price is the checkout amount. |
| `custom_fields` | array | No | Custom fields to collect from the customer, up to 3. |
| `discount_code` | string | No | Discount code to prefill on the checkout page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Credit Account

**Slug:** `CREEM_CREATE_CREDIT_ACCOUNT`

Experimental Creem API: create a credit account for a customer in the connected production store, optionally with an initial balance. This is a live financial mutation. Verify the customer ID and initial balance before calling because a successful request creates the account and seeds its balance.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Human-readable name for the credit account. |
| `unit_label` | string | No | Label for the units held in the account. |
| `customer_id` | string | Yes | Owner ID this credit account belongs to, such as a Creem customer ID. |
| `initial_balance` | string | No | Optional initial credit balance, represented as a string by Creem. This seeds a live financial balance when the account is created; verify the customer and amount before calling. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Customer

**Slug:** `CREEM_CREATE_CUSTOMER`

Create a customer record in the connected Creem production store. This is a live production mutation: a successful call permanently adds a customer.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Full name of the customer. |
| `email` | string | Yes | Email address for the customer. |
| `metadata` | object | No | Additional metadata to associate with the customer. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Customer Portal Link

**Slug:** `CREEM_CREATE_CUSTOMER_PORTAL_LINK`

Generate a sensitive customer portal link for managing billing, subscriptions, and payment methods in the connected Creem production store. Share the returned URL only with the intended customer.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customer_id` | string | Yes | Unique identifier of the customer. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Discount

**Slug:** `CREEM_CREATE_DISCOUNT`

Create a promotional discount for products in the connected Creem production store. This is a live financial mutation that can reduce customer prices. Confirm the product IDs, fixed amount and currency, or percentage before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | No | Optional customer-facing discount code. Creem generates one when omitted. |
| `name` | string | Yes | Name of the discount. |
| `type` | string ("percentage" | "fixed") | Yes | Discount pricing discriminator. Use `fixed` with amount and currency, or `percentage` with percentage. The two pricing forms cannot be combined. |
| `amount` | integer | No | Live fixed discount value in the currency's minor unit (cents; e.g. 2000 for $20.00 USD), matching Creem's amount convention across the API. Required only when type is `fixed`; review the amount and currency carefully because this changes customer pricing. |
| `currency` | string | No | Currency for amount. Required only when type is `fixed`. |
| `duration` | string ("forever" | "once" | "repeating") | Yes | How long the discount applies: `forever`, `once`, or `repeating`. |
| `percentage` | number | No | Live percentage reduction. Required only when type is `percentage`; review it carefully because this changes customer pricing. |
| `expiry_date` | string | No | ISO 8601 date and time when the discount expires. |
| `max_redemptions` | number | No | Maximum number of times the discount may be redeemed. |
| `duration_in_months` | number | No | Number of months the discount applies. Required when duration is `repeating`; usable only with subscription products, and rejected for any other duration. |
| `applies_to_products` | array | Yes | Product IDs whose live prices this discount may reduce. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Product

**Slug:** `CREEM_CREATE_PRODUCT`

Create a product in the connected Creem production store for a one-time payment, free purchase, or subscription. This is a live financial mutation: a successful call creates a purchasable product. Use idempotency_key for safe retries.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the product. |
| `price` | integer | Yes | Price in cents. Use 0 for a free product or at least 100 for a paid product. |
| `currency` | string ("EUR" | "USD") | Yes | Three-letter currency code supported by Creem: `EUR` or `USD`. |
| `tax_mode` | string ("inclusive" | "exclusive") | No | Tax calculation mode: included in the price or added on top. |
| `image_url` | string | No | URL of the product image. |
| `image_urls` | array | No | Ordered product image URLs, up to 8. The first is the cover and takes precedence over image_url. |
| `description` | string | Yes | Description of the product. |
| `billing_type` | string ("recurring" | "onetime") | Yes | Billing method: `recurring` subscription or `onetime` payment. |
| `custom_field` | array | No | Deprecated. Use custom_fields instead. Custom fields collected during checkout, up to 3. |
| `tax_category` | string ("saas" | "digital-goods-service" | "ebooks") | No | Product or service category Creem uses to determine applicable tax rules. |
| `custom_fields` | array | No | Custom fields collected during checkout, up to 3. |
| `billing_period` | string ("every-month" | "every-three-months" | "every-six-months" | "every-year" | "every-day" | "once") | No | Billing interval. Required by Creem for recurring products. |
| `idempotency_key` | string | No | Optional key that makes retries return the originally created product instead of creating a duplicate. |
| `suggested_price` | integer | No | Suggested amount in cents when pay-what-you-want is enabled. It must be at least the price. |
| `pay_what_you_want` | boolean | No | Allow the customer to choose the amount at checkout. The price is the minimum; supported only for one-time products. |
| `default_success_url` | string | No | URL to redirect the customer to after successful payment. |
| `abandoned_cart_recovery_enabled` | boolean | No | Whether abandoned cart recovery is enabled for this product. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Credit Account

**Slug:** `CREEM_CREDIT_ACCOUNT`

Experimental Creem API: add credits to a customer credit account in the connected production store and return the resulting ledger transaction. This is an irreversible live financial mutation. Confirm the account, amount, and reference before calling, and reuse the same idempotency key for retries of the same intended credit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `amount` | string | Yes | Credit amount represented as a string for large-number safety. Confirm the amount and account before calling. |
| `reference` | string | Yes | Your reference ID linking this ledger transaction to an event in your system, such as an order or campaign ID. |
| `account_id` | string | Yes | Unique ID of the credit account to fund. Confirm the production account before calling because this creates a live ledger credit. |
| `idempotency_key` | string | Yes | Unique key that prevents duplicate credit transactions. Reuse the exact same key when retrying the same intended credit, especially after a timeout or uncertain response; use a new key only for a distinct credit. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Deactivate License

**Slug:** `CREEM_DEACTIVATE_LICENSE`

Deactivate one device instance for a Creem license key and free its activation slot. This removes that instance's entitlement and access; confirm both the license key and instance ID before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `key` | string | Yes | License key whose device entitlement will be deactivated. Confirm the key before calling because this removes access for one instance. |
| `instance_id` | string | Yes | ID of the activated instance to deactivate. Use the license-instance listing to select the exact device; deactivation frees its activation slot. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Debit Account

**Slug:** `CREEM_DEBIT_ACCOUNT`

Experimental Creem API: irreversibly deduct credits from a customer credit account in the connected production store and create a live ledger transaction. Confirm the account, amount, and reference before calling. For retries, reuse the same idempotency key so an uncertain prior attempt cannot become a duplicate debit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `amount` | string | Yes | Credit amount to deduct, represented as a string for bigint safety. Confirm the amount before calling. |
| `reference` | string | Yes | Caller-defined reference linking this debit to an event in the caller's system, such as an order or campaign ID. |
| `account_id` | string | Yes | Unique ID of the production credit account to debit. Confirm the account before calling because this creates a live ledger deduction. |
| `idempotency_key` | string | Yes | Unique key preventing duplicate ledger transactions. Reuse this exact key when retrying the same intended debit; never generate a new key for an ambiguous prior attempt. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Discount

**Slug:** `CREEM_DELETE_DISCOUNT`

Permanently delete a Creem discount code and prevent any further use. This destructive financial operation cannot be undone; confirm the discount ID before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `discount_id` | string | Yes | Unique identifier of the discount to permanently delete. Confirm the ID before calling because deletion cannot be undone. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Freeze Credit Account

**Slug:** `CREEM_FREEZE_CREDIT_ACCOUNT`

Experimental Creem API: freeze a credit account in the connected production store, preventing new transactions against its live credit balance. This changes financial account state; confirm the account ID before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | string | Yes | Unique ID of the credit account to freeze. Confirm the production account before calling because freezing it prevents new transactions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Affiliate

**Slug:** `CREEM_GET_AFFILIATE`

Retrieve a single affiliate by ID, including referral link, click and conversion counts, and lifetime commission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `affiliate_id` | string | Yes | The unique identifier of the affiliate to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Checkout

**Slug:** `CREEM_GET_CHECKOUT`

Retrieve a Creem checkout session by ID, including its status, product, customer, payment relationships, issued licenses, and metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `checkout_id` | string | Yes | The unique identifier of the checkout session to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Credit Account

**Slug:** `CREEM_GET_CREDIT_ACCOUNT`

Experimental Creem API: retrieve a customer credits account by its unique identifier, including its owner, unit label, status, and timestamps.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | string | Yes | The unique identifier of the customer credits account to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Credit Account Balance

**Slug:** `CREEM_GET_CREDIT_ACCOUNT_BALANCE`

Experimental Creem API: retrieve a credit account's current projected balance or its balance at an optional historical timestamp.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | string | Yes | Unique identifier of the Creem credit account. |
| `historical_at` | string | No | Optional ISO 8601 timestamp at which to compute the historical balance. Omit it to retrieve the current projected balance. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Customer

**Slug:** `CREEM_GET_CUSTOMER`

Retrieve one Creem customer by exactly one lookup field: customer_id or email. Returns the customer's profile and metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | No | The customer's email address. Provide this or customer_id, but not both. |
| `customer_id` | string | No | The unique identifier of the customer. Provide this or email, but not both. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Discount

**Slug:** `CREEM_GET_DISCOUNT`

Retrieve Creem discount details by exactly one lookup field: discount_id or discount_code. Returns usage limits, expiration, and discount amount.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `discount_id` | string | No | The unique identifier of the discount. Provide exactly one of discount_id or discount_code. |
| `discount_code` | string | No | The unique discount code. Provide exactly one of discount_id or discount_code. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Product

**Slug:** `CREEM_GET_PRODUCT`

Retrieve a single Creem product by its unique identifier.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `product_id` | string | Yes | The unique identifier of the product to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Store Metrics

**Slug:** `CREEM_GET_STORE_METRICS`

Retrieve Creem store counts, revenue, and monthly recurring revenue in integer cents, optionally filtered and grouped by a date range.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `currency` | string ("EUR" | "USD") | Yes | Currency in which Creem returns revenue metrics. |
| `end_date` | integer | No | End of the date range as a Unix timestamp in milliseconds. Provide it with start_date; both dates are required when interval is set. |
| `interval` | string ("day" | "week" | "month") | No | Optional time-series bucket size. Requires both start_date and end_date and adds period-level revenue metrics to the response. |
| `start_date` | integer | No | Start of the date range as a Unix timestamp in milliseconds. Provide it with end_date; both dates are required when interval is set. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Subscription

**Slug:** `CREEM_GET_SUBSCRIPTION`

Retrieve a Creem subscription by ID, including its status, billing cycle, customer, product, items, payment history, and timestamps.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `subscription_id` | string | Yes | The unique identifier of the subscription to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Transaction

**Slug:** `CREEM_GET_TRANSACTION`

Retrieve a single Creem transaction by ID, including payment amounts, status, tax details, and associated resource IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `transaction_id` | string | Yes | The unique identifier of the transaction to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Affiliate Commissions

**Slug:** `CREEM_LIST_AFFILIATE_COMMISSIONS`

Retrieve one page of an affiliate's commissions, optionally filtered by pending, approved, or paid settlement status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status` | string ("pending" | "approved" | "paid") | No | Settlement status to include: pending while on hold, approved once cleared, or paid once settled by a payout. |
| `page_size` | integer | No | Number of commissions to return on this page. Must be at least 1. |
| `next_cursor` | string | No | Continuation cursor returned by the previous call; omit for the first page. |
| `affiliate_id` | string | Yes | Unique identifier of the affiliate whose commissions to list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Affiliates

**Slug:** `CREEM_LIST_AFFILIATES`

Retrieve one page of joined Creem affiliates with referral links, click and conversion counts, and lifetime commission. Invited affiliates who have not joined a program are not included.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Number of affiliates to return on this page. Must be at least 1. |
| `next_cursor` | string | No | Continuation cursor returned by the previous call. Omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Credit Account Entries

**Slug:** `CREEM_LIST_CREDIT_ACCOUNT_ENTRIES`

Experimental Creem API: retrieve one page of a credit account's credit and debit history, with forward or backward ID-based pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of entries to return on this page (1-100). |
| `account_id` | string | Yes | Unique identifier of the Creem credit account. |
| `next_cursor` | string | No | Forward continuation cursor returned by the previous call. Omit for the first page and when using ending_before. |
| `ending_before` | string | No | Entry ID before which to retrieve a page for backward pagination. |
| `starting_after` | string | No | Raw Creem entry ID after which to start the first forward page. Use next_cursor for subsequent pages. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Credit Accounts

**Slug:** `CREEM_LIST_CREDIT_ACCOUNTS`

Experimental Creem API: list customer credit accounts for the authenticated store, excluding system accounts. Returns one page at a time. The response and cursor contract may change while this API remains experimental.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of credit accounts to return (1-100). |
| `customer_id` | string | No | Filter credit accounts by their owner ID, such as a Creem customer ID. |
| `next_cursor` | string | No | Opaque forward continuation cursor returned by a previous call. Omit for the first page and do not combine with ending_before. |
| `ending_before` | string | No | Account ID to end before when requesting a page in backward order. |
| `starting_after` | string | No | Raw Creem account ID after which to start the first forward page. Use next_cursor for subsequent pages. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Customer Licenses

**Slug:** `CREEM_LIST_CUSTOMER_LICENSES`

Retrieve one page of license keys for a specific Creem customer. Returns pagination totals and an opaque cursor when another page is available.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Number of licenses to return on this page. Must be at least 1. |
| `customer_id` | string | Yes | Unique identifier of the customer whose licenses to list. |
| `next_cursor` | string | No | Continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Customer Orders

**Slug:** `CREEM_LIST_CUSTOMER_ORDERS`

Retrieve one page of orders for a specific customer, including monetary details, statuses, related resource IDs, and pagination totals.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Number of orders to return on this page. Must be at least 1. |
| `customer_id` | string | Yes | Unique identifier of the customer whose orders to retrieve. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Customers

**Slug:** `CREEM_LIST_CUSTOMERS`

Retrieve one page of customers, including customer details and pagination totals. Use next_cursor to continue through additional pages.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Number of customers to return on this page. Must be at least 1. |
| `next_cursor` | string | No | Continuation cursor returned by the previous call. Omit for the first page and pass it back unchanged to fetch the next page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Discounts

**Slug:** `CREEM_LIST_DISCOUNTS`

Search and retrieve one page of Creem discounts, optionally filtered by product, status, type, or creation date.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("percentage" | "fixed") | No | Filter discounts by type: percentage or fixed. |
| `status` | string ("active" | "deleted") | No | Filter discounts by status: active or deleted. |
| `page_size` | integer | No | Number of discounts to return on this page. Must be at least 1. |
| `product_id` | string | No | Filter discounts that apply to this product identifier. |
| `next_cursor` | string | No | Continuation cursor returned by the previous call. Omit for the first page. |
| `created_after` | string | No | Filter discounts created after this date. |
| `created_before` | string | No | Filter discounts created before this date. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List License Instances

**Slug:** `CREEM_LIST_LICENSE_INSTANCES`

Retrieve one page of activated instances for a Creem license. Use an instance ID from the response when deactivating a specific instance.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Number of license instances to return on this page. Must be at least 1. |
| `license_id` | string | Yes | Unique identifier of the license whose activated instances to list. |
| `next_cursor` | string | No | Continuation cursor returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Products

**Slug:** `CREEM_LIST_PRODUCTS`

Search and retrieve one page of Creem products, optionally filtered by lifecycle status. Returns an opaque cursor when another page is available.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status` | string ("active" | "archived") | No | Filter products by lifecycle status: active or archived. |
| `page_size` | integer | No | Number of products to return on this page. Must be at least 1. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Subscriptions

**Slug:** `CREEM_LIST_SUBSCRIPTIONS`

Retrieve one page of Creem subscriptions across the store or for one customer, including product, customer, billing, transaction, and pagination details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Number of subscriptions to return on this page. Must be at least 1. |
| `customer_id` | string | No | Return only subscriptions belonging to this customer. Omit to list subscriptions across the store. |
| `next_cursor` | string | No | Continuation cursor returned by the previous call. Omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Transactions

**Slug:** `CREEM_LIST_TRANSACTIONS`

Search and retrieve one page of Creem payment transactions, optionally filtered by customer, order, or product.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | string | No | Filter transactions by order identifier. |
| `page_size` | integer | No | Number of transactions to return on this page. Must be at least 1. |
| `product_id` | string | No | Filter transactions by product identifier. |
| `customer_id` | string | No | Filter transactions by customer identifier. |
| `next_cursor` | string | No | Continuation cursor returned by the previous call. Omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Pause Subscription

**Slug:** `CREEM_PAUSE_SUBSCRIPTION`

Pause a Creem production subscription immediately or after its current billing period, stopping live billing while retaining it for later resumption. Confirm the subscription and timing before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `timing` | string ("immediate" | "end_of_period") | No | When to pause: immediate pauses now; end_of_period pauses after the current billing period. |
| `subscription_id` | string | Yes | The unique identifier of the subscription to pause. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Refund Payment

**Slug:** `CREEM_REFUND_PAYMENT`

Issue an irreversible full refund of a payment's entire remaining refundable amount using its transaction ID. Partial refunds are not supported. Confirm the transaction before calling. A `pending` or `requiresAction` response is non-terminal and means provider processing continues asynchronously.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `transaction_id` | string | Yes | Unique identifier of the payment transaction to refund. This issues an irreversible full refund of its entire remaining refundable amount; no partial amount can be specified. Confirm the transaction before calling. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Resume Subscription

**Slug:** `CREEM_RESUME_SUBSCRIPTION`

Resume a paused or scheduled-cancel Creem production subscription. This changes live subscription billing; confirm the subscription before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `subscription_id` | string | Yes | Unique identifier of the paused or scheduled-cancel subscription to resume. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reverse Credit Transaction

**Slug:** `CREEM_REVERSE_CREDIT_TRANSACTION`

Experimental Creem API: reverse a previous credit or debit in the connected production store by creating a new compensating transaction; the original transaction remains in the ledger. This is an irreversible live financial mutation. Confirm the account and transaction IDs before calling. The request does not accept an idempotency key, so verify the account ledger before retrying after a timeout, rate limit, or server error.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | string | Yes | ID of the credit account containing the original transaction. Confirm the production account before calling because the reversal changes its live balance. |
| `transaction_id` | string | Yes | ID of the previous credit or debit to reverse. Creem preserves that transaction and creates a new compensating transaction. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Screen Prompt

**Slug:** `CREEM_SCREEN_PROMPT`

Evaluate a text prompt against Creem content policies before generation. Warning: this endpoint is experimental and its request, response, or behavior may change without stability guarantees.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `prompt` | string | Yes | The text prompt to evaluate against content policies. |
| `external_id` | string | No | Optional identifier to associate with this moderation request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Unfreeze Credit Account

**Slug:** `CREEM_UNFREEZE_CREDIT_ACCOUNT`

Experimental Creem API: unfreeze a frozen credit account in the connected production store, allowing live credit and debit transactions again. Confirm the account ID before calling. Closed accounts and accounts that are not frozen cannot be unfrozen.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | string | Yes | Unique identifier of the frozen Creem credit account to reactivate. This changes a live production financial account and allows transactions again; confirm the account before calling. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Customer

**Slug:** `CREEM_UPDATE_CUSTOMER`

Update the name or metadata of an existing customer in the connected Creem production store. Only supplied fields change; provide at least one change.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New full name for the customer. Omit to leave the name unchanged. This field is required when metadata is omitted. |
| `metadata` | object | No | New metadata to associate with the customer. Omit to leave metadata unchanged. This field is required when name is omitted. |
| `customer_id` | string | Yes | ID of the customer to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Product

**Slug:** `CREEM_UPDATE_PRODUCT`

Update at least one field on a product in the connected Creem production store. Only supplied fields change; pricing, currency, billing, and tax changes affect future purchases, and changing the price creates a new default price.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New name of the product. |
| `price` | integer | No | New price in cents. It must be 0 for a free product or at least 100. Changing the price creates a new default price. |
| `currency` | string ("EUR" | "USD") | No | New currency: EUR or USD. |
| `tax_mode` | string ("inclusive" | "exclusive") | No | New tax calculation mode: inclusive or exclusive. |
| `image_url` | string | No | New URL of the product image. |
| `image_urls` | array | No | Ordered replacement image URLs (maximum 8). The first URL is the cover image and takes precedence over image_url. An empty list removes all images. |
| `product_id` | string | Yes | The ID of the product to update. |
| `description` | string | No | New description of the product. |
| `billing_type` | string ("recurring" | "onetime") | No | New billing method: recurring or onetime. |
| `billing_period` | string ("once" | "every-day" | "every-month" | "every-three-months" | "every-six-months" | "every-year") | No | New billing interval: once, every-day, every-month, every-three-months, every-six-months, or every-year. |
| `suggested_price` | integer | No | Suggested amount in cents when pay_what_you_want is enabled. |
| `pay_what_you_want` | boolean | No | Whether customers choose the price. Supported only for one-time products. |
| `default_success_url` | string | No | New redirect URL after a successful payment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Subscription

**Slug:** `CREEM_UPDATE_SUBSCRIPTION`

Update items, units, seats, or add-ons on a Creem production subscription. This changes live recurring billing; proration-charge-immediately can charge the customer immediately.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | Non-empty subscription items to update or create. An item without an id is created. Each item must provide product_id, price_id, or units. Changes to products, prices, or units can alter recurring billing. |
| `subscription_id` | string | Yes | Unique identifier of the subscription to update. |
| `update_behavior` | string ("proration-charge-immediately" | "proration-charge" | "proration-none") | No | How Creem applies billing changes. proration-charge-immediately can charge the customer immediately; proration-charge applies proration without an immediate charge; proration-none applies no proration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upgrade Subscription

**Slug:** `CREEM_UPGRADE_SUBSCRIPTION`

Upgrade a subscription to a different product or plan in Creem production. This changes live billing and may charge the customer: the default update behavior applies proration and can charge it immediately.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `product_id` | string | Yes | The unique identifier of the product or plan to upgrade to. |
| `subscription_id` | string | Yes | The unique identifier of the subscription to upgrade. |
| `update_behavior` | string ("proration-charge-immediately" | "proration-charge" | "proration-none") | No | How Creem handles proration for the plan change. The default, proration-charge-immediately, may immediately charge the customer. Choose the behavior deliberately before calling this production mutation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Validate License

**Slug:** `CREEM_VALIDATE_LICENSE`

Verify that a Creem license key is valid and active for a specific instance, including its activation status and expiration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `key` | string | Yes | License key to validate. |
| `instance_id` | string | Yes | ID of the specific license instance to validate. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |