Skip to main content
Creem logo
  • Category: payment processing
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 48
  • Triggers: 0
  • Slug: CREEM
  • Version: 20261101_00

Tools

Slug: CREEM_ACTIVATE_LICENSEActivate 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

string
required
License key to activate.
string
required
Label for the new device or instance in Creem.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_ARCHIVE_PRODUCTArchive 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

string
required
The unique ID of the product to archive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_CANCEL_SUBSCRIPTIONCancel 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

string ("immediate" | "end_of_period" | "store_default")
When to cancel: immediate cancels now, end_of_period cancels after the current billing period, and store_default uses the store’s billing setting.
string
required
Unique identifier of the subscription to cancel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_CLOSE_CREDIT_ACCOUNTExperimental 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

string
required
Unique identifier of the credit account to permanently close. Confirm the production account before calling because closure cannot be undone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_CREATE_CHECKOUTCreate 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

number
Number of product units in the order.
object
Customer data used to prefill the checkout page.
object
Checkout metadata as arbitrary key-value pairs.
string
required
ID of the product associated with the checkout session.
string
Identifier used to track this checkout request.
string
URL to redirect the customer to after checkout completes.
array
Deprecated. Use custom_fields instead. Custom fields to collect, up to 3.
integer
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.
array
Custom fields to collect from the customer, up to 3.
string
Discount code to prefill on the checkout page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_CREATE_CREDIT_ACCOUNTExperimental 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

string
Human-readable name for the credit account.
string
Label for the units held in the account.
string
required
Owner ID this credit account belongs to, such as a Creem customer ID.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_CREATE_CUSTOMERCreate a customer record in the connected Creem production store. This is a live production mutation: a successful call permanently adds a customer.

Input Parameters

string
required
Full name of the customer.
string
required
Email address for the customer.
object
Additional metadata to associate with the customer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_CREATE_DISCOUNTCreate 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

string
Optional customer-facing discount code. Creem generates one when omitted.
string
required
Name of the discount.
string ("percentage" | "fixed")
required
Discount pricing discriminator. Use fixed with amount and currency, or percentage with percentage. The two pricing forms cannot be combined.
integer
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.
string
Currency for amount. Required only when type is fixed.
string ("forever" | "once" | "repeating")
required
How long the discount applies: forever, once, or repeating.
number
Live percentage reduction. Required only when type is percentage; review it carefully because this changes customer pricing.
string
ISO 8601 date and time when the discount expires.
number
Maximum number of times the discount may be redeemed.
number
Number of months the discount applies. Required when duration is repeating; usable only with subscription products, and rejected for any other duration.
array
required
Product IDs whose live prices this discount may reduce.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_CREATE_PRODUCTCreate 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_CREDIT_ACCOUNTExperimental 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

string
required
Credit amount represented as a string for large-number safety. Confirm the amount and account before calling.
string
required
Your reference ID linking this ledger transaction to an event in your system, such as an order or campaign ID.
string
required
Unique ID of the credit account to fund. Confirm the production account before calling because this creates a live ledger credit.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_DEACTIVATE_LICENSEDeactivate 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_DEBIT_ACCOUNTExperimental 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

string
required
Credit amount to deduct, represented as a string for bigint safety. Confirm the amount before calling.
string
required
Caller-defined reference linking this debit to an event in the caller’s system, such as an order or campaign ID.
string
required
Unique ID of the production credit account to debit. Confirm the account before calling because this creates a live ledger deduction.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_DELETE_DISCOUNTPermanently 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

string
required
Unique identifier of the discount to permanently delete. Confirm the ID before calling because deletion cannot be undone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_FREEZE_CREDIT_ACCOUNTExperimental 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

string
required
Unique ID of the credit account to freeze. Confirm the production account before calling because freezing it prevents new transactions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_GET_AFFILIATERetrieve a single affiliate by ID, including referral link, click and conversion counts, and lifetime commission.

Input Parameters

string
required
The unique identifier of the affiliate to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_GET_CHECKOUTRetrieve a Creem checkout session by ID, including its status, product, customer, payment relationships, issued licenses, and metadata.

Input Parameters

string
required
The unique identifier of the checkout session to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_GET_CREDIT_ACCOUNTExperimental Creem API: retrieve a customer credits account by its unique identifier, including its owner, unit label, status, and timestamps.

Input Parameters

string
required
The unique identifier of the customer credits account to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_GET_CREDIT_ACCOUNT_BALANCEExperimental Creem API: retrieve a credit account’s current projected balance or its balance at an optional historical timestamp.

Input Parameters

string
required
Unique identifier of the Creem credit account.
string
Optional ISO 8601 timestamp at which to compute the historical balance. Omit it to retrieve the current projected balance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_GET_CUSTOMERRetrieve one Creem customer by exactly one lookup field: customer_id or email. Returns the customer’s profile and metadata.

Input Parameters

string
The customer’s email address. Provide this or customer_id, but not both.
string
The unique identifier of the customer. Provide this or email, but not both.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_GET_DISCOUNTRetrieve Creem discount details by exactly one lookup field: discount_id or discount_code. Returns usage limits, expiration, and discount amount.

Input Parameters

string
The unique identifier of the discount. Provide exactly one of discount_id or discount_code.
string
The unique discount code. Provide exactly one of discount_id or discount_code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_GET_PRODUCTRetrieve a single Creem product by its unique identifier.

Input Parameters

string
required
The unique identifier of the product to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_GET_STORE_METRICSRetrieve Creem store counts, revenue, and monthly recurring revenue in integer cents, optionally filtered and grouped by a date range.

Input Parameters

string ("EUR" | "USD")
required
Currency in which Creem returns revenue metrics.
integer
End of the date range as a Unix timestamp in milliseconds. Provide it with start_date; both dates are required when interval is set.
string ("day" | "week" | "month")
Optional time-series bucket size. Requires both start_date and end_date and adds period-level revenue metrics to the response.
integer
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_GET_SUBSCRIPTIONRetrieve a Creem subscription by ID, including its status, billing cycle, customer, product, items, last transaction details, and timestamps.

Input Parameters

string
required
The unique identifier of the subscription to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_GET_TRANSACTIONRetrieve a single Creem transaction by ID, including payment amounts, status, tax details, and associated resource IDs.

Input Parameters

string
required
The unique identifier of the transaction to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_LIST_AFFILIATE_COMMISSIONSRetrieve one page of an affiliate’s commissions, optionally filtered by pending, approved, or paid settlement status.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_LIST_AFFILIATESRetrieve 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

integer
Number of affiliates to return on this page. Must be at least 1.
string
Continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_LIST_CREDIT_ACCOUNT_ENTRIESExperimental Creem API: retrieve one page of a credit account’s credit and debit history, with forward or backward ID-based pagination.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_LIST_CREDIT_ACCOUNTSExperimental 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_LIST_CUSTOMER_LICENSESRetrieve one page of license keys for a specific Creem customer. Returns pagination totals and an opaque cursor when another page is available.

Input Parameters

integer
Number of licenses to return on this page. Must be at least 1.
string
required
Unique identifier of the customer whose licenses to list.
string
Continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_LIST_CUSTOMER_ORDERSRetrieve one page of orders for a specific customer, including monetary details, statuses, related resource IDs, and pagination totals.

Input Parameters

integer
Number of orders to return on this page. Must be at least 1.
string
required
Unique identifier of the customer whose orders to retrieve.
string
Continuation cursor returned by a previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_LIST_CUSTOMERSRetrieve one page of customers, including customer details and pagination totals. Use next_cursor to continue through additional pages.

Input Parameters

integer
Number of customers to return on this page. Must be at least 1.
string
Continuation cursor returned by the previous call. Omit for the first page and pass it back unchanged to fetch the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_LIST_DISCOUNTSSearch and retrieve one page of Creem discounts, optionally filtered by product, status, type, or creation date.

Input Parameters

string ("percentage" | "fixed")
Filter discounts by type: percentage or fixed.
string ("active" | "deleted")
Filter discounts by status: active or deleted.
integer
Number of discounts to return on this page. Must be at least 1.
string
Filter discounts that apply to this product identifier.
string
Continuation cursor returned by the previous call. Omit for the first page.
string
Filter discounts created after this date.
string
Filter discounts created before this date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_LIST_LICENSE_INSTANCESRetrieve one page of activated instances for a Creem license. Use an instance ID from the response when deactivating a specific instance.

Input Parameters

integer
Number of license instances to return on this page. Must be at least 1.
string
required
Unique identifier of the license whose activated instances to list.
string
Continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_LIST_PRODUCTSSearch and retrieve one page of Creem products, optionally filtered by lifecycle status. Returns an opaque cursor when another page is available.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_LIST_SUBSCRIPTIONSRetrieve one page of Creem subscriptions across the store or for one customer, including product, customer, billing, transaction, and pagination details.

Input Parameters

integer
Number of subscriptions to return on this page. Must be at least 1.
string
Return only subscriptions belonging to this customer. Omit to list subscriptions across the store.
string
Continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_LIST_TRANSACTIONSSearch and retrieve one page of Creem payment transactions, optionally filtered by customer, order, or product.

Input Parameters

string
Filter transactions by order identifier.
integer
Number of transactions to return on this page. Must be at least 1.
string
Filter transactions by product identifier.
string
Filter transactions by customer identifier.
string
Continuation cursor returned by the previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_PAUSE_SUBSCRIPTIONPause 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

string ("immediate" | "end_of_period")
When to pause: immediate pauses now; end_of_period pauses after the current billing period.
string
required
The unique identifier of the subscription to pause.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_REFUND_PAYMENTIssue 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

string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_RESUME_SUBSCRIPTIONResume a paused or scheduled-cancel Creem production subscription. This changes live subscription billing; confirm the subscription before calling.

Input Parameters

string
required
Unique identifier of the paused or scheduled-cancel subscription to resume.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_REVERSE_CREDIT_TRANSACTIONExperimental 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

string
required
ID of the credit account containing the original transaction. Confirm the production account before calling because the reversal changes its live balance.
string
required
ID of the previous credit or debit to reverse. Creem preserves that transaction and creates a new compensating transaction.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_SCREEN_PROMPTEvaluate 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

string
required
The text prompt to evaluate against content policies.
string
Optional identifier to associate with this moderation request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_UNFREEZE_CREDIT_ACCOUNTExperimental 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

string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_UPDATE_CUSTOMERUpdate 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

string
New full name for the customer. Omit to leave the name unchanged. This field is required when metadata is omitted.
object
New metadata to associate with the customer. Omit to leave metadata unchanged. This field is required when name is omitted.
string
required
ID of the customer to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_UPDATE_PRODUCTUpdate 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

string
New name of the product.
integer
New price in cents. It must be 0 for a free product or at least 100. Changing the price creates a new default price.
string ("EUR" | "USD")
New currency: EUR or USD.
string ("inclusive" | "exclusive")
New tax calculation mode: inclusive or exclusive.
string
New URL of the product image.
array
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.
string
required
The ID of the product to update.
string
New description of the product.
string ("recurring" | "onetime")
New billing method: recurring or onetime.
string ("once" | "every-day" | "every-month" | "every-three-months" | "every-six-months" | "every-year")
New billing interval: once, every-day, every-month, every-three-months, every-six-months, or every-year.
integer
Suggested amount in cents when pay_what_you_want is enabled.
boolean
Whether customers choose the price. Supported only for one-time products.
string
New redirect URL after a successful payment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_UPDATE_SUBSCRIPTIONUpdate 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

array
required
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.
string
required
Unique identifier of the subscription to update.
string ("proration-charge-immediately" | "proration-charge" | "proration-none")
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_UPGRADE_SUBSCRIPTIONUpgrade 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

string
required
The unique identifier of the product or plan to upgrade to.
string
required
The unique identifier of the subscription to upgrade.
string ("proration-charge-immediately" | "proration-charge" | "proration-none")
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CREEM_VALIDATE_LICENSEVerify that a Creem license key is valid and active for a specific instance, including its activation status and expiration.

Input Parameters

string
required
License key to validate.
string
required
ID of the specific license instance to validate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not