var Component=(()=>{var u=Object.create;var c=Object.defineProperty;var E=Object.getOwnPropertyDescriptor;var y=Object.getOwnPropertyNames;var b=Object.getPrototypeOf,f=Object.prototype.hasOwnProperty;var _=(n,i)=>()=>(i||n((i={exports:{}}).exports,i),i.exports),C=(n,i)=>{for(var r in i)c(n,r,{get:i[r],enumerable:!0})},o=(n,i,r,l)=>{if(i&&typeof i=="object"||typeof i=="function")for(let t of y(i))!f.call(n,t)&&t!==r&&c(n,t,{get:()=>i[t],enumerable:!(l=E(i,t))||l.enumerable});return n};var w=(n,i,r)=>(r=n!=null?u(b(n)):{},o(i||!n||!n.__esModule?c(r,"default",{value:n,enumerable:!0}):r,n)),v=n=>o(c({},"__esModule",{value:!0}),n);var g=_((F,p)=>{p.exports=_jsx_runtime});var A={};C(A,{default:()=>m});var e=w(g());function k(n){let i={a:"a",code:"code",h2:"h2",h3:"h3",img:"img",li:"li",p:"p",pre:"pre",span:"span",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...n.components},{Callout:r,File:l,Files:t,Folder:a,Step:s,Steps:d}=i;return r||h("Callout",!0),l||h("File",!0),t||h("Files",!0),a||h("Folder",!0),s||h("Step",!0),d||h("Steps",!0),(0,e.jsxs)(e.Fragment,{children:[(0,e.jsxs)(i.p,{children:["MuseMVP integrates ",(0,e.jsx)(i.a,{href:"https://creem.io/",children:"Creem"})," as one of its payment gateways, offering a payment solution for indie developers without a US entity. Through the unified Muse Billing module, it shares the same business logic and database tables as Stripe. This guide explains how to configure the Creem gateway and understand how it works."]}),` `,(0,e.jsxs)(d,{children:[(0,e.jsxs)(s,{children:[(0,e.jsxs)(i.h2,{id:"get-muse_creem_gateway_api_key",children:["Get ",(0,e.jsx)(i.code,{children:"MUSE_CREEM_GATEWAY_API_KEY"})]}),(0,e.jsx)(i.p,{children:"Before deploying or running locally, configure the required secrets."}),(0,e.jsx)(e.Fragment,{children:(0,e.jsx)(i.pre,{className:"shiki shiki-themes github-light github-dark",style:{"--shiki-light":"#24292e","--shiki-dark":"#e1e4e8","--shiki-light-bg":"#fff","--shiki-dark-bg":"#24292e"},tabIndex:"0",icon:'',children:(0,e.jsxs)(i.code,{children:[(0,e.jsx)(i.span,{className:"line",children:(0,e.jsx)(i.span,{style:{"--shiki-light":"#6A737D","--shiki-dark":"#6A737D"},children:"# Creem API key (starts with `creem_`)"})}),` `,(0,e.jsxs)(i.span,{className:"line",children:[(0,e.jsx)(i.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:"MUSE_CREEM_GATEWAY_API_KEY"}),(0,e.jsx)(i.span,{style:{"--shiki-light":"#D73A49","--shiki-dark":"#F97583"},children:"="}),(0,e.jsx)(i.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:'"creem_test_xxx1"'})]}),` `,(0,e.jsx)(i.span,{className:"line",children:(0,e.jsx)(i.span,{style:{"--shiki-light":"#6A737D","--shiki-dark":"#6A737D"},children:"# Environment: sandbox (testing) or production"})}),` `,(0,e.jsxs)(i.span,{className:"line",children:[(0,e.jsx)(i.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:"MUSE_CREEM_GATEWAY_ENV"}),(0,e.jsx)(i.span,{style:{"--shiki-light":"#D73A49","--shiki-dark":"#F97583"},children:"="}),(0,e.jsx)(i.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:'"sandbox"'})]})]})})}),(0,e.jsxs)(i.p,{children:["Retrieve your API key from the ",(0,e.jsx)(i.a,{href:"https://creem.io/dashboard",children:"Creem Dashboard"}),"."]}),(0,e.jsx)(i.p,{children:(0,e.jsx)(i.img,{src:"/images/docs/snipaste20260301124149.png",alt:"Creem"})}),(0,e.jsx)(r,{type:"warn",title:"Key Security",children:(0,e.jsxs)(i.p,{children:[(0,e.jsx)(i.code,{children:"MUSE_CREEM_GATEWAY_API_KEY"})," is server-side only; never expose it to the client or version control."]})})]}),(0,e.jsxs)(s,{children:[(0,e.jsxs)(i.h2,{id:"get-muse_creem_gateway_webhook_secret",children:["Get ",(0,e.jsx)(i.code,{children:"MUSE_CREEM_GATEWAY_WEBHOOK_SECRET"})]}),(0,e.jsx)(e.Fragment,{children:(0,e.jsx)(i.pre,{className:"shiki shiki-themes github-light github-dark",style:{"--shiki-light":"#24292e","--shiki-dark":"#e1e4e8","--shiki-light-bg":"#fff","--shiki-dark-bg":"#24292e"},tabIndex:"0",icon:'',children:(0,e.jsxs)(i.code,{children:[(0,e.jsx)(i.span,{className:"line",children:(0,e.jsx)(i.span,{style:{"--shiki-light":"#6A737D","--shiki-dark":"#6A737D"},children:"# Webhook signing secret (starts with `whsec_`)"})}),` `,(0,e.jsxs)(i.span,{className:"line",children:[(0,e.jsx)(i.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:"MUSE_CREEM_GATEWAY_WEBHOOK_SECRET"}),(0,e.jsx)(i.span,{style:{"--shiki-light":"#D73A49","--shiki-dark":"#F97583"},children:"="}),(0,e.jsx)(i.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:'"whsec_xxx2"'})]})]})})}),(0,e.jsx)(i.p,{children:(0,e.jsx)(i.img,{src:"/images/docs/snipaste20260301124327.png",alt:"Creem"})}),(0,e.jsx)(i.p,{children:(0,e.jsx)(i.img,{src:"/images/docs/snipaste20260301124429.png",alt:"Creem"})}),(0,e.jsx)(i.p,{children:"In the Creem Dashboard, create a Webhook and set the callback URL to:"}),(0,e.jsx)(e.Fragment,{children:(0,e.jsx)(i.pre,{className:"shiki shiki-themes github-light github-dark",style:{"--shiki-light":"#24292e","--shiki-dark":"#e1e4e8","--shiki-light-bg":"#fff","--shiki-dark-bg":"#24292e"},tabIndex:"0",icon:'',children:(0,e.jsx)(i.code,{children:(0,e.jsx)(i.span,{className:"line",children:(0,e.jsx)(i.span,{children:"https://example.com/api/muse-billing/notify/muse_creem"})})})})}),(0,e.jsx)(i.p,{children:"Select the event types to listen for (or all):"}),(0,e.jsxs)(i.ul,{children:[` `,(0,e.jsx)(i.li,{children:(0,e.jsx)(i.code,{children:"checkout.completed"})}),` `,(0,e.jsx)(i.li,{children:(0,e.jsx)(i.code,{children:"subscription.active"})}),` `,(0,e.jsx)(i.li,{children:(0,e.jsx)(i.code,{children:"subscription.canceled"})}),` `,(0,e.jsx)(i.li,{children:(0,e.jsx)(i.code,{children:"subscription.updated"})}),` `]}),(0,e.jsx)(i.p,{children:(0,e.jsx)(i.img,{src:"/images/docs/snipaste20260301124540.png",alt:"Creem"})}),(0,e.jsxs)(i.p,{children:["Copy the Webhook secret into ",(0,e.jsx)(i.code,{children:"MUSE_CREEM_GATEWAY_WEBHOOK_SECRET"}),"."]}),(0,e.jsx)(r,{type:"warn",title:"Key Security",children:(0,e.jsxs)(i.p,{children:[(0,e.jsx)(i.code,{children:"MUSE_CREEM_GATEWAY_WEBHOOK_SECRET"})," is server-side only; never expose it to the client or version control."]})})]}),(0,e.jsxs)(s,{children:[(0,e.jsx)(i.h2,{id:"create-products-and-get-product-ids",children:"Create Products and Get Product IDs"}),(0,e.jsxs)(i.p,{children:["Product IDs come from ",(0,e.jsx)(i.code,{children:"config.payments.productCatalog.*.gatewayProductIds.muse_creem"})," in ",(0,e.jsx)(i.code,{children:"src/config/index.ts"})," by default, and can be overridden via environment variables:"]}),(0,e.jsx)(e.Fragment,{children:(0,e.jsx)(i.pre,{className:"shiki shiki-themes github-light github-dark",style:{"--shiki-light":"#24292e","--shiki-dark":"#e1e4e8","--shiki-light-bg":"#fff","--shiki-dark-bg":"#24292e"},tabIndex:"0",icon:'',children:(0,e.jsxs)(i.code,{children:[(0,e.jsx)(i.span,{className:"line",children:(0,e.jsx)(i.span,{style:{"--shiki-light":"#6A737D","--shiki-dark":"#6A737D"},children:"# Pro monthly subscription price ID"})}),` `,(0,e.jsxs)(i.span,{className:"line",children:[(0,e.jsx)(i.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:"NEXT_PUBLIC_MUSE_CREEM_PRICE_PRO_MONTHLY_ID"}),(0,e.jsx)(i.span,{style:{"--shiki-light":"#D73A49","--shiki-dark":"#F97583"},children:"="}),(0,e.jsx)(i.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:'"prod_xxx1"'})]}),` `,(0,e.jsx)(i.span,{className:"line",children:(0,e.jsx)(i.span,{style:{"--shiki-light":"#6A737D","--shiki-dark":"#6A737D"},children:"# Pro yearly subscription price ID"})}),` `,(0,e.jsxs)(i.span,{className:"line",children:[(0,e.jsx)(i.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:"NEXT_PUBLIC_MUSE_CREEM_PRICE_PRO_YEARLY_ID"}),(0,e.jsx)(i.span,{style:{"--shiki-light":"#D73A49","--shiki-dark":"#F97583"},children:"="}),(0,e.jsx)(i.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:'"prod_xxx2"'})]}),` `,(0,e.jsx)(i.span,{className:"line",children:(0,e.jsx)(i.span,{style:{"--shiki-light":"#6A737D","--shiki-dark":"#6A737D"},children:"# Lifetime one-time price ID"})}),` `,(0,e.jsxs)(i.span,{className:"line",children:[(0,e.jsx)(i.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:"NEXT_PUBLIC_MUSE_CREEM_PRICE_LIFETIME_ID"}),(0,e.jsx)(i.span,{style:{"--shiki-light":"#D73A49","--shiki-dark":"#F97583"},children:"="}),(0,e.jsx)(i.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:'"prod_xxx3"'})]})]})})}),(0,e.jsx)(i.p,{children:(0,e.jsx)(i.img,{src:"/images/docs/snipaste20260301124814.png",alt:"Creem"})}),(0,e.jsxs)(i.p,{children:["After creating the corresponding products in the Creem Dashboard, fill in the product IDs via the environment variables above or in ",(0,e.jsx)(i.code,{children:"src/config/index.ts"}),"."]})]})]}),` `,(0,e.jsx)(i.h2,{id:"local-development-testing",children:"Local Development Testing"}),` `,(0,e.jsxs)(d,{children:[(0,e.jsxs)(s,{children:[(0,e.jsx)(i.h3,{id:"download-ngrok",children:"Download Ngrok"}),(0,e.jsxs)(i.p,{children:["Ngrok (",(0,e.jsx)(i.a,{href:"https://dashboard.ngrok.com/get-started/setup/windows",children:"https://dashboard.ngrok.com/get-started/setup/windows"}),") is a reverse proxy tool that exposes your local development server to the public internet."]}),(0,e.jsx)(i.p,{children:(0,e.jsx)(i.img,{src:"/images/docs/snipaste20260301120417.png",alt:"Ngrok"})})]}),(0,e.jsxs)(s,{children:[(0,e.jsx)(i.h3,{id:"run",children:"Run"}),(0,e.jsx)(e.Fragment,{children:(0,e.jsx)(i.pre,{className:"shiki shiki-themes github-light github-dark",style:{"--shiki-light":"#24292e","--shiki-dark":"#e1e4e8","--shiki-light-bg":"#fff","--shiki-dark-bg":"#24292e"},tabIndex:"0",icon:'',children:(0,e.jsx)(i.code,{children:(0,e.jsxs)(i.span,{className:"line",children:[(0,e.jsx)(i.span,{style:{"--shiki-light":"#6F42C1","--shiki-dark":"#B392F0"},children:"ngrok"}),(0,e.jsx)(i.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:" http"}),(0,e.jsx)(i.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:" 3000"})]})})})}),(0,e.jsx)(i.p,{children:(0,e.jsx)(i.img,{src:"/images/docs/snipaste20260301120418.png",alt:"Ngrok"})}),(0,e.jsx)(r,{type:"info",title:"Callback Domain",children:(0,e.jsx)(i.p,{children:"Use the terminal domain shown above as the callback URL in your Webhook configuration."})})]}),(0,e.jsxs)(s,{children:[(0,e.jsx)(i.h3,{id:"switch-to-sandbox-environment",children:"Switch to Sandbox Environment"}),(0,e.jsxs)(i.p,{children:["Ensure ",(0,e.jsx)(i.code,{children:"MUSE_CREEM_GATEWAY_ENV"})," is set to ",(0,e.jsx)(i.code,{children:"sandbox"})," and use Creem's test mode in the Dashboard to run payment tests."]}),(0,e.jsx)(r,{type:"info",title:"Test Mode",children:(0,e.jsx)(i.p,{children:"Payments in the Creem sandbox environment do not result in real charges, making it safe for local testing of subscription and one-time purchase flows."})})]})]}),` `,(0,e.jsx)(i.h2,{id:"how-it-works",children:"How It Works"}),` `,(0,e.jsx)(i.p,{children:"Learn how Muse Billing integrates Creem into the system."}),` `,(0,e.jsx)(i.h3,{id:"integration-files",children:"Integration Files"}),` `,(0,e.jsx)(t,{children:(0,e.jsxs)(a,{name:"Key Files",defaultOpen:!0,children:[(0,e.jsx)(l,{name:"src/modules/muse-billing/lib/gateways/muse-creem-gateway.ts"}),(0,e.jsx)(l,{name:"src/modules/muse-billing/lib/orchestrator.ts"}),(0,e.jsx)(l,{name:"src/backend/api/routes/muse-billing/router.ts"})]})}),` `,(0,e.jsxs)(i.table,{children:[(0,e.jsx)(i.thead,{children:(0,e.jsxs)(i.tr,{children:[(0,e.jsx)(i.th,{children:"File"}),(0,e.jsx)(i.th,{children:"Purpose"})]})}),(0,e.jsxs)(i.tbody,{children:[(0,e.jsxs)(i.tr,{children:[(0,e.jsx)(i.td,{children:(0,e.jsx)(i.code,{children:"muse-creem-gateway.ts"})}),(0,e.jsx)(i.td,{children:"Creem gateway implementation: launch, Webhook parsing, contract sync."})]}),(0,e.jsxs)(i.tr,{children:[(0,e.jsx)(i.td,{children:(0,e.jsx)(i.code,{children:"orchestrator.ts"})}),(0,e.jsx)(i.td,{children:"Billing orchestration layer: launch, customer-hub, Webhook dispatch."})]}),(0,e.jsxs)(i.tr,{children:[(0,e.jsx)(i.td,{children:(0,e.jsx)(i.code,{children:"router.ts"})}),(0,e.jsxs)(i.td,{children:["API routes: exposes ",(0,e.jsx)(i.code,{children:"/api/muse-billing/*"})," endpoints."]})]})]})]}),` `,(0,e.jsx)(i.h3,{id:"core-workflow",children:"Core Workflow"}),` `,(0,e.jsx)(i.p,{children:"The action flow for payment and accessing the Customer Hub:"}),` `,(0,e.jsxs)(d,{children:[(0,e.jsx)(s,{children:(0,e.jsxs)(i.p,{children:["Frontend calls ",(0,e.jsx)(i.code,{children:"POST /api/muse-billing/launch"})," with ",(0,e.jsx)(i.code,{children:"productId"}),", optional ",(0,e.jsx)(i.code,{children:"gatewayId"})," (defaults to orchestrator selection), etc."]})}),(0,e.jsx)(s,{children:(0,e.jsxs)(i.p,{children:["Server resolves the Creem price ID from the ",(0,e.jsx)(i.code,{children:"config.payments.productCatalog"})," mapping."]})}),(0,e.jsx)(s,{children:(0,e.jsxs)(i.p,{children:["Creem returns ",(0,e.jsx)(i.code,{children:"launchUrl"})," and ",(0,e.jsx)(i.code,{children:"launchSessionId"}),"; frontend redirects to the Creem-hosted checkout page."]})}),(0,e.jsx)(s,{children:(0,e.jsx)(i.p,{children:"After payment, Creem sends a webhook; the server verifies the signature and syncs contract lifecycle and access window to the database."})}),(0,e.jsx)(s,{children:(0,e.jsxs)(i.p,{children:["When the user needs to access the platform portal, call ",(0,e.jsx)(i.code,{children:"POST /api/muse-billing/customer-hub"})," to get a redirect link to the Creem Customer Portal for managing subscriptions or downloading receipts."]})})]}),` `,(0,e.jsx)(i.h2,{id:"related-docs",children:"Related Docs"}),` `,(0,e.jsxs)(i.ul,{children:[` `,(0,e.jsxs)(i.li,{children:[(0,e.jsx)(i.a,{href:"/en/docs/muse-billing/muse-stripe-gateway",children:"Stripe Payment Gateway"})," \u2014 Alternative payment gateway"]}),` `,(0,e.jsxs)(i.li,{children:[(0,e.jsx)(i.a,{href:"/en/docs/quick-build/basic-configuration",children:"Basic Configuration"})," \u2014 Pricing and product ID configuration"]}),` `]})]})}function m(n={}){let{wrapper:i}=n.components||{};return i?(0,e.jsx)(i,{...n,children:(0,e.jsx)(k,{...n})}):k(n)}function h(n,i){throw new Error("Expected "+(i?"component":"object")+" `"+n+"` to be defined: you likely forgot to import, pass, or provide it.")}return v(A);})(); ;return Component;

Creem

On this page