Connector tool: create_link_tokenCreate tokens only from your backend with X-Api-Key or an OAuth access token with connections:write. Your client must be active.X-Subtotal-Idempotency-Key is optional. Include it to return the same token when retrying an identical request. Without it, each successful request creates a new token.Returns link_token, not a URL or a separate token ID. See Customer Link tokens for URL construction, reuse, and retry behavior.
Partner OAuth: send Authorization: Bearer <access_token>, an OAuth access token from Subtotal's authorization server with the scope this endpoint needs.
Headers
X-Subtotal-Idempotency-Key
string | null
Body
application/json
customer_id
string
required
A unique identifier used to map connections to customer records in external systems.
Required string length: 1 - 64
email
string
required
The customer's email address
Maximum string length: 254
mobile
string | null
The customer's mobile phone number
Maximum string length: 16
tags
Tags · object | null
Client-defined attribution tags recorded when the connection is created, for grouping connection metrics — e.g. {"campaign": "summer_sweeps", "program": "loyalty"}. Names and values are opaque to Subtotal and are never interpreted. At most 10 tags; names up to 64 characters, values up to 256. Intended for campaign and source metadata — do not put consumer PII in tags.
Show child attributes
expires_in_days
integer
default:30
Number of whole days before the link token expires.
Required range: 1 <= x <= 365
Response
Successful Response
customer_id
string
required
status
enum<string>
required
Available options:
active,
expired,
revoked
created_at
string<date-time>
required
expires_at
string<date-time>
required
revoked_at
string<date-time> | null
required
link_token
string
required
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Subtotal Docs","colors":{"primary":"#912DA8","light":"#DB41FF","dark":"#DB41FF"},"logo":{"light":"https://mintcdn.com/typecastleinc/d5UA7eGR6OP4SNAc/logo/light.svg?fit=max\u0026auto=format\u0026n=d5UA7eGR6OP4SNAc\u0026q=85\u0026s=92869634e0f56df8f5c3f380760324ec","dark":"https://mintcdn.com/typecastleinc/d5UA7eGR6OP4SNAc/logo/dark.svg?fit=max\u0026auto=format\u0026n=d5UA7eGR6OP4SNAc\u0026q=85\u0026s=76ecea195cf070d328c0efb8742bc3d4","href":"https://docs.subtotal.com/home"},"favicon":"https://mintcdn.com/typecastleinc/d5UA7eGR6OP4SNAc/favicon.svg?fit=max\u0026auto=format\u0026n=d5UA7eGR6OP4SNAc\u0026q=85\u0026s=7d18531f4733de8a41bc1685f086204f","appearance":{"default":"light"},"background":{"color":{"light":"#FFFFFF","dark":"#21002A"}},"navbar":{"links":[{"href":"https://subtotal.com/contact","label":"Contact sales"}],"primary":{"type":"button","label":"Sign in","href":"https://dashboard.subtotal.com"}},"footer":{"socials":{"x":"https://x.com/Subtotal","github":"https://github.com/subtotal","linkedin":"https://www.linkedin.com/company/SubtotalInc"}},"fonts":{"family":"Goalking","weight":400,"source":"fonts/Goalking-Rg.woff2","format":"woff2"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"typecastleinc","hasAudioNarration":false,"actualSubdomain":"typecastleinc","customDomains":["docs.subtotal.com","subtotal.com"],"gitSource":{"type":"github","owner":"subtotal","repo":"subtotal-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af79afbbba5471b4844657e","clientVersion":"0.0.4205","searchFilterCounts":[{"language":"default","tag":"Documentation","count":62},{"language":"default","tag":"API Reference","count":34},{"language":"default","tag":"Apps","count":25},{"language":"default","tag":"Products","count":22},{"language":"default","tag":"Developers","count":11},{"language":"default","tag":"Webhooks","count":8},{"language":"default","tag":"Connections","count":7},{"language":"default","tag":"Connectors","count":6},{"language":"default","tag":"Product groups","count":5},{"language":"default","tag":"Event simulator","count":4}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"rbac-expansion","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":"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":"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":"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":"editor-metadata","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},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"meta-purchase-flow.css","content":"#meta-purchase-flow{container:meta-purchase-flow / inline-size}#meta-purchase-flow .meta-flow-track{display:grid;gap:8px}#meta-purchase-flow .meta-flow-stage{display:grid;grid-template-columns:48px minmax(0, 1fr);gap:4px 16px;align-content:start;padding:16px;min-width:0}#meta-purchase-flow .meta-flow-icon{grid-row:span 2;display:flex;align-items:center;justify-content:center;width:48px;height:48px;border-radius:12px}#meta-purchase-flow .meta-flow-title{font-size:14px;font-weight:500;line-height:24px}#meta-purchase-flow .meta-flow-detail{font-size:14px;line-height:22px}#meta-purchase-flow .meta-flow-arrow{display:flex;justify-content:center;width:48px;margin-left:16px;transform:rotate(90deg)}@container meta-purchase-flow (min-width: 640px){#meta-purchase-flow .meta-flow-track{grid-template-columns:minmax(0, 1fr) 16px minmax(0, 1fr) 16px minmax(0, 1fr);gap:12px}#meta-purchase-flow .meta-flow-stage{grid-template-columns:minmax(0, 1fr);grid-template-rows:48px 24px auto;justify-items:center;gap:12px;text-align:center}#meta-purchase-flow .meta-flow-icon{grid-row:auto}#meta-purchase-flow .meta-flow-arrow{width:16px;height:16px;margin:32px 0 0;transform:none}}"},{"filePath":"subtotal-brand.css","content":"/* cyrillic-ext */\n@font-face {\n font-family: 'Roboto Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/robotomono/v31/L0x5DF4xlVMF-BfR8bXMIjhGq3-OXg.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Roboto Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/robotomono/v31/L0x5DF4xlVMF-BfR8bXMIjhPq3-OXg.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* greek */\n@font-face {\n font-family: 'Roboto Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/robotomono/v31/L0x5DF4xlVMF-BfR8bXMIjhIq3-OXg.woff2) format('woff2');\n unicode-range: U+0370-0377, U+037A-037F, U+0384-038A, U+038C, U+038E-03A1, U+03A3-03FF;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Roboto Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/robotomono/v31/L0x5DF4xlVMF-BfR8bXMIjhEq3-OXg.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Roboto Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/robotomono/v31/L0x5DF4xlVMF-BfR8bXMIjhFq3-OXg.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Roboto Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/robotomono/v31/L0x5DF4xlVMF-BfR8bXMIjhLq38.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'Roboto Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/robotomono/v31/L0x5DF4xlVMF-BfR8bXMIjhGq3-OXg.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Roboto Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/robotomono/v31/L0x5DF4xlVMF-BfR8bXMIjhPq3-OXg.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* greek */\n@font-face {\n font-family: 'Roboto Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/robotomono/v31/L0x5DF4xlVMF-BfR8bXMIjhIq3-OXg.woff2) format('woff2');\n unicode-range: U+0370-0377, U+037A-037F, U+0384-038A, U+038C, U+038E-03A1, U+03A3-03FF;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Roboto Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/robotomono/v31/L0x5DF4xlVMF-BfR8bXMIjhEq3-OXg.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Roboto Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/robotomono/v31/L0x5DF4xlVMF-BfR8bXMIjhFq3-OXg.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Roboto Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/robotomono/v31/L0x5DF4xlVMF-BfR8bXMIjhLq38.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n@font-face{font-family:'Goalking';src:url('/fonts/Goalking-Rg.woff2') format('woff2');font-weight:400;font-style:normal;font-display:swap}@font-face{font-family:'Goalking';src:url('/fonts/Goalking-Md.woff2') format('woff2');font-weight:500;font-style:normal;font-display:swap}@font-face{font-family:'Goalking';src:url('/fonts/Goalking-SmBd.woff2') format('woff2');font-weight:600;font-style:normal;font-display:swap}@font-face{font-family:'Goalking';src:url('/fonts/Goalking-Bd.woff2') format('woff2');font-weight:700;font-style:normal;font-display:swap}:root{--subtotal-pink: #db41ff;--subtotal-pink-dark: #3f074e;--subtotal-pink-light: #ffaefe;--subtotal-blue: #2d62ff;--subtotal-rich-black: #21002a}body,#content,#sidebar,#navbar{font-family:'Goalking', Arial, sans-serif}h1,h2,h3,h4,#page-title{font-family:'Goalking', Arial, sans-serif;font-weight:700;letter-spacing:-0.01em}code,pre,kbd,samp{font-family:'Roboto Mono', ui-monospace, SFMono-Regular, Menlo, monospace}html:not(.dark) #content{color:rgba(33, 0, 42, 0.85)}html:not(.dark) #content h1,html:not(.dark) #content h2,html:not(.dark) #content h3,html:not(.dark) #page-title{color:var(--subtotal-rich-black)}#topbar-cta-button a,#topbar-cta-button button{border-radius:1rem;font-weight:600}#content img.rounded-lg,#content .callout,#content [class*=\"code-block\"],#content a.card,#content div.card{border-radius:1rem}html.dark body{background-image:radial-gradient(60rem 30rem at 100% 0%, rgba(219, 65, 255, 0.16), transparent 60%),\n radial-gradient(50rem 30rem at 0% 0%, rgba(45, 98, 255, 0.12), transparent 60%);background-repeat:no-repeat;background-attachment:fixed}"}],"page":{"pagePath":"docs/api-reference/link-tokens/create-link-token","slug":"/docs/api-reference/link-tokens/create-link-token","pageMetadata":{"openapi":"post /link-tokens","title":"Create Link Token","description":"Create a durable customer-scoped Subtotal Link token","href":"/docs/api-reference/link-tokens/create-link-token"},"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: \"Create a durable customer-scoped Subtotal Link token\"\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{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,..._provideComponents(),...props.components},{Badge}=_components;if(!Badge)_missingMdxReference(`Badge`,true);return _jsxs(_Fragment,{children:[_jsx(_components.a,{href:`/docs/connector/tools#create_link_token`,children:_jsx(Badge,{icon:`robot`,color:`purple`,children:`Connector tool: create_link_token`})}),`\n`,_jsxs(_components.p,{children:[`Create tokens only from your backend with `,_jsx(_components.code,{children:`X-Api-Key`}),` or an OAuth access token with `,_jsx(_components.code,{children:`connections:write`}),`. Your client must be active.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`X-Subtotal-Idempotency-Key`}),` is optional. Include it to return the same token when retrying an identical request. Without it, each successful request creates a new token.`]}),`\n`,_jsxs(_components.p,{children:[`Returns `,_jsx(_components.code,{children:`link_token`}),`, not a URL or a separate token ID. See `,_jsx(_components.a,{href:`/docs/subtotal-link/link-tokens`,children:`Customer Link tokens`}),` for URL construction, reuse, and retry behavior.`]})]})}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":{"openapi":"post /link-tokens","title":"Create Link Token","description":"Create a durable customer-scoped Subtotal Link token","href":"/docs/api-reference/link-tokens/create-link-token"}}},"mdxSourceWithNoJs":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{Badge,CodeBlock,RequestExample}=_components;if(!Badge)_missingMdxReference(`Badge`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!RequestExample)_missingMdxReference(`RequestExample`,true);return _jsxs(_Fragment,{children:[_jsx(_components.a,{href:`/docs/connector/tools#create_link_token`,children:_jsx(Badge,{icon:`robot`,color:`purple`,children:`Connector tool: create_link_token`})}),`\n`,_jsxs(_components.p,{children:[`Create tokens only from your backend with `,_jsx(_components.code,{children:`X-Api-Key`}),` or an OAuth access token with `,_jsx(_components.code,{children:`connections:write`}),`. Your client must be active.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`X-Subtotal-Idempotency-Key`}),` is optional. Include it to return the same token when retrying an identical request. Without it, each successful request creates a new token.`]}),`\n`,_jsxs(_components.p,{children:[`Returns `,_jsx(_components.code,{children:`link_token`}),`, not a URL or a separate token ID. See `,_jsx(_components.a,{href:`/docs/subtotal-link/link-tokens`,children:`Customer Link tokens`}),` for URL construction, reuse, and retry behavior.`]}),`\n`,_jsx(RequestExample,{children:_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`4`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`4`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --request`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'https://api.subtotal.com/link-tokens'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"X-Api-Key: `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$SUBTOTAL_API_KEY`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Content-Type: application/json'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --data`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{\"customer_id\":\"customer-example-001\",\"email\":\"consumer@example.com\",\"expires_in_days\":30}'`})]}),`\n`]})})})})]})}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":{"openapi":"post /link-tokens","title":"Create Link Token","description":"Create a durable customer-scoped Subtotal Link token","href":"/docs/api-reference/link-tokens/create-link-token"}}}},"mdxExtracts":{"tableOfContents":[],"codeExamples":{"request":{"type":"RequestExample","children":[{"filename":"cURL","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"shellscript\">\u003ccode language=\"shellscript\" numberOfLines=\"4\">\u003cspan class=\"line\">\u003cspan style=\"color:#953800;--shiki-dark:#DCDCAA\">curl\u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --request\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> POST\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> 'https://api.subtotal.com/link-tokens'\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --header\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"X-Api-Key: \u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\">$SUBTOTAL_API_KEY\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --header\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> 'Content-Type: application/json'\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --data\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> '{\"customer_id\":\"customer-example-001\",\"email\":\"consumer@example.com\",\"expires_in_days\":30}'\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]}}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["link_tokens"],"summary":"Create Link Token","description":"Create a durable customer-scoped Subtotal Link token","operationId":"create_link_token","parameters":["6b90d411-4bd7-47af-8327-2fc2293e1310"],"requestBody":"6a9f51ba-1478-41c7-934f-a0637e942f81","responses":{"201":"825a54b2-ef13-4839-b2ea-e744f28def7f","422":"0ac0bbc8-0e87-4ef5-bc39-b6a58e30bc8a"},"security":["6b951695-103d-4cce-87f4-4f1000a650ef","177afa4b-c874-4bdc-b9d6-921376cb55c8"],"method":"post","type":"path","servers":[],"path":"/link-tokens","baseUrlOptions":[],"title":"Create Link Token","codeSamples":[],"requiredOnlyExamples":false,"requestExamples":[{"dropdown":false,"language":"shellscript","code":{"type":"pre","key":null,"ref":null,"props":{"className":"shiki shiki-themes github-light-default dark-plus","style":{"backgroundColor":"#ffffff","--shiki-dark-bg":"#0B0C0E","color":"#1f2328","--shiki-dark":"#D4D4D4"},"language":"shellscript","children":{"type":"code","key":null,"ref":null,"props":{"language":"shellscript","numberOfLines":"4","children":[{"type":"span","key":"0","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#953800","--shiki-dark":"#DCDCAA"},"children":"curl"}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#0550AE","--shiki-dark":"#569CD6"},"children":" --request"}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" POST"}},{"type":"span","key":"3","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" 'https://api.subtotal.com/link-tokens'"}},{"type":"span","key":"4","ref":null,"props":{"style":{"color":"#CF222E","--shiki-dark":"#D7BA7D"},"children":" \\"}}]}},"\n",{"type":"span","key":"2","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#0550AE","--shiki-dark":"#569CD6"},"children":" --header"}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" \"X-Api-Key: "}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#9CDCFE"},"children":"$SUBTOTAL_API_KEY"}},{"type":"span","key":"3","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":"\""}},{"type":"span","key":"4","ref":null,"props":{"style":{"color":"#CF222E","--shiki-dark":"#D7BA7D"},"children":" \\"}}]}},"\n",{"type":"span","key":"4","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#0550AE","--shiki-dark":"#569CD6"},"children":" --header"}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" 'Content-Type: application/json'"}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#CF222E","--shiki-dark":"#D7BA7D"},"children":" \\"}}]}},"\n",{"type":"span","key":"6","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#0550AE","--shiki-dark":"#569CD6"},"children":" --data"}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" '{\"customer_id\":\"customer-example-001\",\"email\":\"consumer@example.com\",\"expires_in_days\":30}'"}}]}},"\n"]}}}},"filename":"cURL"}],"requestExampleType":"mdx","responseExampleType":"generated"},"dependencies":{"parameters":{"6b90d411-4bd7-47af-8327-2fc2293e1310":{"name":"X-Subtotal-Idempotency-Key","in":"header","required":false,"schema":{"oneOf":[{"type":"string","title":"X-Subtotal-Idempotency-Key","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"X-Subtotal-Idempotency-Key","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"customer_id":{"type":"string","maxLength":64,"minLength":1,"title":"Customer Id","description":"A unique identifier used to map connections to customer records in external systems.","isRequired":true,"uniqueKey":"customer_id","typeLabel":"string"},"email":{"type":"string","maxLength":254,"title":"Email","description":"The customer's email address","isRequired":true,"uniqueKey":"email","typeLabel":"string"},"mobile":{"oneOf":[{"type":"string","title":"Mobile","description":"The customer's mobile phone number","maxLength":16,"uniqueKey":"mobile.oneOf.0","typeLabel":"string"},{"type":"null","title":"Mobile","description":"The customer's mobile phone number","uniqueKey":"mobile.oneOf.1","typeLabel":"null"}],"uniqueKey":"mobile","typeLabel":"string | null"},"tags":{"oneOf":[{"type":"object","title":"Tags","description":"Client-defined attribution tags recorded when the connection is created, for grouping connection metrics — e.g. {\"campaign\": \"summer_sweeps\", \"program\": \"loyalty\"}. Names and values are opaque to Subtotal and are never interpreted. At most 10 tags; names up to 64 characters, values up to 256. Intended for campaign and source metadata — do not put consumer PII in tags.","maxProperties":10,"additionalProperties":{"type":"string","maxLength":256,"minLength":1,"uniqueKey":"tags.oneOf.0.additionalProperties","typeLabel":"string"},"uniqueKey":"tags.oneOf.0","typeLabel":"Tags · object"},{"type":"null","title":"Tags","description":"Client-defined attribution tags recorded when the connection is created, for grouping connection metrics — e.g. {\"campaign\": \"summer_sweeps\", \"program\": \"loyalty\"}. Names and values are opaque to Subtotal and are never interpreted. At most 10 tags; names up to 64 characters, values up to 256. Intended for campaign and source metadata — do not put consumer PII in tags.","uniqueKey":"tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"tags","typeLabel":"Tags · object | null"},"expires_in_days":{"type":"integer","maximum":365,"minimum":1,"title":"Expires In Days","description":"Number of whole days before the link token expires.","default":30,"uniqueKey":"expires_in_days","typeLabel":"integer"}},"additionalProperties":false,"type":"object","required":["customer_id","email"],"title":"CreateLinkTokenRequest","uniqueKey":"","typeLabel":"CreateLinkTokenRequest · object"},"examples":{"Example":{"title":"Example","value":{"customer_id":"\u003cstring>","email":"\u003cstring>","mobile":"\u003cstring>","tags":{},"expires_in_days":30}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"825a54b2-ef13-4839-b2ea-e744f28def7f":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"customer_id":{"type":"string","title":"Customer Id","isRequired":true,"uniqueKey":"customer_id","typeLabel":"string"},"status":{"type":"string","enum":["active","expired","revoked"],"title":"LinkTokenStatus","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"created_at":{"type":"string","format":"date-time","title":"Created At","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"expires_at":{"type":"string","format":"date-time","title":"Expires At","isRequired":true,"uniqueKey":"expires_at","typeLabel":"string\u003cdate-time>"},"revoked_at":{"oneOf":[{"type":"string","title":"Revoked At","format":"date-time","isRequired":true,"uniqueKey":"revoked_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Revoked At","isRequired":true,"uniqueKey":"revoked_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"revoked_at","typeLabel":"string\u003cdate-time> | null"},"link_token":{"type":"string","title":"Link Token","isRequired":true,"uniqueKey":"link_token","typeLabel":"string"}},"type":"object","required":["customer_id","status","created_at","expires_at","revoked_at","link_token"],"title":"CreateLinkTokenResponse","uniqueKey":"","typeLabel":"CreateLinkTokenResponse · object"},"examples":{"Example":{"title":"Example","value":{"customer_id":"\u003cstring>","status":"active","created_at":"2023-11-07T05:31:56Z","expires_at":"2023-11-07T05:31:56Z","revoked_at":"2023-11-07T05:31:56Z","link_token":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"0ac0bbc8-0e87-4ef5-bc39-b6a58e30bc8a":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"},"input":{"oneOf":[{"title":"Input"}],"uniqueKey":"detail.items.[INDEX].input","typeLabel":"any"},"ctx":{"type":"object","title":"Context","uniqueKey":"detail.items.[INDEX].ctx","typeLabel":"Context · object"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"type":"object","title":"HTTPValidationError","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>","input":"\u003cunknown>","ctx":{}}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"6b951695-103d-4cce-87f4-4f1000a650ef":{"PartnerOAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Partner OAuth: send `Authorization: Bearer \u003caccess_token>`, an OAuth access token from Subtotal's authorization server with the scope this endpoint needs.","scopes":[],"schemeName":"PartnerOAuth"}},"177afa4b-c874-4bdc-b9d6-921376cb55c8":{"ApiKey":{"type":"apiKey","in":"header","name":"X-Api-Key","description":"API key: your Subtotal API key.","scopes":[],"schemeName":"ApiKey"}}},"servers":{},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Partner OAuth: send `Authorization: Bearer \u003caccess_token>`, an OAuth access token from Subtotal's authorization server with the scope this endpoint needs.","scopes":[],"schemeName":"PartnerOAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Partner OAuth: send `Authorization: Bearer \u003caccess_token>`, an OAuth access token from Subtotal's authorization server with the scope this endpoint needs.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"PartnerOAuth","name":"Authorization"}],"title":"PartnerOAuth"},{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-Api-Key","description":"API key: your Subtotal API key.","scopes":[],"schemeName":"ApiKey"},"schema":{"title":"X-Api-Key","type":"string","description":"API key: your Subtotal API key.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKey","name":"X-Api-Key"}],"title":"ApiKey"}]},"originalFileLocation":"docs/openapi.json"},"subdomain":"typecastleinc","siteName":"Subtotal Docs","title":"Create Link Token - Subtotal Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-13T23:19:29.323Z","originalFileLocation":"docs/api-reference/link-tokens/create-link-token.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=\"light\"}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=\"Create a durable customer-scoped Subtotal Link token\">\u003cmeta data-mint-head name=\"application-name\" content=\"Subtotal Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/typecastleinc/CqEoIfFQWU-okRJN/_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/typecastleinc/CqEoIfFQWU-okRJN/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/typecastleinc/CqEoIfFQWU-okRJN/_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/typecastleinc/CqEoIfFQWU-okRJN/_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/typecastleinc/CqEoIfFQWU-okRJN/_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/typecastleinc/CqEoIfFQWU-okRJN/_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/typecastleinc/CqEoIfFQWU-okRJN/_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/typecastleinc/CqEoIfFQWU-okRJN/_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/typecastleinc/CqEoIfFQWU-okRJN/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Link Token - Subtotal Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a durable customer-scoped Subtotal Link token\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Subtotal Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.subtotal.com/docs/api-reference/link-tokens/create-link-token\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://typecastleinc.mintlify.site/_mintlify/api/og/v2?division=Link+Tokens\u0026amp;title=Create+Link+Token\u0026amp;description=Create+a+durable+customer-scoped+Subtotal+Link+token\u0026amp;theme=aec1f4808270fdc80a1903ce\u0026amp;signature=b149cd80785ad18556879a7503404b49474b46997255fb27345d0783e084e034\">\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 Link Token - Subtotal Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a durable customer-scoped Subtotal Link token\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://typecastleinc.mintlify.site/_mintlify/api/og/v2?division=Link+Tokens\u0026amp;title=Create+Link+Token\u0026amp;description=Create+a+durable+customer-scoped+Subtotal+Link+token\u0026amp;theme=aec1f4808270fdc80a1903ce\u0026amp;signature=b149cd80785ad18556879a7503404b49474b46997255fb27345d0783e084e034\">\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/typecastleinc/CqEoIfFQWU-okRJN/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Subtotal Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#912DA8\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.subtotal.com/docs/api-reference/link-tokens/create-link-token\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/link-tokens/create-link-token.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.subtotal.com/#organization\",\"name\":\"Subtotal Docs\",\"url\":\"https://docs.subtotal.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/typecastleinc/d5UA7eGR6OP4SNAc/logo/light.svg?fit=max\u0026auto=format\u0026n=d5UA7eGR6OP4SNAc\u0026q=85\u0026s=92869634e0f56df8f5c3f380760324ec\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.subtotal.com#website\",\"name\":\"Subtotal Docs\",\"url\":\"https://docs.subtotal.com\",\"publisher\":{\"@id\":\"https://docs.subtotal.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.subtotal.com/docs/api-reference/link-tokens/create-link-token#webpage\",\"url\":\"https://docs.subtotal.com/docs/api-reference/link-tokens/create-link-token\",\"name\":\"Create Link Token\",\"description\":\"Create a durable customer-scoped Subtotal Link token\",\"dateModified\":\"2026-11-13T23:19:29.323Z\",\"isPartOf\":{\"@id\":\"https://docs.subtotal.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.subtotal.com/docs/api-reference/link-tokens/create-link-token#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.subtotal.com/docs/api-reference/link-tokens/create-link-token#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Subtotal Docs\",\"item\":\"https://docs.subtotal.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Link Token\",\"item\":\"https://docs.subtotal.com/docs/api-reference/link-tokens/create-link-token\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.subtotal.com/docs/api-reference/link-tokens/create-link-token#apireference\",\"headline\":\"Create Link Token\",\"name\":\"Create Link Token\",\"description\":\"Create a durable customer-scoped Subtotal Link token\",\"url\":\"https://docs.subtotal.com/docs/api-reference/link-tokens/create-link-token\",\"mainEntityOfPage\":{\"@id\":\"https://docs.subtotal.com/docs/api-reference/link-tokens/create-link-token#webpage\"},\"dateModified\":\"2026-11-13T23:19:29.323Z\",\"publisher\":{\"@id\":\"https://docs.subtotal.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.subtotal.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Subtotal Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Subtotal Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/docs/api-reference/link-tokens/create-link-token.md","siteName":"Subtotal Docs","nav":{"global":null,"anchors":[{"anchor":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/docs/introduction"}]},{"anchor":"API Reference","icon":"code","groups":[{"group":"API Reference","pages":[{"title":"Subtotal API","sidebarTitle":"Introduction","href":"/docs/api-reference/introduction"}]},{"group":"Account","pages":[{"openapi":"get /account","title":"Get Account","href":"/docs/api-reference/account/get-account"},{"openapi":"get /usage","title":"Get Usage","href":"/docs/api-reference/account/get-usage"}]},{"group":"Connections","pages":[{"openapi":"post /connections","title":"Create Connection","href":"/docs/api-reference/connections/create-connection"},{"openapi":"get /connections/{connection_id}","title":"Get Connection","href":"/docs/api-reference/connections/get-connection"},{"openapi":"get /connections","title":"Get Connections","href":"/docs/api-reference/connections/get-connections"},{"openapi":"get /connections/{connection_id}/activity","title":"Get Connection Activity Log","href":"/docs/api-reference/connections/get-connection-activity"},{"openapi":"get /connections/{connection_id}/purchases","title":"Get Connection Purchases","href":"/docs/api-reference/connections/get-connection-purchases"},{"openapi":"patch /connections/{connection_id}","title":"Update Connection","href":"/docs/api-reference/connections/update-connection"},{"openapi":"delete /connections/{connection_id}","title":"Delete Connection","description":"Delete a connection","href":"/docs/api-reference/connections/delete-connection"}]},{"group":"Link Tokens","pages":[{"openapi":"post /link-tokens","title":"Create Link Token","href":"/docs/api-reference/link-tokens/create-link-token"},{"openapi":"get /link-tokens","title":"List Link Tokens","description":"List link-token metadata without returning bearer secrets or consumer contact fields","href":"/docs/api-reference/link-tokens/get-link-tokens"},{"openapi":"delete /link-tokens/{link_token}","title":"Revoke Link Token","href":"/docs/api-reference/link-tokens/revoke-link-token"}]},{"group":"Connection Tokens","pages":[{"openapi":"post /connections/{connection_id}/token","title":"Create Connection Token","href":"/docs/api-reference/connections/create-connection-token"}]},{"group":"Purchases","pages":[{"openapi":"get /purchases","title":"Get Purchases","href":"/docs/api-reference/purchases/get-purchases"},{"openapi":"get /purchases/{purchase_id}","title":"Get Purchase","href":"/docs/api-reference/purchases/get-purchase"}]},{"group":"Products","pages":[{"openapi":"get /products","title":"Get Products","href":"/docs/api-reference/products/get-products"},{"openapi":"get /products/{product_id}","title":"Get Product","href":"/docs/api-reference/products/get-product"}]},{"group":"Product groups","pages":[{"openapi":"get /product-groups","title":"List Product Groups","href":"/docs/api-reference/product-groups/list-product-groups"},{"openapi":"post /product-groups","title":"Create Product Group","href":"/docs/api-reference/product-groups/create-product-group"},{"openapi":"patch /product-groups/{product_group_id}","title":"Rename Product Group","href":"/docs/api-reference/product-groups/rename-product-group"},{"openapi":"delete /product-groups/{product_group_id}","title":"Delete Product Group","href":"/docs/api-reference/product-groups/delete-product-group"},{"openapi":"put /product-groups/{product_group_id}/products","title":"Update Product Group Products","href":"/docs/api-reference/product-groups/update-product-group-products"}]},{"group":"Retailers","pages":[{"openapi":"get /retailers","title":"Get Retailers","href":"/docs/api-reference/retailers/get-retailers"},{"openapi":"patch /retailers/{retailer_id}","title":"Update Retailer","href":"/docs/api-reference/retailers/update-retailer"}]},{"group":"Event simulator","pages":[{"openapi":"post /simulated-connections","title":"Simulate Connection","href":"/docs/api-reference/simulated-connections/simulate-connection"},{"openapi":"post /simulated-connections/{connection_id}/purchases","title":"Simulate Purchase","href":"/docs/api-reference/simulated-connections/simulate-purchase"},{"openapi":"patch /simulated-connections/{connection_id}","title":"Set Simulated Status","href":"/docs/api-reference/simulated-connections/set-simulated-status"},{"openapi":"delete /simulated-connections/{connection_id}","title":"Delete Simulated Connection","href":"/docs/api-reference/simulated-connections/delete-simulated-connection"}]},{"group":"Webhooks","pages":[{"openapi":"get /webhooks","title":"List Webhooks","href":"/docs/api-reference/webhooks/get-webhooks"},{"openapi":"post /webhooks","title":"Create Webhook","href":"/docs/api-reference/webhooks/create-webhook"},{"openapi":"patch /webhooks/{webhook_id}","title":"Update Webhook","href":"/docs/api-reference/webhooks/update-webhook"},{"openapi":"delete /webhooks/{webhook_id}","title":"Delete Webhook","href":"/docs/api-reference/webhooks/delete-webhook"}]}]},{"anchor":"Create an API key","icon":"key","href":"https://dashboard.subtotal.com/api-keys"}]},"basePath":"","title":"Create Link Token - Subtotal Docs","deploymentId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","buildId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B6WFFOBL.js","utils-BN5um1KA.js","cloneDeep-C3md22mN.js","_Uint8Array-DLlL8L26.js","isObject-FP1Yky1u.js","utils-BSmbkXJR.js","addUniqueKeysToSchema-2tqcVnUE.js","snippetPresets-CtWfvr2J.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DkKHBy30.js","isEqual-O3q7y6pq.js","usePlaygroundInputsStore-Brc5H9UJ.js","shallow-C4L4xvbs.js","getApiPlaygroundDisplay-2bxyq_aI.js","CodeSnippet-BJu8ddd5.js","CodeSnippets-dazWmoqB.js","Page-CnLhKuUV.js","getPastedJson-Chy3Qa1S.js","icon-CyO7h3jh.js","MethodPill-Dle0_91v.js","DuplicateIcon-CVvWAf4a.js","createIcon-Di07A27B.js","DynamicMarkdown-C4w9kavL.js","SectionHeading-XiBebVYC.js","axios-vUo_bRtp.js","Markdown-DTeL0SpS.js","dist-OCScizqf.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-KcneGfMY.js"]}