Click the base URL in the API playground and select the Sandbox host for test data or the Production host for live data. Use credentials from the same environment.
The Server API Key obtained from the kelviq application. Pass as a Bearer token in the Authorization header. Example: 'Authorization: Bearer YOUR_API_KEY'
The customer's email address. Email addresses do not have to be unique. More than one customer record can use the same email if each record has a different customerId.
{"docsConfig":{"theme":"palm","$schema":"https://mintlify.com/docs.json","name":"Kelviq Documentation","colors":{"primary":"#FF5722","light":"#FF8C66","dark":"#DC4100"},"logo":{"light":"https://mintcdn.com/kelviq/uM9r7iYtQz8T7tpP/logo/light.svg?fit=max\u0026auto=format\u0026n=uM9r7iYtQz8T7tpP\u0026q=85\u0026s=0f4bd30f554a25a8966fd41fa354e383","dark":"https://mintcdn.com/kelviq/uM9r7iYtQz8T7tpP/logo/dark.svg?fit=max\u0026auto=format\u0026n=uM9r7iYtQz8T7tpP\u0026q=85\u0026s=60c3bcda92b26dcf21589e5127d32e73"},"favicon":"https://mintcdn.com/kelviq/KXQ8Q-ykiBg_L9SN/favicon.svg?fit=max\u0026auto=format\u0026n=KXQ8Q-ykiBg_L9SN\u0026q=85\u0026s=26050b23a9faed1f3509a82c76962699","navbar":{"links":[{"href":"mailto:hi@kelviq.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.kelviq.com"}},"footer":{"socials":{"x":"https://x.com/kelviqcom","github":"https://github.com/kelviq","linkedin":"https://www.linkedin.com/company/kelviq"}},"integrations":{"posthog":{"apiKey":"phc_SG5oh2LfDgDWOpoTingeHcyUWSiQBxgGhYgkfNUv5Qb","apiHost":"https://d.kelviq.com"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"kelviq","hasAudioNarration":false,"actualSubdomain":"kelviq","customDomains":["docs.kelviq.com"],"gitSource":{"type":"github","owner":"kelviq","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae2f2008efcee3434fb7313","collectionId":"46284ef6-d5af-4a13-b3ba-371b72f0a129","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae2f2008efcee3434fb7313"},"entitlements":{},"buildId":"6ae58c033badfbce406bb380","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"API Reference","count":81},{"language":"default","tag":"API Documentation","count":79},{"language":"default","tag":"Documentation","count":72},{"language":"default","tag":"Product catalog","count":19},{"language":"default","tag":"SDKs","count":11},{"language":"default","tag":"Checkout","count":10},{"language":"default","tag":"Plans","count":9},{"language":"default","tag":"Pricing models","count":8},{"language":"default","tag":"Subscriptions","count":8},{"language":"default","tag":"Legal","count":7}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"table{width:100%!important;display:table!important}td,th{white-space:normal}td code,th code{white-space:nowrap}table tr th{text-align:left}.nav-anchor{margin-bottom:0!important;padding-top:.375rem!important;padding-bottom:.375rem!important;padding-right:.75rem!important;font-weight:400!important;line-height:1.25rem;gap:0!important}.nav-anchor[data-changelog-active=true]{color:rgb(var(--primary, 255 87 34))!important}.dark .nav-anchor[data-changelog-active=true]{color:rgb(var(--primary-light, 255 140 102))!important}.nav-anchor[data-changelog-active=false]{color:rgb(75 85 99)!important}.dark .nav-anchor[data-changelog-active=false]{color:rgb(166 161 159)!important}.nav-anchor>svg,body[data-changelog-page] .sidebar-group-header,body[data-changelog-page] ul.sidebar-group{display:none!important}body[data-changelog-page] ul:has(>li>a.nav-anchor)::before{content:\"Changelog\";display:block;padding-left:1rem;margin-bottom:.625rem;font-size:.875rem;font-weight:500;line-height:1.25rem;color:rgb(var(--gray-900, 30 25 23))}.dark body[data-changelog-page] ul:has(>li>a.nav-anchor)::before,body[data-changelog-page].dark ul:has(>li>a.nav-anchor)::before{color:#e6e1df}img.pm-logo{display:inline-block!important;height:20px!important;width:auto!important;margin:0 6px 0 0!important;vertical-align:-5px;border-radius:3px}td:has(>img.pm-logo){white-space:nowrap}#content-area h1,#header h1{letter-spacing:-.02em}#content-area h2{letter-spacing:-.01em}#content-area .frame img,#content-area [data-name=frame] img{width:100%;height:auto!important}@media (min-width:1024px){#sidebar-content:not(.w-16):not(.w-\\[4rem\\]){width:19rem!important;min-width:19rem!important;flex-shrink:0!important}}.sidebar-group-header:has(svg,.sidebar-group-icon)~ul.sidebar-group{margin-left:24px}img.sidebar-group-icon{object-position:-9999px 0;-webkit-mask-size:contain;mask-size:contain;-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;-webkit-mask-position:center;mask-position:center;background-color:rgb(120 113 108)}html.dark img.sidebar-group-icon{background-color:rgb(140 135 132)}img.sidebar-group-icon[src$=\"/icons/book-open.svg\"]{-webkit-mask-image:url(/icons/book-open.svg);mask-image:url(/icons/book-open.svg)}img.sidebar-group-icon[src$=\"/icons/box.svg\"]{-webkit-mask-image:url(/icons/box.svg);mask-image:url(/icons/box.svg)}img.sidebar-group-icon[src$=\"/icons/credit-card.svg\"]{-webkit-mask-image:url(/icons/credit-card.svg);mask-image:url(/icons/credit-card.svg)}img.sidebar-group-icon[src$=\"/icons/gavel.svg\"]{-webkit-mask-image:url(/icons/gavel.svg);mask-image:url(/icons/gavel.svg)}img.sidebar-group-icon[src$=\"/icons/gear.svg\"]{-webkit-mask-image:url(/icons/gear.svg);mask-image:url(/icons/gear.svg)}img.sidebar-group-icon[src$=\"/icons/receipt.svg\"]{-webkit-mask-image:url(/icons/receipt.svg);mask-image:url(/icons/receipt.svg)}img.sidebar-group-icon[src$=\"/icons/rocket.svg\"]{-webkit-mask-image:url(/icons/rocket.svg);mask-image:url(/icons/rocket.svg)}img.sidebar-group-icon[src$=\"/icons/shield-check.svg\"]{-webkit-mask-image:url(/icons/shield-check.svg);mask-image:url(/icons/shield-check.svg)}img.sidebar-group-icon[src$=\"/icons/sparkle.svg\"]{-webkit-mask-image:url(/icons/sparkle.svg);mask-image:url(/icons/sparkle.svg)}img.sidebar-group-icon[src$=\"/icons/tag.svg\"]{-webkit-mask-image:url(/icons/tag.svg);mask-image:url(/icons/tag.svg)}img.sidebar-group-icon[src$=\"/icons/user.svg\"]{-webkit-mask-image:url(/icons/user.svg);mask-image:url(/icons/user.svg)}img.sidebar-group-icon[src$=\"/icons/wallet.svg\"]{-webkit-mask-image:url(/icons/wallet.svg);mask-image:url(/icons/wallet.svg)}#content-area:has(.kq-home),#content-area:has(.kq-home) .mdx-content,:has(>.kq-home){max-width:none!important}.kq-home{width:100%;max-width:1080px;margin:0 auto;padding:48px 24px 120px;container-type:inline-size;container-name:kqhome}@media (max-width:560px){.kq-home{padding:32px 16px 64px}}.kq-hero2{display:grid;grid-template-columns:minmax(0,1.25fr) minmax(0,1fr);gap:32px;align-items:center;padding:8px 0 40px}@container kqhome (max-width: 760px){.kq-hero2{grid-template-columns:1fr}img.kq-hero2-art{max-width:360px!important;margin:8px 0 0!important}}.kq-crumb{margin:0 0 12px;font-size:14px;color:rgb(107 114 128)}.kq-hero2-title{margin:0;font-size:36px;line-height:40px;font-weight:500;letter-spacing:-.025em;color:#1a202c}.kq-hero2-sub{margin:16px 0 0;font-size:18px;line-height:28px;color:rgb(75 85 99);max-width:560px}.kq-go,.kq-go-arrow{display:inline-flex;align-items:center}.kq-go{gap:10px;margin-top:24px;font-size:17px;font-weight:600;color:#1a202c!important;text-decoration:none!important;border:0!important}.kq-go-arrow{width:26px;height:26px;justify-content:center;border-radius:6px;background:rgb(var(--primary));color:#fff;font-size:15px;transition:transform .15s ease}.kq-go:hover .kq-go-arrow{transform:translateX(3px)}img.kq-art,img.kq-hero2-art{display:block!important;width:100%!important;height:auto!important;margin:0!important}.kq-chips{display:flex;flex-wrap:wrap;gap:10px;margin:4px 0 32px}.kq-hero2 .kq-chips{margin:36px 0 0}.kq-chip{display:inline-flex;align-items:center;gap:8px;padding:8px 14px;border-radius:999px;font-size:14px;font-weight:500;color:#1a202c!important;text-decoration:none!important;border:1px solid rgb(229 231 235)!important;background:#fff;transition:border-color .15s ease}.kq-card:hover,.kq-chip:hover{border-color:rgb(var(--primary)/.45)!important}.kq-chip-ico{width:14px;height:14px;background-color:rgb(var(--primary));-webkit-mask:url(/icons/sparkle.svg) center/contain no-repeat;mask:url(/icons/sparkle.svg) center/contain no-repeat}.kq-section{margin-top:48px}.kq-card p,.kq-section-title{font-size:14px;color:rgb(107 114 128)}.kq-section-title{font-weight:600;text-transform:uppercase;letter-spacing:.06em;margin:0 0 16px}.kq-grid{display:grid;grid-template-columns:repeat(4,minmax(0,1fr));gap:16px}.kq-grid-3{grid-template-columns:repeat(3,minmax(0,1fr))}@container kqhome (max-width: 900px){.kq-grid,.kq-grid-3{grid-template-columns:repeat(2,minmax(0,1fr))}}@container kqhome (max-width: 520px){.kq-grid,.kq-grid-3{grid-template-columns:1fr}}.kq-card{display:block;padding:20px;border-radius:14px;background:#fff;border:1px solid rgb(229 231 235)!important;text-decoration:none!important;box-shadow:0 1px 2px rgb(0 0 0/.04);transition:border-color .15s ease,box-shadow .15s ease,transform .15s ease}.kq-card:hover{box-shadow:0 4px 16px rgb(0 0 0/.06);transform:translateY(-1px)}.kq-card h3{margin:16px 0 6px;font-size:16px;font-weight:600;color:#1a202c;letter-spacing:-.01em}.kq-card p{margin:0;line-height:1.5}.kq-card-row,.kq-tile{display:flex;align-items:center}.kq-card-row{gap:14px}.kq-card-row h3{margin:0 0 2px}img.kq-art{aspect-ratio:240/140;margin:-4px 0 4px!important;border-radius:10px!important;background:rgb(250 249 247);border:1px solid rgb(0 0 0/.04)}.kq-card:hover img.kq-art{border-color:rgb(var(--primary)/.25)}.kq-tile{width:40px;height:40px;border-radius:10px;justify-content:center;flex-shrink:0;border:1px solid rgb(var(--primary)/.18);background-color:rgb(var(--primary)/.06);background-image:linear-gradient(rgb(var(--primary)/.08) 1px,transparent 1px),linear-gradient(90deg,rgb(var(--primary)/.08) 1px,transparent 1px);background-size:8px 8px}.kq-ico{display:block;width:18px;height:18px;background-color:rgb(var(--primary));-webkit-mask-size:contain;mask-size:contain;-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;-webkit-mask-position:center;mask-position:center}.dark .kq-card h3,.dark .kq-chip,.dark .kq-go,.dark .kq-hero2-title{color:#fff!important}.dark .kq-crumb,.dark .kq-hero2-sub{color:rgb(166 161 159)}.dark .kq-chip{background:0 0;border-color:rgb(255 255 255/.12)!important}.dark .kq-card{background:rgb(255 255 255/.02);border-color:rgb(255 255 255/.08)!important;box-shadow:none}.dark .kq-card:hover{border-color:rgb(var(--primary-light)/.5)!important}.dark .kq-card p,.dark .kq-section-title{color:rgb(156 150 147)}.dark img.kq-art{background:rgb(255 255 255/.03);border-color:rgb(255 255 255/.06)}.dark .kq-ico{background-color:rgb(var(--primary-light))}"}],"page":{"pagePath":"api-reference/customers/create-a-customer","slug":"/api-reference/customers/create-a-customer","pageMetadata":{"title":"Create a customer","description":"Creates a new customer record within kelviq.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /customers/","href":"/api-reference/customers/create-a-customer","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Creates a new customer record within kelviq.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={strong:`strong`,..._provideComponents(),...props.components},{Info}=_components;if(!Info)_missingMdxReference(`Info`,true);return _jsxs(Info,{children:[`Click the base URL in the API playground and select the `,_jsx(_components.strong,{children:`Sandbox`}),` host for test data or the `,_jsx(_components.strong,{children:`Production`}),` host for live data. Use credentials from the same environment.`]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create a customer","description":"Creates a new customer record within kelviq.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /customers/","href":"/api-reference/customers/create-a-customer","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Customers"],"summary":"Create a customer","description":"Creates a new customer record within kelviq.","operationId":"createCustomer","x-mint":{"content":"\u003cInfo>Click the base URL in the API playground and select the **Sandbox** host for test data or the **Production** host for live data. Use credentials from the same environment.\u003c/Info>"},"requestBody":"8c144984-93fc-43e9-a4cc-b904047d31a0","responses":{"201":"51f3bc63-4999-4fb0-8b32-93805a6d1b53"},"method":"post","type":"path","servers":["7ab77a61-7f72-4cfa-8e81-060e1ed6ef52","8200eff7-a945-40c5-86e2-42838c491654"],"security":["4e0b8232-1d55-4aaf-b0eb-46f949934ff0"],"path":"/customers/","baseUrlOptions":["https://sandboxapi.kelviq.com/api/v1","https://api.kelviq.com/api/v1"],"title":"Create a customer","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId"],"properties":{"customerId":{"type":"string","description":"A stable identifier for this customer record. You define this value, and it must be unique within your Kelviq organization.","example":"unique-customer-id-456","isRequired":true,"uniqueKey":"customerId","typeLabel":"string"},"email":{"oneOf":[{"type":"string","format":"email","description":"The customer's email address. Email addresses do not have to be unique. More than one customer record can use the same email if each record has a different customerId.","example":"another.new.customer@example.com","uniqueKey":"email.oneOf.0","typeLabel":"string\u003cemail>"},{"type":"null","format":"email","description":"The customer's email address. Email addresses do not have to be unique. More than one customer record can use the same email if each record has a different customerId.","example":"another.new.customer@example.com","uniqueKey":"email.oneOf.1","typeLabel":"null"}],"uniqueKey":"email","typeLabel":"string\u003cemail> | null"},"name":{"oneOf":[{"type":"string","description":"The name of the customer.","example":"Jane Roe","uniqueKey":"name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name of the customer.","example":"Jane Roe","uniqueKey":"name.oneOf.1","typeLabel":"null"}],"uniqueKey":"name","typeLabel":"string | null"},"metadata":{"oneOf":[{"type":"object","additionalProperties":{"type":"string","uniqueKey":"metadata.oneOf.0.additionalProperties","typeLabel":"string"},"description":"A dictionary of custom key-value pairs.","example":{"source":"sdk_import","priority":"low"},"uniqueKey":"metadata.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"string","uniqueKey":"metadata.oneOf.1.additionalProperties","typeLabel":"string"},"description":"A dictionary of custom key-value pairs.","example":{"source":"sdk_import","priority":"low"},"uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"object | null"},"billingAddress":{"oneOf":[{"type":"object","description":"The billing address of the customer.","properties":{"country":{"type":"string","description":"The country code (e.g., ISO 3166-1 alpha-2).","example":"IN","uniqueKey":"billingAddress.oneOf.0.country","typeLabel":"string"},"line1":{"type":"string","description":"Address line 1.","example":"123 Main Street","uniqueKey":"billingAddress.oneOf.0.line1","typeLabel":"string"},"line2":{"oneOf":[{"type":"string","description":"Address line 2.","example":"Apt 4B","uniqueKey":"billingAddress.oneOf.0.line2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Address line 2.","example":"Apt 4B","uniqueKey":"billingAddress.oneOf.0.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"billingAddress.oneOf.0.line2","typeLabel":"string | null"},"postalCode":{"type":"string","description":"The postal or ZIP code.","example":"560001","uniqueKey":"billingAddress.oneOf.0.postalCode","typeLabel":"string"},"city":{"type":"string","description":"The city name.","example":"Bangalore","uniqueKey":"billingAddress.oneOf.0.city","typeLabel":"string"},"state":{"type":"string","description":"The state or province.","example":"Karnataka","uniqueKey":"billingAddress.oneOf.0.state","typeLabel":"string"}},"uniqueKey":"billingAddress.oneOf.0","typeLabel":"object"},{"type":"null","description":"The billing address of the customer.","properties":{"country":{"type":"string","description":"The country code (e.g., ISO 3166-1 alpha-2).","example":"IN"},"line1":{"type":"string","description":"Address line 1.","example":"123 Main Street"},"line2":{"oneOf":[{"type":"string","description":"Address line 2.","example":"Apt 4B"},{"type":"null","description":"Address line 2.","example":"Apt 4B"}]},"postalCode":{"type":"string","description":"The postal or ZIP code.","example":"560001"},"city":{"type":"string","description":"The city name.","example":"Bangalore"},"state":{"type":"string","description":"The state or province.","example":"Karnataka"}},"uniqueKey":"billingAddress.oneOf.1","typeLabel":"null"}],"uniqueKey":"billingAddress","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"customerId":"unique-customer-id-456","email":"another.new.customer@example.com","name":"Jane Roe","metadata":{"source":"sdk_import","priority":"low"},"billingAddress":{"country":"IN","line1":"123 Main Street","line2":"Apt 4B","postalCode":"560001","city":"Bangalore","state":"Karnataka"}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"51f3bc63-4999-4fb0-8b32-93805a6d1b53":{"description":"Customer Created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Server-generated unique UUID for the customer record.","readOnly":true,"example":"a1b2c3d4-e5f6-7890-1234-567890abcdef","uniqueKey":"id","typeLabel":"string\u003cuuid>"},"customerId":{"type":"string","description":"The client-provided customer identifier.","example":"unique-customer-id-123","uniqueKey":"customerId","typeLabel":"string"},"name":{"oneOf":[{"type":"string","description":"The customer's name.","example":"John Doe","uniqueKey":"name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The customer's name.","example":"John Doe","uniqueKey":"name.oneOf.1","typeLabel":"null"}],"uniqueKey":"name","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","format":"email","description":"The customer's email.","example":"new.customer@example.com","uniqueKey":"email.oneOf.0","typeLabel":"string\u003cemail>"},{"type":"null","format":"email","description":"The customer's email.","example":"new.customer@example.com","uniqueKey":"email.oneOf.1","typeLabel":"null"}],"uniqueKey":"email","typeLabel":"string\u003cemail> | null"},"details":{"type":"object","additionalProperties":true,"description":"Any server-added details about the customer (typically read-only).","readOnly":true,"example":{},"uniqueKey":"details","typeLabel":"object"},"metadata":{"oneOf":[{"type":"object","additionalProperties":{"type":"string","uniqueKey":"metadata.oneOf.0.additionalProperties","typeLabel":"string"},"description":"The metadata associated with the customer.","example":{"source":"sdk_import","priority":"high"},"uniqueKey":"metadata.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"string","uniqueKey":"metadata.oneOf.1.additionalProperties","typeLabel":"string"},"description":"The metadata associated with the customer.","example":{"source":"sdk_import","priority":"high"},"uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"object | null"},"billingAddress":{"oneOf":[{"type":"object","description":"The billing address of the customer.","properties":{"country":{"type":"string","description":"The country code (e.g., ISO 3166-1 alpha-2).","example":"IN","uniqueKey":"billingAddress.oneOf.0.country","typeLabel":"string"},"line1":{"type":"string","description":"Address line 1.","example":"123 Main Street","uniqueKey":"billingAddress.oneOf.0.line1","typeLabel":"string"},"line2":{"oneOf":[{"type":"string","description":"Address line 2.","example":"Apt 4B","uniqueKey":"billingAddress.oneOf.0.line2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Address line 2.","example":"Apt 4B","uniqueKey":"billingAddress.oneOf.0.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"billingAddress.oneOf.0.line2","typeLabel":"string | null"},"postalCode":{"type":"string","description":"The postal or ZIP code.","example":"560001","uniqueKey":"billingAddress.oneOf.0.postalCode","typeLabel":"string"},"city":{"type":"string","description":"The city name.","example":"Bangalore","uniqueKey":"billingAddress.oneOf.0.city","typeLabel":"string"},"state":{"type":"string","description":"The state or province.","example":"Karnataka","uniqueKey":"billingAddress.oneOf.0.state","typeLabel":"string"}},"uniqueKey":"billingAddress.oneOf.0","typeLabel":"object"},{"type":"null","description":"The billing address of the customer.","properties":{"country":{"type":"string","description":"The country code (e.g., ISO 3166-1 alpha-2).","example":"IN"},"line1":{"type":"string","description":"Address line 1.","example":"123 Main Street"},"line2":{"oneOf":[{"type":"string","description":"Address line 2.","example":"Apt 4B"},{"type":"null","description":"Address line 2.","example":"Apt 4B"}]},"postalCode":{"type":"string","description":"The postal or ZIP code.","example":"560001"},"city":{"type":"string","description":"The city name.","example":"Bangalore"},"state":{"type":"string","description":"The state or province.","example":"Karnataka"}},"uniqueKey":"billingAddress.oneOf.1","typeLabel":"null"}],"uniqueKey":"billingAddress","typeLabel":"object | null"},"createdOn":{"type":"string","nullable":false,"description":"Customer created date and time","example":"2025-06-04T06:03:30.195790Z","uniqueKey":"createdOn","typeLabel":"string"},"modifiedOn":{"type":"string","nullable":false,"description":"Customer updated date and time","example":"2025-06-04T06:03:30.195790Z","uniqueKey":"modifiedOn","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"id":"a1b2c3d4-e5f6-7890-1234-567890abcdef","customerId":"unique-customer-id-123","name":"John Doe","email":"new.customer@example.com","details":{},"metadata":{"source":"sdk_import","priority":"high"},"billingAddress":{"country":"IN","line1":"123 Main Street","line2":"Apt 4B","postalCode":"560001","city":"Bangalore","state":"Karnataka"},"createdOn":"2025-06-04T06:03:30.195790Z","modifiedOn":"2025-06-04T06:03:30.195831Z"},"examples":{"Example":{"title":"Example","value":{"id":"a1b2c3d4-e5f6-7890-1234-567890abcdef","customerId":"unique-customer-id-123","name":"John Doe","email":"new.customer@example.com","details":{},"metadata":{"source":"sdk_import","priority":"high"},"billingAddress":{"country":"IN","line1":"123 Main Street","line2":"Apt 4B","postalCode":"560001","city":"Bangalore","state":"Karnataka"},"createdOn":"2025-06-04T06:03:30.195790Z","modifiedOn":"2025-06-04T06:03:30.195831Z"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"4e0b8232-1d55-4aaf-b0eb-46f949934ff0":{"bearerAuth":{"type":"http","scheme":"bearer","description":"The Server API Key obtained from the kelviq application. Pass as a Bearer token in the Authorization header. Example: 'Authorization: Bearer __YOUR_API_KEY__'","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"7ab77a61-7f72-4cfa-8e81-060e1ed6ef52":{"url":"https://sandboxapi.kelviq.com/api/v1","description":"Sandbox — Test payments"},"8200eff7-a945-40c5-86e2-42838c491654":{"url":"https://api.kelviq.com/api/v1","description":"Production — Live payments"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"The Server API Key obtained from the kelviq application. Pass as a Bearer token in the Authorization header. Example: 'Authorization: Bearer __YOUR_API_KEY__'","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"The Server API Key obtained from the kelviq application. Pass as a Bearer token in the Authorization header. Example: 'Authorization: Bearer __YOUR_API_KEY__'","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"kelviq","siteName":"Kelviq Documentation","title":"Create a customer - Kelviq Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-20T15:29:40.913Z","originalFileLocation":"api-reference/customers/create-a-customer.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Creates a new customer record within kelviq.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Kelviq Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/kelviq/8MkHFh-7ZAVGgu29/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/kelviq/8MkHFh-7ZAVGgu29/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/kelviq/8MkHFh-7ZAVGgu29/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/kelviq/8MkHFh-7ZAVGgu29/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/kelviq/8MkHFh-7ZAVGgu29/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/kelviq/8MkHFh-7ZAVGgu29/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/kelviq/8MkHFh-7ZAVGgu29/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/kelviq/8MkHFh-7ZAVGgu29/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/kelviq/8MkHFh-7ZAVGgu29/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a customer - Kelviq Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a new customer record within kelviq.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Kelviq Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.kelviq.com/api-reference/customers/create-a-customer\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://kelviq.mintlify.app/_mintlify/api/og/v2?division=Customers\u0026amp;title=Create+a+customer\u0026amp;description=Creates+a+new+customer+record+within+kelviq.\u0026amp;theme=43254b9015ada5a0ae0c0078\u0026amp;signature=8bbcda020ce4f2ca0ea392ad88e457005d24a488d471214b62cb65bcf4d0fdb8\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create a customer - Kelviq Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a new customer record within kelviq.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://kelviq.mintlify.app/_mintlify/api/og/v2?division=Customers\u0026amp;title=Create+a+customer\u0026amp;description=Creates+a+new+customer+record+within+kelviq.\u0026amp;theme=43254b9015ada5a0ae0c0078\u0026amp;signature=8bbcda020ce4f2ca0ea392ad88e457005d24a488d471214b62cb65bcf4d0fdb8\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/kelviq/8MkHFh-7ZAVGgu29/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Kelviq Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF5722\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.kelviq.com/api-reference/customers/create-a-customer\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/customers/create-a-customer.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.kelviq.com/#organization\",\"name\":\"Kelviq Documentation\",\"url\":\"https://docs.kelviq.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/kelviq/uM9r7iYtQz8T7tpP/logo/light.svg?fit=max\u0026auto=format\u0026n=uM9r7iYtQz8T7tpP\u0026q=85\u0026s=0f4bd30f554a25a8966fd41fa354e383\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.kelviq.com#website\",\"name\":\"Kelviq Documentation\",\"url\":\"https://docs.kelviq.com\",\"publisher\":{\"@id\":\"https://docs.kelviq.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.kelviq.com/api-reference/customers/create-a-customer#webpage\",\"url\":\"https://docs.kelviq.com/api-reference/customers/create-a-customer\",\"name\":\"Create a customer\",\"description\":\"Creates a new customer record within kelviq.\",\"dateModified\":\"2026-10-20T15:29:40.913Z\",\"isPartOf\":{\"@id\":\"https://docs.kelviq.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.kelviq.com/api-reference/customers/create-a-customer#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.kelviq.com/api-reference/customers/create-a-customer#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Documentation\",\"item\":\"https://docs.kelviq.com/api-reference/customers/list-customers\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Customers\",\"item\":\"https://docs.kelviq.com/api-reference/customers/list-customers\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create a customer\",\"item\":\"https://docs.kelviq.com/api-reference/customers/create-a-customer\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.kelviq.com/api-reference/customers/create-a-customer#apireference\",\"headline\":\"Create a customer\",\"name\":\"Create a customer\",\"description\":\"Creates a new customer record within kelviq.\",\"url\":\"https://docs.kelviq.com/api-reference/customers/create-a-customer\",\"mainEntityOfPage\":{\"@id\":\"https://docs.kelviq.com/api-reference/customers/create-a-customer#webpage\"},\"dateModified\":\"2026-10-20T15:29:40.913Z\",\"publisher\":{\"@id\":\"https://docs.kelviq.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.kelviq.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Kelviq Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Kelviq Documentation","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/getstarted/overview"}]},{"tab":"API Reference","groups":[{"group":"Get Started","pages":[{"title":"Introduction","sidebarTitle":"Introduction","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"}]},{"group":"API Documentation","pages":[{"group":"Customers","pages":[{"title":"List customers","description":"Retrieves a paginated list of customers for your organization, ordered by creation date (newest first). You can search across the customer's name, email and `customerId`.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /customers/","href":"/api-reference/customers/list-customers"},{"title":"Create a customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /customers/","href":"/api-reference/customers/create-a-customer"},{"title":"Update a customer","description":"Performs a partial update on an existing customer using their client-defined `customerId`.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /customers/{customerId}/","href":"/api-reference/customers/update-a-customer"}]},{"group":"Checkout","pages":[{"title":"Create a checkout session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /checkout/","href":"/api-reference/checkout/create-a-checkout-session"}]},{"group":"Checkout Sessions","pages":[{"title":"List checkout sessions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /checkout/sessions/","href":"/api-reference/checkout-sessions/list-checkout-sessions"},{"title":"Retrieve a checkout session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /checkout/sessions/{session_id}/","href":"/api-reference/checkout-sessions/retrieve-a-checkout-session"}]},{"group":"Checkout Session Events","pages":[{"title":"List checkout session events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /checkout/sessions/{session_id}/events/","href":"/api-reference/checkout-session-events/list-checkout-session-events"}]},{"group":"Entitlements","pages":[{"title":"Retrieve customer entitlements","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /entitlements/","href":"/api-reference/entitlements/retrieve-customer-entitlements"}]},{"group":"License","pages":[{"title":"Activate License","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /license/activate/","href":"/api-reference/license/activate-license"},{"title":"Deactivate License","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /license/deactivate/","href":"/api-reference/license/deactivate-license"},{"title":"Validate License","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /license/validate/","href":"/api-reference/license/validate-license"}]},{"group":"Reporting","pages":[{"title":"Report pre-aggregated usage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /report/usage/","href":"/api-reference/reporting/report-pre-aggregated-usage"}]},{"group":"Transactions","pages":[{"title":"List transactions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /transaction/","href":"/api-reference/transactions/list-transactions"}]},{"group":"Orders","pages":[{"title":"List orders","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /orders/","href":"/api-reference/orders/list-orders"},{"title":"Retrieve an order","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /orders/{id}/","href":"/api-reference/orders/retrieve-an-order"}]},{"group":"Order Events","pages":[{"title":"List order events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /orders/{id}/events/","href":"/api-reference/order-events/list-order-events"}]},{"group":"Invoices","pages":[{"title":"List invoices","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /invoices/","href":"/api-reference/invoices/list-invoices"},{"title":"Retrieve an invoice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /invoices/{invoiceId}/","href":"/api-reference/invoices/retrieve-an-invoice"}]},{"group":"Webhooks","pages":[{"title":"List webhook logs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /webhook/logs/","href":"/api-reference/webhooks/list-webhook-logs"}]},{"group":"Refunds","pages":[{"title":"List refunds","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /refunds/","href":"/api-reference/refunds/list-refunds"},{"title":"Create a refund","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /refunds/","href":"/api-reference/refunds/create-a-refund"},{"title":"Retrieve a refund","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /refunds/{refundId}/","href":"/api-reference/refunds/retrieve-a-refund"}]},{"group":"Charges","pages":[{"title":"Create a charge","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /charges/","href":"/api-reference/charges/create-a-charge"}]},{"group":"Subscriptions","pages":[{"title":"List Subscriptions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /subscriptions/","href":"/api-reference/subscriptions/list-subscriptions"},{"title":"Create a subscription","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /subscriptions/create/","href":"/api-reference/subscriptions/create-a-subscription"},{"title":"Retrieve a Subscription","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /subscriptions/{subscriptionId}/","href":"/api-reference/subscriptions/retrieve-a-subscription"},{"title":"Update a subscription","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /subscriptions/{subscriptionId}/update/","href":"/api-reference/subscriptions/update-a-subscription"},{"title":"Preview a subscription update","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /subscriptions/{subscriptionId}/update/preview/","href":"/api-reference/subscriptions/preview-a-subscription-update"},{"title":"Cancel a subscription","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /subscriptions/{subscriptionId}/cancel/","href":"/api-reference/subscriptions/cancel-a-subscription"},{"title":"Get retention offers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /subscriptions/{subscriptionId}/retention/","href":"/api-reference/subscriptions/get-retention-offers"},{"title":"Accept a retention offer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /subscriptions/{subscriptionId}/retention/accept/","href":"/api-reference/subscriptions/accept-a-retention-offer"}]},{"group":"Monetization","pages":[{"title":"Get Product Offering","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /monetization/product-offering/{product_id}/","href":"/api-reference/monetization/get-product-offering"}]},{"group":"Promotions","pages":[{"title":"Get promotions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /promotions","href":"/api-reference/promotions/get-promotions"}]},{"group":"Portal","pages":[{"title":"Create a portal session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /portal/session/","href":"/api-reference/portal/create-a-portal-session"}]},{"group":"Products","pages":[{"title":"List products","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /catalog/products/","href":"/api-reference/products/list-products"},{"title":"Create a product","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /catalog/products/","href":"/api-reference/products/create-a-product"},{"title":"Retrieve a product","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /catalog/products/{pk}/","href":"/api-reference/products/retrieve-a-product"},{"title":"Archive a product","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /catalog/products/{pk}/","href":"/api-reference/products/archive-a-product"},{"title":"Update a product","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /catalog/products/{pk}/","href":"/api-reference/products/update-a-product"}]},{"group":"Product Settings","pages":[{"title":"Retrieve product settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /catalog/products/{pk}/settings/","href":"/api-reference/product-settings/retrieve-product-settings"},{"title":"Update product settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /catalog/products/{pk}/settings/","href":"/api-reference/product-settings/update-product-settings"}]},{"group":"Product Files","pages":[{"title":"Delete a product image","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /catalog/products/{product_pk}/image/{pk}/","href":"/api-reference/product-files/delete-a-product-image"},{"title":"Update a product image","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /catalog/products/{product_pk}/image/{pk}/","href":"/api-reference/product-files/update-a-product-image"}]},{"group":"Features","pages":[{"title":"List features","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /catalog/features/","href":"/api-reference/features/list-features"},{"title":"Create a feature","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /catalog/features/","href":"/api-reference/features/create-a-feature"},{"title":"Retrieve a feature","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /catalog/features/{pk}/","href":"/api-reference/features/retrieve-a-feature"},{"title":"Archive a feature","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /catalog/features/{pk}/","href":"/api-reference/features/archive-a-feature"}]},{"group":"Plans","pages":[{"title":"List plans","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /catalog/plans/","href":"/api-reference/plans/list-plans"},{"title":"Create a plan","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /catalog/plans/","href":"/api-reference/plans/create-a-plan"},{"title":"Retrieve a plan","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /catalog/plans/{identifier}/","href":"/api-reference/plans/retrieve-a-plan"},{"title":"Archive a plan","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /catalog/plans/{identifier}/","href":"/api-reference/plans/archive-a-plan"},{"title":"Update a plan","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /catalog/plans/{identifier}/","href":"/api-reference/plans/update-a-plan"},{"title":"Publish a plan","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /catalog/plans/{identifier}/publish/","href":"/api-reference/plans/publish-a-plan"},{"title":"Discard draft plan","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /catalog/plans/{identifier}/discard/","href":"/api-reference/plans/discard-draft-plan"},{"title":"List plan prices","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /catalog/plans/{identifier}/prices/","href":"/api-reference/plans/list-plan-prices"},{"title":"Update plan prices","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /catalog/plans/{identifier}/prices/bulk/","href":"/api-reference/plans/update-plan-prices"}]},{"group":"Plan Entitlements","pages":[{"title":"List plan entitlements","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /catalog/plans/{identifier}/features/","href":"/api-reference/plan-entitlements/list-plan-entitlements"},{"title":"Add plan entitlements","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /catalog/plans/{identifier}/features/","href":"/api-reference/plan-entitlements/add-plan-entitlements"},{"title":"Delete plan entitlement","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /catalog/plans/{identifier}/features/{feature_id}/","href":"/api-reference/plan-entitlements/delete-plan-entitlement"},{"title":"Update plan entitlement","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /catalog/plans/{identifier}/features/{feature_id}/","href":"/api-reference/plan-entitlements/update-plan-entitlement"}]},{"group":"Plan Files","pages":[{"title":"Delete a plan file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /catalog/plans/{identifier}/file/{pk}/","href":"/api-reference/plan-files/delete-a-plan-file"},{"title":"Update a plan file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /catalog/plans/{identifier}/file/{pk}/","href":"/api-reference/plan-files/update-a-plan-file"},{"title":"Download a plan file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /catalog/plans/{identifier}/file/{pk}/download/","href":"/api-reference/plan-files/download-a-plan-file"}]},{"group":"Media","pages":[{"title":"Generate a presigned upload URL","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /media/","href":"/api-reference/media/generate-a-presigned-upload-url"}]},{"group":"Partner","pages":[{"title":"List partner organizations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /partner/organizations/","href":"/api-reference/partner/list-partner-organizations"},{"title":"Provision an organization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /partner/organizations/","href":"/api-reference/partner/provision-an-organization"},{"title":"Get a partner organization by identifier","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /partner/organizations/{identifier}/","href":"/api-reference/partner/get-a-partner-organization-by-identifier"},{"title":"Get a partner organization by external ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /partner/organizations/by-external-id/{externalId}/","href":"/api-reference/partner/get-a-partner-organization-by-external-id"}]},{"group":"Payment Methods","pages":[{"title":"List payment methods","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment-methods/","href":"/api-reference/payment-methods/list-payment-methods"}]},{"group":"Discounts","pages":[{"title":"List discounts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /discount/","href":"/api-reference/discounts/list-discounts"},{"title":"Create a discount","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /discount/","href":"/api-reference/discounts/create-a-discount"},{"title":"Retrieve a discount","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /discount/{pk}/","href":"/api-reference/discounts/retrieve-a-discount"},{"title":"Delete a discount","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /discount/{pk}/","href":"/api-reference/discounts/delete-a-discount"},{"title":"Update a discount","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /discount/{pk}/","href":"/api-reference/discounts/update-a-discount"}]},{"group":"Webhook Endpoints","pages":[{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /webhook/endpoints/","href":"/api-reference/webhook-endpoints/list-webhook-endpoints"},{"title":"Create a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /webhook/endpoints/","href":"/api-reference/webhook-endpoints/create-a-webhook-endpoint"},{"title":"Retrieve a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /webhook/endpoints/{pk}/","href":"/api-reference/webhook-endpoints/retrieve-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /webhook/endpoints/{pk}/","href":"/api-reference/webhook-endpoints/delete-a-webhook-endpoint"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /webhook/endpoints/{pk}/","href":"/api-reference/webhook-endpoints/update-a-webhook-endpoint"}]}]}]},{"tab":"SDKs","pages":[{"title":"SDKs","href":"/backend-integration/python-sdk"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Create a customer - Kelviq Documentation","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B7XKH4J3.js","utils-lOYzL7z-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DF6jUUIM.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dpsj5f7C.js","snippetPresets-CYeiDe8v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CUFz1YZ_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D8H_iLS4.js","shallow-DdluZBHX.js","getApiPlaygroundDisplay-B9922vev.js","CodeSnippet-CMoRNGYs.js","CodeSnippets-DwyrPHuw.js","Page-DSVu9Ucl.js","getPastedJson-G-zIvlHh.js","icon-B03fnEy0.js","MethodPill-CW7teklc.js","DuplicateIcon-CtO8eekd.js","createIcon-DZTKdM_A.js","DynamicMarkdown-D5M2At0B.js","SectionHeading-C_2NaA2U.js","axios-vUo_bRtp.js","Markdown-D7QRHV3m.js","clsx-D1Z-ELXV.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-lvhuD9Du.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CKfC4ywL.js"]}