Retrieve a single invoice by ID. Returns 404 if it does not belong
to the authenticated company.
This endpoint lazily provisions wire-transfer funding details
for invoices that opted into bank_transfer but didn’t have
bankTransferInstructions populated at create time (eg. Stripe
Customer Balance was not yet enabled on the account). Polling
this endpoint after creation is the recommended way to surface
wire details to your end user once the merchant fixes their
Stripe configuration.
The hosted invoice page (hostedInvoiceUrl) and PDF (pdfUrl)
are stable URLs — safe to cache or share.
GET
/
invoices
/
{invoiceId}
Get invoice
curl --request GET \ --url https://app.sideshift.app/api/v1/invoices/{invoiceId} \ --header 'x-api-key: <api-key>'
API key for authentication. Get yours from Settings → Integrations. A key created by a team member acts as that member and follows their current team permissions; a request outside those permissions returns 403 { "error": "insufficient_scope", "scope": "<required>" }.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"SideShift","description":"API documentation for SideShift — campaign operations, embedded payments, and social data.","colors":{"primary":"#2E6FE0","light":"#3C83F9","dark":"#2E6FE0"},"logo":{"light":"https://mintcdn.com/sideshift/oTyWBbQpawmh0yna/logo/light.svg?fit=max\u0026auto=format\u0026n=oTyWBbQpawmh0yna\u0026q=85\u0026s=067b5f4d28c1d362dd1035d42fd4cf61","dark":"https://mintcdn.com/sideshift/oTyWBbQpawmh0yna/logo/light.svg?fit=max\u0026auto=format\u0026n=oTyWBbQpawmh0yna\u0026q=85\u0026s=067b5f4d28c1d362dd1035d42fd4cf61","href":"https://sideshift.app"},"favicon":"https://mintcdn.com/sideshift/oTyWBbQpawmh0yna/favicon.svg?fit=max\u0026auto=format\u0026n=oTyWBbQpawmh0yna\u0026q=85\u0026s=9a8515441d19975691d5531716a644ba","appearance":{"default":"light","strict":true},"background":{"color":{"light":"#FFFFFF"}},"navbar":{"links":[{"href":"https://app.sideshift.app","label":"Dashboard"}],"primary":{"type":"button","label":"Choose OAuth flow","href":"/authentication"}},"fonts":{"family":"Geist"},"icons":{"library":"lucide"},"styling":{"eyebrows":"breadcrumbs","codeblocks":"system","latex":true},"contextual":{"options":["copy","view","chatgpt","claude","cursor","vscode"],"display":"header"},"interaction":{"drilldown":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"sideshift","hasAudioNarration":false,"actualSubdomain":"sideshift","customDomains":["docs.sideshift.app"],"gitSource":{"type":"github","owner":"sideshiftapp","repo":"sideshift-monorepo","deployBranch":"main","contentDirectory":"docs-site","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aefd72dd5518ba96e474103","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"default","tag":"Platform API","count":395},{"language":"default","tag":"OAuth 2.1 \u0026 MCP","count":351},{"language":"default","tag":"Content \u0026 Analytics","count":112},{"language":"default","tag":"Reference","count":109},{"language":"default","tag":"Scraper","count":77},{"language":"default","tag":"Payments \u0026 Finance","count":68},{"language":"default","tag":"Ads","count":58},{"language":"default","tag":"Company \u0026 Team","count":56},{"language":"default","tag":"Creators \u0026 Recruiting","count":52},{"language":"default","tag":"Connect","count":50}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"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":"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":"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":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":":root{--ds-blue: #3c83f9;--ds-blue-light: #ebf2fe;--ds-blue-mid: #7eb4ff;--ds-text-primary: #202020;--ds-text-secondary: #707070;--ds-text-tertiary: #979a9b;--ds-surface: #ffffff;--ds-surface-secondary: #fafafa;--ds-surface-page: #f6f6f6;--ds-surface-muted: #7b818c0d;--ds-surface-inverse: #202020;--ds-border: #20202014;--ds-border-strong: #20202029;--ds-radius-sm: 8px;--ds-radius-md: 12px;--ds-radius-lg: 16px;--ds-shadow-xs: 0px 1px 2px 0px #6865650f;--ds-shadow-sm: 0px 2px 4px -1px #01416314;--ds-shadow-md: 0px 4px 8px -2px #0141631a, 0px 2px 4px -1px #0141630f;--ds-shadow-lg: 0px 12px 24px -4px #0141631a, 0px 4px 8px -2px #0141630a;--ds-shadow-card: 0px 2px 4px -1px #01416314, 0px 0px 0px 1px #20202014;--ds-tracking-tight: -0.02em;--ds-heading-weight: 550;--ds-body-weight: 350;--ds-button-weight: 600}#navbar>div:first-child{background-color:var(--ds-surface)!important;backdrop-filter:none!important;-webkit-backdrop-filter:none!important;transition:none!important;border-bottom-color:var(--ds-border)!important}.sidebar-group-header{border-top:1px solid var(--ds-border);padding-top:1rem;margin-right:0.9rem}ul.sidebar-group:first-child{border-top:1px solid var(--ds-border);padding-top:1rem;margin-right:0.9rem}ul.sidebar-group:has(>li>ul>li>button)>li>button{font-weight:600;color:var(--ds-text-primary)}ul.sidebar-group>li:has(>ul>li>button)+li:has(>ul>li>button){margin-top:1.1rem;padding-top:1.1rem;border-top:1px solid var(--ds-border);margin-right:0.9rem}ul.sidebar-group>li:has(>ul>li>button)>ul{position:relative}ul.sidebar-group>li:has(>ul>li>button)>ul::before{content:\"\";position:absolute;left:8px;top:0.15rem;bottom:0.15rem;width:1px;border-radius:1px;background:var(--ds-border-strong);transition:background-color 0.18s ease}ul.sidebar-group>li:has(>ul>li>button)>ul:has([data-active-nav-item=\"true\"])::before{background:var(--ds-blue)}ul.sidebar-group:has(>li>button):not(:has(>li>ul>li>button)){position:relative}ul.sidebar-group:has(>li>button):not(:has(>li>ul>li>button))::before{content:\"\";position:absolute;left:0;top:0.15rem;bottom:0.15rem;width:1px;border-radius:1px;background:var(--ds-border-strong);transition:background-color 0.18s ease}ul.sidebar-group:has(>li>button):not(:has(>li>ul>li>button)):has([data-active-nav-item=\"true\"])::before{background:var(--ds-blue)}.sidebar-group-header+ul.sidebar-group:not(:has(button)){position:relative}.sidebar-group-header+ul.sidebar-group:not(:has(button))::before{content:\"\";position:absolute;left:0;top:0.15rem;bottom:0.15rem;width:1px;border-radius:1px;background:var(--ds-border-strong);transition:background-color 0.18s ease}.sidebar-group-header+ul.sidebar-group:not(:has(button)):has([data-active-nav-item=\"true\"])::before{background:var(--ds-blue)}#navigation-items>ul.sidebar-group:not(:has(li+li)){position:relative;padding-top:0;margin-top:16px}#navigation-items>ul.sidebar-group:not(:has(li+li))::before{content:\"\";position:absolute;left:0;top:0.15rem;bottom:0.15rem;width:1px;border-radius:1px;background:var(--ds-border-strong);transition:background-color 0.18s ease}#navigation-items>ul.sidebar-group:not(:has(li+li)):has([data-active-nav-item=\"true\"])::before{background:var(--ds-blue)}#navigation-items>ul.sidebar-group:not(:has(li+li)) li:has(>a:hover)::after{content:\"\";position:absolute;top:1px;bottom:1px;left:-1px;width:3px;border-radius:3px;background:var(--ds-blue);pointer-events:none}ul.sidebar-group li{position:relative}ul.sidebar-group>li:has(>ul>li>button)>ul li:has(>button:hover)::after,ul.sidebar-group>li:has(>ul>li>button)>ul li:has(>a:hover)::after,ul.sidebar-group:has(>li>button):not(:has(>li>ul>li>button)) li:has(>button:hover)::after,ul.sidebar-group:has(>li>button):not(:has(>li>ul>li>button)) li:has(>a:hover)::after,.sidebar-group-header+ul.sidebar-group:not(:has(button)) li:has(>a:hover)::after{content:\"\";position:absolute;top:1px;bottom:1px;width:3px;border-radius:3px;background:var(--ds-blue);pointer-events:none}ul.sidebar-group>li:has(>ul>li>button)>ul li:has(>button:hover)::after,ul.sidebar-group>li:has(>ul>li>button)>ul li:has(>a:hover)::after{left:7px}ul.sidebar-group:has(>li>button):not(:has(>li>ul>li>button)) li:has(>button:hover)::after,ul.sidebar-group:has(>li>button):not(:has(>li>ul>li>button)) li:has(>a:hover)::after,.sidebar-group-header+ul.sidebar-group:not(:has(button)) li:has(>a:hover)::after{left:-1px}ul.sidebar-group>li:has(>ul>li>button):has(>button:hover)>ul::before{background:var(--ds-blue);width:3px;left:6.5px}ul.sidebar-group li:has(>a[aria-current=\"page\"])>a{background-color:transparent!important;position:relative}ul.sidebar-group li:has(>a[aria-current=\"page\"])::before{content:\"\";position:absolute;top:0;bottom:0;left:0;right:0;border-radius:12px;background:rgb(60 131 249 / 0.1);pointer-events:none}ul.sidebar-group>li:has(>ul>li>button)>ul li:has(>a[aria-current=\"page\"])::before{left:12px}ul.sidebar-group:has(>li>button):not(:has(>li>ul>li>button)) li:has(>a[aria-current=\"page\"])::before{left:4px}ul.sidebar-group>li:has(>ul>li>button)>button:hover,ul.sidebar-group>li:has(>ul>li>button)>ul li>button:hover,ul.sidebar-group>li:has(>ul>li>button)>ul li>a:not([aria-current=\"page\"]):hover,ul.sidebar-group:has(>li>button):not(:has(>li>ul>li>button)) li>button:hover,ul.sidebar-group:has(>li>button):not(:has(>li>ul>li>button)) li>a:not([aria-current=\"page\"]):hover{background-color:transparent!important}li[id$=\"/depositpending\"] .method-nav-pill>span[class*=\"bg-blue-400\"],li[id$=\"/depositconfirmed\"] .method-nav-pill>span[class*=\"bg-blue-400\"],li[id$=\"/depositfailed\"] .method-nav-pill>span[class*=\"bg-blue-400\"],li[id$=\"/transfercompleted\"] .method-nav-pill>span[class*=\"bg-blue-400\"],li[id$=\"/withdrawalcreated\"] .method-nav-pill>span[class*=\"bg-blue-400\"],li[id$=\"/withdrawalupdated\"] .method-nav-pill>span[class*=\"bg-blue-400\"],li[id$=\"/withdrawalcompleted\"] .method-nav-pill>span[class*=\"bg-blue-400\"],li[id$=\"/accountrisk_flagged\"] .method-nav-pill>span[class*=\"bg-blue-400\"]{background-color:rgb(167 139 250 / 0.22)!important;color:#6d28d9!important}li[id$=\"/depositpending\"] .method-nav-pill>span[class*=\"3064E3\"],li[id$=\"/depositconfirmed\"] .method-nav-pill>span[class*=\"3064E3\"],li[id$=\"/depositfailed\"] .method-nav-pill>span[class*=\"3064E3\"],li[id$=\"/transfercompleted\"] .method-nav-pill>span[class*=\"3064E3\"],li[id$=\"/withdrawalcreated\"] .method-nav-pill>span[class*=\"3064E3\"],li[id$=\"/withdrawalupdated\"] .method-nav-pill>span[class*=\"3064E3\"],li[id$=\"/withdrawalcompleted\"] .method-nav-pill>span[class*=\"3064E3\"],li[id$=\"/accountrisk_flagged\"] .method-nav-pill>span[class*=\"3064E3\"]{background-color:#6d28d9!important;color:#ffffff!important}html:has(li[id$=\"/depositpending\"][data-active-nav-item=\"true\"]) .method-pill[class*=\"bg-blue-400\"],html:has(li[id$=\"/depositconfirmed\"][data-active-nav-item=\"true\"]) .method-pill[class*=\"bg-blue-400\"],html:has(li[id$=\"/depositfailed\"][data-active-nav-item=\"true\"]) .method-pill[class*=\"bg-blue-400\"],html:has(li[id$=\"/transfercompleted\"][data-active-nav-item=\"true\"]) .method-pill[class*=\"bg-blue-400\"],html:has(li[id$=\"/withdrawalcreated\"][data-active-nav-item=\"true\"]) .method-pill[class*=\"bg-blue-400\"],html:has(li[id$=\"/withdrawalupdated\"][data-active-nav-item=\"true\"]) .method-pill[class*=\"bg-blue-400\"],html:has(li[id$=\"/withdrawalcompleted\"][data-active-nav-item=\"true\"]) .method-pill[class*=\"bg-blue-400\"],html:has(li[id$=\"/accountrisk_flagged\"][data-active-nav-item=\"true\"]) .method-pill[class*=\"bg-blue-400\"]{background-color:rgb(167 139 250 / 0.22)!important;color:#6d28d9!important}.prose table,main table{display:block;width:100%;overflow-x:auto}.ss-page{max-width:72rem;margin:0 auto;padding:4.5rem 2rem 6rem}@media (max-width: 640px){.ss-page{padding:2.5rem 1.15rem 3.5rem}}.ss-hero{padding:0 0 3.5rem}.ss-hero__eyebrow{display:inline-flex;align-items:center;gap:0.45rem;font-size:12px;font-weight:var(--ds-button-weight);letter-spacing:0.055em;text-transform:uppercase;color:var(--ds-blue);background:var(--ds-blue-light);border-radius:9999px;padding:0.32rem 0.75rem;margin-bottom:1.35rem}.ss-hero__eyebrow::before{content:\"\";width:6px;height:6px;border-radius:50%;background:var(--ds-blue)}.ss-hero h1{font-size:clamp(2.5rem, 5vw, 3.6rem);line-height:1.05;letter-spacing:-0.03em;font-weight:700;margin:0 0 1.1rem;color:var(--ds-text-primary)}.ss-hero h1 .ss-accent{color:var(--ds-blue)}.ss-hero p{font-size:1.1875rem;font-weight:var(--ds-body-weight);line-height:1.6;color:var(--ds-text-secondary);max-width:44rem;margin:0}.ss-hero p+.ss-hero__sub{font-size:1.0625rem;margin-top:1rem;color:var(--ds-text-tertiary)}.ss-rows{display:grid;grid-template-columns:repeat(3, minmax(0, 1fr));gap:1rem;margin:0 0 4rem;align-items:stretch}@media (max-width: 1080px){.ss-rows{grid-template-columns:repeat(2, minmax(0, 1fr))}}@media (max-width: 700px){.ss-rows{grid-template-columns:minmax(0, 1fr)}}.ss-row{display:flex;flex-direction:column;padding:1.6rem;border-radius:var(--ds-radius-lg);background:var(--ds-surface);box-shadow:var(--ds-shadow-card);text-decoration:none!important;transition:transform 0.16s ease, box-shadow 0.16s ease}.ss-row:hover{transform:translateY(-2px);box-shadow:var(--ds-shadow-lg), 0px 0px 0px 1px var(--ds-border-strong)}.ss-row__icon{display:block;width:4rem;height:4rem;flex:none;margin:0 0 1rem}.ss-row__title{font-size:1.25rem;font-weight:var(--ds-heading-weight);letter-spacing:var(--ds-tracking-tight);color:var(--ds-text-primary);margin:0 0 0.45rem}.ss-row__desc{font-size:0.9375rem;font-weight:var(--ds-body-weight);line-height:1.55;color:var(--ds-text-secondary);margin:0 0 1.1rem}.ss-row__aside{margin-top:auto;border-top:1px solid var(--ds-border);padding-top:0.95rem;display:flex;flex-direction:column;gap:0.85rem}.ss-row__pick{font-size:13px;line-height:1.5;font-weight:var(--ds-body-weight);color:var(--ds-text-secondary);margin:0}.ss-row__pick strong{color:var(--ds-text-primary);font-weight:600}.ss-tile__icon{display:inline-flex;align-items:center;justify-content:center;width:2.5rem;height:2.5rem;border-radius:var(--ds-radius-md);background:var(--ds-blue-light);color:var(--ds-blue)}.ss-tile__badge{display:inline-block;font-size:12px;font-weight:var(--ds-button-weight);letter-spacing:0.04em;text-transform:uppercase;padding:0.25rem 0.6rem;border-radius:9999px;white-space:nowrap;color:var(--ds-blue);background:var(--ds-blue-light)}.ss-tile__badge--muted{color:var(--ds-text-secondary);background:var(--ds-surface-muted);box-shadow:inset 0 0 0 1px var(--ds-border)}.ss-tile__title{font-size:1.28rem;font-weight:var(--ds-heading-weight);letter-spacing:var(--ds-tracking-tight);color:var(--ds-text-primary);margin:0 0 0.5rem}.ss-tile__desc{font-size:0.9375rem;font-weight:var(--ds-body-weight);line-height:1.58;color:var(--ds-text-secondary);margin:0 0 1.15rem}.ss-tile__list{list-style:none!important;padding:0!important;margin:0 0 1.35rem!important;display:flex;flex-wrap:wrap;gap:0.375rem}.ss-tile__list li{list-style:none!important;font-size:13px;font-weight:500;color:var(--ds-text-secondary);background:var(--ds-surface-muted);box-shadow:inset 0 0 0 1px var(--ds-border);border-radius:var(--ds-radius-sm);padding:0.2rem 0.5rem!important;margin:0!important}.ss-tile__list li::marker,.ss-tile__list li::before{content:none!important;display:none!important}.ss-tile__foot{display:flex;align-items:center;gap:0.4rem;font-size:14px;font-weight:var(--ds-button-weight);color:var(--ds-blue);white-space:nowrap}.ss-tile__foot svg{transition:transform 0.16s ease}.ss-row:hover .ss-tile__foot svg{transform:translateX(3px)}.ss-jump{display:grid;grid-template-columns:repeat(3, minmax(0, 1fr));gap:0.875rem}@media (max-width: 860px){.ss-jump{grid-template-columns:minmax(0, 1fr)}}.ss-jump__card{display:flex;align-items:center;gap:0.85rem;padding:1rem 1.1rem;border-radius:var(--ds-radius-md);background:var(--ds-surface);box-shadow:var(--ds-shadow-card);text-decoration:none!important;transition:background-color 0.16s ease, box-shadow 0.16s ease}.ss-jump__card:hover{background:var(--ds-surface-secondary);box-shadow:var(--ds-shadow-card), inset 0px 0px 0px 1px var(--ds-border-strong)}.ss-jump__icon{width:2.5rem;height:2.5rem;flex:none;margin:0}.ss-jump__text{display:flex;flex-direction:column;gap:0.15rem;min-width:0}.ss-jump__title{font-size:0.9375rem;font-weight:600;letter-spacing:var(--ds-tracking-tight);color:var(--ds-text-primary)}.ss-jump__desc{font-size:13px;font-weight:var(--ds-body-weight);line-height:1.45;color:var(--ds-text-secondary)}.ss-section-label{font-size:12px;font-weight:var(--ds-button-weight);letter-spacing:0.075em;text-transform:uppercase;color:var(--ds-text-tertiary);margin:0 0 1rem}.ss-fork{display:grid;grid-template-columns:repeat(2, minmax(0, 1fr));gap:0.875rem;margin:0 0 2rem}@media (max-width: 720px){.ss-fork{grid-template-columns:minmax(0, 1fr)}}.ss-fork__card{display:flex;flex-direction:column;padding:1.25rem;border-radius:var(--ds-radius-md);background:var(--ds-surface);box-shadow:var(--ds-shadow-card);text-decoration:none!important;transition:transform 0.16s ease, box-shadow 0.16s ease}.ss-fork__card:hover{transform:translateY(-2px);box-shadow:var(--ds-shadow-md), 0px 0px 0px 1px var(--ds-border-strong)}.ss-fork__card--recommended{background:var(--ds-blue-light);box-shadow:0px 0px 0px 1px #3c83f92e}.ss-fork__card--recommended:hover{box-shadow:var(--ds-shadow-md), 0px 0px 0px 1px #3c83f94d}.ss-fork__card--recommended .ss-tile__badge{background:var(--ds-surface);color:var(--ds-blue);box-shadow:inset 0 0 0 1px #3c83f92e}.ss-fork__head{display:flex;align-items:center;gap:0.6rem;flex-wrap:wrap;margin-bottom:0.55rem}.ss-fork__name{font-size:1.05rem;font-weight:var(--ds-heading-weight);letter-spacing:var(--ds-tracking-tight);color:var(--ds-text-primary);margin:0}.ss-fork__desc{font-size:0.9rem;font-weight:var(--ds-body-weight);line-height:1.55;color:var(--ds-text-secondary);margin:0 0 0.9rem}.ss-fork__meta{margin-top:auto;font-size:12px;color:var(--ds-text-tertiary);font-family:ui-monospace, SFMono-Regular, Menlo, monospace;border-top:1px solid var(--ds-border);padding-top:0.7rem}:not(pre)>code{padding-left:4px;padding-right:4px;margin-left:-2px;margin-right:-2px}.shiki,.shiki span{white-space:pre}.ss-credit{display:flex;width:fit-content;align-items:center;gap:0.45rem;margin-top:4px;padding:0.45rem 0.8rem;border:1px solid var(--ds-blue-mid);border-radius:var(--ds-radius-sm);background:var(--ds-blue-light);font-size:14px;font-weight:var(--ds-body-weight);line-height:1;color:var(--ds-blue);white-space:nowrap}.ss-credit+*{margin-top:12px!important}.ss-credit::before{content:\"\";flex:none;width:15px;height:15px;background:url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 16 16' fill='none' stroke='%233c83f9' stroke-width='1.4' stroke-linecap='round'%3E%3Ccircle cx='8' cy='8' r='6.1'/%3E%3Cpath d='M8 4.7v6.6M6.3 6.5h3.4M6.3 9.5h3.4'/%3E%3C/svg%3E\") center / contain no-repeat}.ss-credit strong{color:var(--ds-text-primary);font-weight:var(--ds-button-weight)}#sidebar{width:var(--ss-sidebar-w, 18rem)!important}#sidebar{border-right:1px solid var(--ds-border)}#sidebar>div{right:10px!important}#sidebar [class*=\"scroll-area-fade-size\"]{padding-right:22px}.ss-sidebar-handle{position:relative;flex:none;align-self:stretch;width:9px;margin-left:-4px;margin-right:-5px;z-index:30;cursor:col-resize;background:transparent;touch-action:none}.ss-sidebar-handle::after{content:\"\";position:absolute;top:0;bottom:0;left:4px;width:1px;background:transparent;transition:background-color 0.12s ease, width 0.12s ease, left 0.12s ease}.ss-sidebar-handle:hover::after{left:3px;width:3px;background:var(--ds-blue-mid)}.ss-sidebar-handle:focus-visible{outline:none}.ss-sidebar-handle:focus-visible::after,html.ss-resizing .ss-sidebar-handle::after{left:3px;width:3px;background:var(--ds-blue)}html.ss-resizing,html.ss-resizing *{cursor:col-resize!important;user-select:none!important}html[data-ss-sidebar-collapsed=\"true\"] #sidebar{overflow:hidden}html[data-ss-sidebar-collapsed=\"true\"] #sidebar>*{visibility:hidden}@media (max-width: 1023px){.ss-sidebar-handle{display:none}#sidebar{width:auto!important;border-right:0}}#sidebar ul.sidebar-group :is(a,button)>div>div{flex-wrap:nowrap}#sidebar ul.sidebar-group :is(a,button) span{white-space:nowrap;overflow:hidden;text-overflow:ellipsis;word-break:normal;hyphens:none}#sidebar ul.sidebar-group :is(a,button){align-items:center}.ss-launch{display:flex;align-items:center;justify-content:space-between;gap:1rem;margin:1.5rem 0;padding:1.1rem 1.25rem;border-radius:var(--ds-radius-md);background:var(--ds-surface);box-shadow:var(--ds-shadow-card);text-decoration:none!important;transition:background-color 0.16s ease, box-shadow 0.16s ease}.ss-launch:hover{background:var(--ds-surface-secondary);box-shadow:var(--ds-shadow-card), inset 0px 0px 0px 1px var(--ds-border-strong)}.ss-launch__body{display:flex;flex-direction:column;gap:0.15rem;min-width:0}.ss-launch__title{font-size:0.95rem;font-weight:var(--ds-button-weight);letter-spacing:var(--ds-tracking-tight);color:var(--ds-text-primary)}.ss-launch__sub{font-size:0.825rem;color:var(--ds-text-secondary)}.ss-launch__arrow{flex:none;font-size:1.05rem;line-height:1;color:var(--ds-blue);transition:transform 0.16s ease}.ss-launch:hover .ss-launch__arrow{transform:translate(2px, -2px)}.ss-modal{position:fixed;inset:0;z-index:100;display:flex;align-items:center;justify-content:center;padding:clamp(0.75rem, 3vw, 2.5rem);background:#20202066;animation:ss-modal-in 0.16s ease}.ss-modal[hidden]{display:none}.ss-modal[data-instant=\"true\"]{animation:none}@keyframes ss-modal-in{from{opacity:0}to{opacity:1}}.ss-modal__panel{display:flex;flex-direction:column;width:min(1240px, 100%);height:min(920px, 100%);overflow:hidden;border-radius:var(--ds-radius-lg);background:var(--ds-surface);box-shadow:var(--ds-shadow-lg), 0px 0px 0px 1px var(--ds-border-strong)}.ss-modal__bar{display:flex;flex:none;align-items:center;justify-content:space-between;gap:1rem;padding:0.7rem 0.9rem 0.7rem 1.1rem;border-bottom:1px solid var(--ds-border);background:var(--ds-surface)}.ss-modal__title{font-size:0.9rem;font-weight:var(--ds-button-weight);letter-spacing:var(--ds-tracking-tight);color:var(--ds-text-primary)}.ss-modal__actions{display:flex;align-items:center;gap:0.6rem}.ss-modal__link{font-size:0.8rem;color:var(--ds-text-secondary);text-decoration:none!important}.ss-modal__link:hover{color:var(--ds-text-primary)}.ss-modal__close{display:flex;align-items:center;justify-content:center;width:1.9rem;height:1.9rem;border:0;border-radius:var(--ds-radius-sm);background:transparent;font-size:1.3rem;line-height:1;color:var(--ds-text-secondary);cursor:pointer;transition:background-color 0.14s ease, color 0.14s ease}.ss-modal__close:hover{background:var(--ds-surface-secondary);color:var(--ds-text-primary)}.ss-modal__frame{flex:1 1 auto;width:100%;min-height:0;border:0;display:block}html.ss-modal-open,html.ss-modal-open body{overflow:hidden}html.ss-modal-open body{padding-right:var(--ss-modal-gap, 0px)}@media (prefers-reduced-motion: reduce){.ss-modal{animation:none}}.ss-modal__fallback{display:flex;flex:1 1 auto;flex-direction:column;align-items:center;justify-content:center;gap:0.9rem;padding:2rem;text-align:center}.ss-modal__fallback[hidden]{display:none}.ss-modal__fallback__text{margin:0;max-width:34ch;font-size:0.9rem;color:var(--ds-text-secondary)}.ss-modal__fallback__cta{padding:0.55rem 1.1rem;border-radius:var(--ds-radius-sm);background:var(--ds-blue);color:#fff!important;font-size:0.875rem;font-weight:var(--ds-button-weight);text-decoration:none!important}"}],"page":{"pagePath":"platform/api-key/invoices/get-invoice","slug":"/platform/api-key/invoices/get-invoice","pageMetadata":{"title":"Get invoice","description":"Retrieve a single invoice by ID. Returns 404 if it does not belong\nto the authenticated company.\n\n- This endpoint **lazily provisions** wire-transfer funding details\n for invoices that opted into `bank_transfer` but didn't have\n `bankTransferInstructions` populated at create time (eg. Stripe\n Customer Balance was not yet enabled on the account). Polling\n this endpoint after creation is the recommended way to surface\n wire details to your end user once the merchant fixes their\n Stripe configuration.\n- The hosted invoice page (`hostedInvoiceUrl`) and PDF (`pdfUrl`)\n are stable URLs — safe to cache or share.\n","deprecated":null,"version":null,"openapi":"/openapi/platform-apikey.yaml get /invoices/{invoiceId}","href":"/platform/api-key/invoices/get-invoice","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n li: \"li\",\n p: \"p\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Retrieve a single invoice by ID. Returns 404 if it does not belong\\nto the authenticated company.\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [\"This endpoint \", _jsx(_components.strong, {\n children: \"lazily provisions\"\n }), \" wire-transfer funding details\\nfor invoices that opted into \", _jsx(_components.code, {\n children: \"bank_transfer\"\n }), \" but didn’t have\\n\", _jsx(_components.code, {\n children: \"bankTransferInstructions\"\n }), \" populated at create time (eg. Stripe\\nCustomer Balance was not yet enabled on the account). Polling\\nthis endpoint after creation is the recommended way to surface\\nwire details to your end user once the merchant fixes their\\nStripe configuration.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"The hosted invoice page (\", _jsx(_components.code, {\n children: \"hostedInvoiceUrl\"\n }), \") and PDF (\", _jsx(_components.code, {\n children: \"pdfUrl\"\n }), \")\\nare stable URLs — safe to cache or share.\"]\n }), \"\\n\"]\n })]\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":"system","config":{},"pageMetadata":{"title":"Get invoice","description":"Retrieve a single invoice by ID. Returns 404 if it does not belong\nto the authenticated company.\n\n- This endpoint **lazily provisions** wire-transfer funding details\n for invoices that opted into `bank_transfer` but didn't have\n `bankTransferInstructions` populated at create time (eg. Stripe\n Customer Balance was not yet enabled on the account). Polling\n this endpoint after creation is the recommended way to surface\n wire details to your end user once the merchant fixes their\n Stripe configuration.\n- The hosted invoice page (`hostedInvoiceUrl`) and PDF (`pdfUrl`)\n are stable URLs — safe to cache or share.\n","deprecated":null,"version":null,"openapi":"/openapi/platform-apikey.yaml get /invoices/{invoiceId}","href":"/platform/api-key/invoices/get-invoice","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/sideshift/87b877b70d161d1e/sidebar-state.js","/_mintlify/custom/sideshift/2e2d77d11acb5577/sidebar-resize.js","/_mintlify/custom/sideshift/ab0e397cf2c387df/playground-modal.js"],"openApiReferenceData":{"operation":{"tags":["Invoices"],"summary":"Get invoice","description":"Retrieve a single invoice by ID. Returns 404 if it does not belong\nto the authenticated company.\n\n- This endpoint **lazily provisions** wire-transfer funding details\n for invoices that opted into `bank_transfer` but didn't have\n `bankTransferInstructions` populated at create time (eg. Stripe\n Customer Balance was not yet enabled on the account). Polling\n this endpoint after creation is the recommended way to surface\n wire details to your end user once the merchant fixes their\n Stripe configuration.\n- The hosted invoice page (`hostedInvoiceUrl`) and PDF (`pdfUrl`)\n are stable URLs — safe to cache or share.\n","parameters":["419d3d80-89ff-49d0-93d0-1d44075f8abc"],"responses":{"200":"eed672ef-81e5-4921-99fa-257986617970","403":"9938fa1f-e381-46ee-90af-26985da07d54","404":"d2d0bdfd-dfa4-48cb-a467-d7bfa999db1e"},"method":"get","type":"path","servers":["6a0a8ca1-a9ed-44a6-80e9-2dd2b08dda3d"],"security":["7f161042-3fa3-4de5-9759-4a9cf30c0709"],"path":"/invoices/{invoiceId}","baseUrlOptions":["https://app.sideshift.app/api/v1"],"title":"Get invoice","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"419d3d80-89ff-49d0-93d0-1d44075f8abc":{"in":"path","name":"invoiceId","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"eed672ef-81e5-4921-99fa-257986617970":{"description":"Invoice retrieved","content":{"application/json":{"schema":{"type":"object","properties":{"invoice":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"invoice.id","typeLabel":"string"},"invoiceNumber":{"type":"string","uniqueKey":"invoice.invoiceNumber","typeLabel":"string"},"status":{"type":"string","enum":["open","pending","paid","void","overdue","refunded","partially_refunded"],"uniqueKey":"invoice.status","typeLabel":"enum\u003cstring>"},"customerId":{"oneOf":[{"type":"string","uniqueKey":"invoice.customerId.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"invoice.customerId.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice.customerId","typeLabel":"string | null"},"customerName":{"type":"string","uniqueKey":"invoice.customerName","typeLabel":"string"},"customerEmail":{"type":"string","format":"email","uniqueKey":"invoice.customerEmail","typeLabel":"string\u003cemail>"},"additionalEmails":{"type":"array","items":{"type":"string","format":"email","uniqueKey":"invoice.additionalEmails.items.[INDEX]","typeLabel":"string\u003cemail>"},"uniqueKey":"invoice.additionalEmails","typeLabel":"string\u003cemail>[]"},"customerAddress":{"oneOf":[{"type":"object","properties":{"line1":{"type":"string","uniqueKey":"invoice.customerAddress.oneOf.0.line1","typeLabel":"string"},"line2":{"type":"string","uniqueKey":"invoice.customerAddress.oneOf.0.line2","typeLabel":"string"},"city":{"type":"string","uniqueKey":"invoice.customerAddress.oneOf.0.city","typeLabel":"string"},"state":{"type":"string","uniqueKey":"invoice.customerAddress.oneOf.0.state","typeLabel":"string"},"postalCode":{"type":"string","uniqueKey":"invoice.customerAddress.oneOf.0.postalCode","typeLabel":"string"},"country":{"type":"string","uniqueKey":"invoice.customerAddress.oneOf.0.country","typeLabel":"string"}},"uniqueKey":"invoice.customerAddress.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"invoice.customerAddress.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice.customerAddress","typeLabel":"object | null"},"paymentType":{"type":"string","enum":["one_time","renewal"],"uniqueKey":"invoice.paymentType","typeLabel":"enum\u003cstring>"},"currency":{"type":"string","uniqueKey":"invoice.currency","typeLabel":"string"},"lineItems":{"type":"array","items":{"type":"object","required":["description","quantity","unitPriceCents"],"properties":{"description":{"type":"string","isRequired":true,"uniqueKey":"invoice.lineItems.items.[INDEX].description","typeLabel":"string"},"quantity":{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"invoice.lineItems.items.[INDEX].quantity","typeLabel":"integer"},"unitPriceCents":{"type":"integer","minimum":1,"description":"Per-unit price in integer cents.","isRequired":true,"uniqueKey":"invoice.lineItems.items.[INDEX].unitPriceCents","typeLabel":"integer"},"id":{"type":"string","description":"Server-assigned ID. Omit when creating an invoice.","readOnly":true,"uniqueKey":"invoice.lineItems.items.[INDEX].id","typeLabel":"string"},"amountCents":{"type":"integer","description":"`quantity * unitPriceCents`. Server-computed.","readOnly":true,"uniqueKey":"invoice.lineItems.items.[INDEX].amountCents","typeLabel":"integer"}},"uniqueKey":"invoice.lineItems.items.[INDEX]","typeLabel":"object"},"uniqueKey":"invoice.lineItems","typeLabel":"object[]"},"subtotalCents":{"type":"integer","uniqueKey":"invoice.subtotalCents","typeLabel":"integer"},"taxCents":{"type":"integer","uniqueKey":"invoice.taxCents","typeLabel":"integer"},"discountCents":{"type":"integer","uniqueKey":"invoice.discountCents","typeLabel":"integer"},"totalCents":{"type":"integer","uniqueKey":"invoice.totalCents","typeLabel":"integer"},"allowedPaymentTypes":{"type":"array","items":{"type":"string","uniqueKey":"invoice.allowedPaymentTypes.items.[INDEX]","typeLabel":"string"},"uniqueKey":"invoice.allowedPaymentTypes","typeLabel":"string[]"},"collectCustomerFee":{"type":"boolean","uniqueKey":"invoice.collectCustomerFee","typeLabel":"boolean"},"issueDate":{"type":"string","format":"date-time","uniqueKey":"invoice.issueDate","typeLabel":"string\u003cdate-time>"},"dueDate":{"type":"string","format":"date-time","uniqueKey":"invoice.dueDate","typeLabel":"string\u003cdate-time>"},"paidAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"invoice.paidAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"invoice.paidAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice.paidAt","typeLabel":"string\u003cdate-time> | null"},"voidedAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"invoice.voidedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"invoice.voidedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice.voidedAt","typeLabel":"string\u003cdate-time> | null"},"description":{"oneOf":[{"type":"string","uniqueKey":"invoice.description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"invoice.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice.description","typeLabel":"string | null"},"notes":{"oneOf":[{"type":"string","uniqueKey":"invoice.notes.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"invoice.notes.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice.notes","typeLabel":"string | null"},"terms":{"oneOf":[{"type":"string","uniqueKey":"invoice.terms.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"invoice.terms.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice.terms","typeLabel":"string | null"},"sendReminders":{"type":"boolean","uniqueKey":"invoice.sendReminders","typeLabel":"boolean"},"remindersSentCount":{"type":"integer","uniqueKey":"invoice.remindersSentCount","typeLabel":"integer"},"lastReminderSentAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"invoice.lastReminderSentAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"invoice.lastReminderSentAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice.lastReminderSentAt","typeLabel":"string\u003cdate-time> | null"},"hostedInvoiceUrl":{"type":"string","description":"Customer-facing payment URL. When the invoice allows BNPL rails,\nthe hosted page shows a **Pay now / Pay over time** picker.\n","uniqueKey":"invoice.hostedInvoiceUrl","typeLabel":"string"},"pdfUrl":{"type":"string","description":"PDF download URL.","uniqueKey":"invoice.pdfUrl","typeLabel":"string"},"bankTransferInstructions":{"oneOf":[{"type":"object","description":"Present when the invoice was created with `bank_transfer` in\n`allowedPaymentTypes` and Stripe successfully provisioned a\nvirtual bank account. Render account/routing/reference to the\ncustomer. Currently supports USD only (`us_bank_transfer`).\n","properties":{"type":{"type":"string","description":"Funding instruction region (e.g. `us_bank_transfer`).","enum":["us_bank_transfer","eu_bank_transfer","gb_bank_transfer","jp_bank_transfer","mx_bank_transfer"],"uniqueKey":"invoice.bankTransferInstructions.oneOf.0.type","typeLabel":"enum\u003cstring>"},"currency":{"type":"string","description":"Lowercase 3-letter ISO 4217 code.","uniqueKey":"invoice.bankTransferInstructions.oneOf.0.currency","typeLabel":"string"},"reference":{"type":"string","description":"Memo / reference code customers must include on the wire.","uniqueKey":"invoice.bankTransferInstructions.oneOf.0.reference","typeLabel":"string"},"hostedInstructionsUrl":{"oneOf":[{"type":"string","description":"Always returned as `null` on the public API. We deliberately\ndo not surface the Stripe-hosted instructions URL to API\nconsumers — render the structured fields below in your own UI.\n","uniqueKey":"invoice.bankTransferInstructions.oneOf.0.hostedInstructionsUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"Always returned as `null` on the public API. We deliberately\ndo not surface the Stripe-hosted instructions URL to API\nconsumers — render the structured fields below in your own UI.\n","uniqueKey":"invoice.bankTransferInstructions.oneOf.0.hostedInstructionsUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice.bankTransferInstructions.oneOf.0.hostedInstructionsUrl","typeLabel":"string | null"},"financialAddresses":{"type":"array","items":{"type":"object","description":"A receiving bank account customers can wire / ACH-credit funds to.","properties":{"bankName":{"oneOf":[{"type":"string","uniqueKey":"invoice.bankTransferInstructions.oneOf.0.financialAddresses.items.[INDEX].bankName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"invoice.bankTransferInstructions.oneOf.0.financialAddresses.items.[INDEX].bankName.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice.bankTransferInstructions.oneOf.0.financialAddresses.items.[INDEX].bankName","typeLabel":"string | null"},"accountNumber":{"oneOf":[{"type":"string","uniqueKey":"invoice.bankTransferInstructions.oneOf.0.financialAddresses.items.[INDEX].accountNumber.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"invoice.bankTransferInstructions.oneOf.0.financialAddresses.items.[INDEX].accountNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice.bankTransferInstructions.oneOf.0.financialAddresses.items.[INDEX].accountNumber","typeLabel":"string | null"},"routingNumber":{"oneOf":[{"type":"string","description":"ABA routing number for US transfers; six-digit sort code for GB.","uniqueKey":"invoice.bankTransferInstructions.oneOf.0.financialAddresses.items.[INDEX].routingNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"ABA routing number for US transfers; six-digit sort code for GB.","uniqueKey":"invoice.bankTransferInstructions.oneOf.0.financialAddresses.items.[INDEX].routingNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice.bankTransferInstructions.oneOf.0.financialAddresses.items.[INDEX].routingNumber","typeLabel":"string | null"},"accountHolderName":{"oneOf":[{"type":"string","uniqueKey":"invoice.bankTransferInstructions.oneOf.0.financialAddresses.items.[INDEX].accountHolderName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"invoice.bankTransferInstructions.oneOf.0.financialAddresses.items.[INDEX].accountHolderName.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice.bankTransferInstructions.oneOf.0.financialAddresses.items.[INDEX].accountHolderName","typeLabel":"string | null"},"accountHolderAddress":{"oneOf":[{"type":"string","uniqueKey":"invoice.bankTransferInstructions.oneOf.0.financialAddresses.items.[INDEX].accountHolderAddress.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"invoice.bankTransferInstructions.oneOf.0.financialAddresses.items.[INDEX].accountHolderAddress.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice.bankTransferInstructions.oneOf.0.financialAddresses.items.[INDEX].accountHolderAddress","typeLabel":"string | null"},"accountType":{"oneOf":[{"type":"string","uniqueKey":"invoice.bankTransferInstructions.oneOf.0.financialAddresses.items.[INDEX].accountType.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"invoice.bankTransferInstructions.oneOf.0.financialAddresses.items.[INDEX].accountType.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice.bankTransferInstructions.oneOf.0.financialAddresses.items.[INDEX].accountType","typeLabel":"string | null"},"iban":{"oneOf":[{"type":"string","description":"Returned for `eu_bank_transfer` and `gb_bank_transfer`.","uniqueKey":"invoice.bankTransferInstructions.oneOf.0.financialAddresses.items.[INDEX].iban.oneOf.0","typeLabel":"string"},{"type":"null","description":"Returned for `eu_bank_transfer` and `gb_bank_transfer`.","uniqueKey":"invoice.bankTransferInstructions.oneOf.0.financialAddresses.items.[INDEX].iban.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice.bankTransferInstructions.oneOf.0.financialAddresses.items.[INDEX].iban","typeLabel":"string | null"},"swiftCode":{"oneOf":[{"type":"string","description":"SWIFT/BIC for international wires.","uniqueKey":"invoice.bankTransferInstructions.oneOf.0.financialAddresses.items.[INDEX].swiftCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"SWIFT/BIC for international wires.","uniqueKey":"invoice.bankTransferInstructions.oneOf.0.financialAddresses.items.[INDEX].swiftCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice.bankTransferInstructions.oneOf.0.financialAddresses.items.[INDEX].swiftCode","typeLabel":"string | null"}},"uniqueKey":"invoice.bankTransferInstructions.oneOf.0.financialAddresses.items.[INDEX]","typeLabel":"object"},"uniqueKey":"invoice.bankTransferInstructions.oneOf.0.financialAddresses","typeLabel":"object[]"},"generatedAt":{"type":"string","format":"date-time","uniqueKey":"invoice.bankTransferInstructions.oneOf.0.generatedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"invoice.bankTransferInstructions.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"invoice.bankTransferInstructions.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice.bankTransferInstructions","typeLabel":"object | null"},"bankTransferFeeCents":{"oneOf":[{"type":"integer","description":"Platform fee (in cents) added on top of `totalCents` when paying\nby wire. SideShift charges **1%** on inbound wires; this fee is\nalready baked into `bankTransferAmountCents`. Other payment rails\n(card / ACH via Whop) do not include this fee. `null` when the\ninvoice does not use the wire rail.\n","uniqueKey":"invoice.bankTransferFeeCents.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Platform fee (in cents) added on top of `totalCents` when paying\nby wire. SideShift charges **1%** on inbound wires; this fee is\nalready baked into `bankTransferAmountCents`. Other payment rails\n(card / ACH via Whop) do not include this fee. `null` when the\ninvoice does not use the wire rail.\n","uniqueKey":"invoice.bankTransferFeeCents.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice.bankTransferFeeCents","typeLabel":"integer | null"},"bankTransferAmountCents":{"oneOf":[{"type":"integer","description":"Exact amount (in cents) the customer should wire. Equals\n`totalCents + bankTransferFeeCents`. `null` when the invoice\ndoes not use the wire rail. The merchant is credited only\n`totalCents`; the wire fee accrues to SideShift.\n","uniqueKey":"invoice.bankTransferAmountCents.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Exact amount (in cents) the customer should wire. Equals\n`totalCents + bankTransferFeeCents`. `null` when the invoice\ndoes not use the wire rail. The merchant is credited only\n`totalCents`; the wire fee accrues to SideShift.\n","uniqueKey":"invoice.bankTransferAmountCents.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice.bankTransferAmountCents","typeLabel":"integer | null"},"createdAt":{"type":"string","format":"date-time","uniqueKey":"invoice.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","uniqueKey":"invoice.updatedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"invoice","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"invoice":{"id":"\u003cstring>","invoiceNumber":"\u003cstring>","status":"open","customerId":"\u003cstring>","customerName":"\u003cstring>","customerEmail":"jsmith@example.com","additionalEmails":["jsmith@example.com"],"customerAddress":{"line1":"\u003cstring>","line2":"\u003cstring>","city":"\u003cstring>","state":"\u003cstring>","postalCode":"\u003cstring>","country":"\u003cstring>"},"paymentType":"one_time","currency":"\u003cstring>","lineItems":[{"description":"\u003cstring>","quantity":2,"unitPriceCents":2,"id":"\u003cstring>","amountCents":123}],"subtotalCents":123,"taxCents":123,"discountCents":123,"totalCents":123,"allowedPaymentTypes":["\u003cstring>"],"collectCustomerFee":true,"issueDate":"2023-11-07T05:31:56Z","dueDate":"2023-11-07T05:31:56Z","paidAt":"2023-11-07T05:31:56Z","voidedAt":"2023-11-07T05:31:56Z","description":"\u003cstring>","notes":"\u003cstring>","terms":"\u003cstring>","sendReminders":true,"remindersSentCount":123,"lastReminderSentAt":"2023-11-07T05:31:56Z","hostedInvoiceUrl":"\u003cstring>","pdfUrl":"\u003cstring>","bankTransferInstructions":{"type":"us_bank_transfer","currency":"\u003cstring>","reference":"\u003cstring>","hostedInstructionsUrl":"\u003cstring>","financialAddresses":[{"bankName":"\u003cstring>","accountNumber":"\u003cstring>","routingNumber":"\u003cstring>","accountHolderName":"\u003cstring>","accountHolderAddress":"\u003cstring>","accountType":"\u003cstring>","iban":"\u003cstring>","swiftCode":"\u003cstring>"}],"generatedAt":"2023-11-07T05:31:56Z"},"bankTransferFeeCents":123,"bankTransferAmountCents":123,"createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"9938fa1f-e381-46ee-90af-26985da07d54":{"description":"Invoice belongs to a different company","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"d2d0bdfd-dfa4-48cb-a467-d7bfa999db1e":{"description":"Invoice not found","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"7f161042-3fa3-4de5-9759-4a9cf30c0709":{"apiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key for authentication. Get yours from Settings → Integrations. A key created by a team member acts as that member and follows their current team permissions; a request outside those permissions returns `403 { \"error\": \"insufficient_scope\", \"scope\": \"\u003crequired>\" }`.","scopes":[],"schemeName":"apiKeyAuth"}}},"servers":{"6a0a8ca1-a9ed-44a6-80e9-2dd2b08dda3d":{"url":"https://app.sideshift.app/api/v1","description":"Production server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key for authentication. Get yours from Settings → Integrations. A key created by a team member acts as that member and follows their current team permissions; a request outside those permissions returns `403 { \"error\": \"insufficient_scope\", \"scope\": \"\u003crequired>\" }`.","scopes":[],"schemeName":"apiKeyAuth"},"schema":{"title":"x-api-key","type":"string","description":"API key for authentication. Get yours from Settings → Integrations. A key created by a team member acts as that member and follows their current team permissions; a request outside those permissions returns `403 { \"error\": \"insufficient_scope\", \"scope\": \"\u003crequired>\" }`.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKeyAuth","name":"x-api-key"}],"title":"apiKeyAuth"}]},"originalFileLocation":"openapi/platform-apikey.yaml"},"subdomain":"sideshift","siteName":"SideShift","title":"Get invoice - SideShift","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-06T21:11:26.304Z","originalFileLocation":"platform/api-key/invoices/get-invoice.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";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=\"Retrieve a single invoice by ID. Returns 404 if it does not belong to the authenticated company. - This endpoint lazily provisions wire-transfer funding details for invoices that opted into bank_transfer but didn\u0026#x27;t have bankTransferInstructions populated at create time (eg. Stripe Customer Balance was not yet enabled on the account). Polling this endpoint after creation is the recommended way to surface wire details to your end user once the merchant fixes their Stripe configuration. - The hosted invoice page (hostedInvoiceUrl) and PDF (pdfUrl) are stable URLs — safe to cache or share.\">\u003cmeta data-mint-head name=\"application-name\" content=\"SideShift\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/sideshift/HER0K4eGvuEqC4Kt/_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/sideshift/HER0K4eGvuEqC4Kt/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/sideshift/HER0K4eGvuEqC4Kt/_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/sideshift/HER0K4eGvuEqC4Kt/_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/sideshift/HER0K4eGvuEqC4Kt/_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/sideshift/HER0K4eGvuEqC4Kt/_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/sideshift/HER0K4eGvuEqC4Kt/_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/sideshift/HER0K4eGvuEqC4Kt/_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/sideshift/HER0K4eGvuEqC4Kt/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get invoice - SideShift\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve a single invoice by ID. Returns 404 if it does not belong to the authenticated company. - This endpoint lazily provisions wire-transfer funding details for invoices that opted into bank_transfer but didn\u0026#x27;t have bankTransferInstructions populated at create time (eg. Stripe Customer Balance was not yet enabled on the account). Polling this endpoint after creation is the recommended way to surface wire details to your end user once the merchant fixes their Stripe configuration. - The hosted invoice page (hostedInvoiceUrl) and PDF (pdfUrl) are stable URLs — safe to cache or share.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"SideShift\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.sideshift.app/platform/api-key/invoices/get-invoice\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://sideshift.mintlify.site/_mintlify/api/og/v2?division=Invoices\u0026amp;title=Get+invoice\u0026amp;description=Retrieve+a+single+invoice+by+ID.+Returns+404+if+it+does+not+belong%0Ato+the+authenticated+company.%0A%0A-+This+endpoint+**lazily+provisions**+wire-transfer+funding+de\u0026amp;theme=401dd8d7e2b95a95e9b00b05\u0026amp;signature=d319aea224ab94bde2fcdbc9df08398e11703a7e84840f24eb5c9cb122b0c0b1\">\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=\"Get invoice - SideShift\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve a single invoice by ID. Returns 404 if it does not belong to the authenticated company. - This endpoint lazily provisions wire-transfer funding details for invoices that opted into bank_transfer but didn\u0026#x27;t have bankTransferInstructions populated at create time (eg. Stripe Customer Balance was not yet enabled on the account). Polling this endpoint after creation is the recommended way to surface wire details to your end user once the merchant fixes their Stripe configuration. - The hosted invoice page (hostedInvoiceUrl) and PDF (pdfUrl) are stable URLs — safe to cache or share.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://sideshift.mintlify.site/_mintlify/api/og/v2?division=Invoices\u0026amp;title=Get+invoice\u0026amp;description=Retrieve+a+single+invoice+by+ID.+Returns+404+if+it+does+not+belong%0Ato+the+authenticated+company.%0A%0A-+This+endpoint+**lazily+provisions**+wire-transfer+funding+de\u0026amp;theme=401dd8d7e2b95a95e9b00b05\u0026amp;signature=d319aea224ab94bde2fcdbc9df08398e11703a7e84840f24eb5c9cb122b0c0b1\">\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/sideshift/HER0K4eGvuEqC4Kt/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"SideShift\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2E6FE0\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.sideshift.app/platform/api-key/invoices/get-invoice\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/platform/api-key/invoices/get-invoice.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.sideshift.app/#organization\",\"name\":\"SideShift\",\"url\":\"https://docs.sideshift.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/sideshift/oTyWBbQpawmh0yna/logo/light.svg?fit=max\u0026auto=format\u0026n=oTyWBbQpawmh0yna\u0026q=85\u0026s=067b5f4d28c1d362dd1035d42fd4cf61\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.sideshift.app#website\",\"name\":\"SideShift\",\"url\":\"https://docs.sideshift.app\",\"publisher\":{\"@id\":\"https://docs.sideshift.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.sideshift.app/platform/api-key/invoices/get-invoice#webpage\",\"url\":\"https://docs.sideshift.app/platform/api-key/invoices/get-invoice\",\"name\":\"Get invoice\",\"description\":\"Retrieve a single invoice by ID. Returns 404 if it does not belong to the authenticated company. - This endpoint lazily provisions wire-transfer funding details for invoices that opted into bank_transfer but didn't have bankTransferInstructions populated at create time (eg. Stripe Customer Balance was not yet enabled on the account). Polling this endpoint after creation is the recommended way to surface wire details to your end user once the merchant fixes their Stripe configuration. - The hosted invoice page (hostedInvoiceUrl) and PDF (pdfUrl) are stable URLs — safe to cache or share.\",\"dateModified\":\"2026-11-06T21:11:26.304Z\",\"isPartOf\":{\"@id\":\"https://docs.sideshift.app#website\"},\"breadcrumb\":{\"@id\":\"https://docs.sideshift.app/platform/api-key/invoices/get-invoice#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.sideshift.app/platform/api-key/invoices/get-invoice#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Legacy API (Deprecated)\",\"item\":\"https://docs.sideshift.app/platform/api-key/programs/list-programs\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Invoices\",\"item\":\"https://docs.sideshift.app/platform/api-key/invoices/list-invoices\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get invoice\",\"item\":\"https://docs.sideshift.app/platform/api-key/invoices/get-invoice\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.sideshift.app/platform/api-key/invoices/get-invoice#apireference\",\"headline\":\"Get invoice\",\"name\":\"Get invoice\",\"description\":\"Retrieve a single invoice by ID. Returns 404 if it does not belong to the authenticated company. - This endpoint lazily provisions wire-transfer funding details for invoices that opted into bank_transfer but didn't have bankTransferInstructions populated at create time (eg. Stripe Customer Balance was not yet enabled on the account). Polling this endpoint after creation is the recommended way to surface wire details to your end user once the merchant fixes their Stripe configuration. - The hosted invoice page (hostedInvoiceUrl) and PDF (pdfUrl) are stable URLs — safe to cache or share.\",\"url\":\"https://docs.sideshift.app/platform/api-key/invoices/get-invoice\",\"mainEntityOfPage\":{\"@id\":\"https://docs.sideshift.app/platform/api-key/invoices/get-invoice#webpage\"},\"dateModified\":\"2026-11-06T21:11:26.304Z\",\"publisher\":{\"@id\":\"https://docs.sideshift.app/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.sideshift.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"SideShift\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"SideShift","nav":{"global":null,"tabs":[{"tab":"Home","icon":"house","pages":[{"title":"Home","href":""}]},{"tab":"Platform API","icon":"briefcase-business","pages":[{"group":"Overview","pages":[{"title":"Platform API","href":"/platform"}]},{"group":"Guides","expanded":true,"pages":[{"title":"API workflows","href":"/platform/workflows"},{"title":"Shopify store integration","href":"/platform/shopify-integration"},{"title":"Connect your own Shopify app","href":"/platform/shopify-merchant-app"},{"title":"Team and integration permissions","href":"/platform/permissions"},{"title":"Agency subaccount access","href":"/platform/agency-access"},{"title":"Company automations","href":"/platform/automations"},{"title":"Attach ghost handles to creators","href":"/platform/ghost-creators"},{"title":"Scopes and token security","href":"/platform/scopes"},{"title":"Errors, rate limits, and idempotency","href":"/platform/errors"},{"title":"Migrating from the legacy API","href":"/platform/migration"}]},{"group":"SideShift Pixel","pages":[{"title":"SideShift Pixel","href":"/platform/store-attribution"},{"title":"Install SideShift Pixel","href":"/pixel/installation"},{"title":"Browser SDK reference","href":"/pixel/events"},{"title":"Orders API","href":"/pixel/orders-api"},{"title":"Advertising measurement","href":"/pixel/advertising"},{"title":"Platform setup","href":"/pixel/platforms"},{"title":"Testing and troubleshooting","href":"/pixel/testing"},{"group":"Orders API reference","pages":[{"title":"Submit or update a verified order","deprecated":null,"version":null,"openapi":"/openapi/commerce-orders.yaml post /orders","href":"/pixel/reference/orders/submit-or-update-a-verified-order"}]}]},{"group":"OAuth 2.1 \u0026 MCP","pages":[{"group":"Authentication","expanded":true,"pages":[{"group":"OAuth Registration","pages":[{"title":"Read client configuration","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /clients/{clientId}","href":"/platform/oauth/oauth-registration/read-client-configuration"},{"title":"Register a client","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /register","href":"/platform/oauth/oauth-registration/register-a-client"},{"title":"Update client configuration","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml put /clients/{clientId}","href":"/platform/oauth/oauth-registration/update-client-configuration"},{"title":"Delete a client","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml delete /clients/{clientId}","href":"/platform/oauth/oauth-registration/delete-a-client"}]},{"group":"OAuth Authorization","pages":[{"title":"Authorization endpoint","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /authorize","href":"/platform/oauth/oauth-authorization/authorization-endpoint"},{"title":"Load a consent request","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /consent","href":"/platform/oauth/oauth-authorization/load-a-consent-request"},{"title":"Record a consent decision","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /consent","href":"/platform/oauth/oauth-authorization/record-a-consent-decision"}]},{"group":"OAuth Token","pages":[{"title":"Token endpoint","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /token","href":"/platform/oauth/oauth-token/token-endpoint"},{"title":"Revoke a token","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /revoke","href":"/platform/oauth/oauth-token/revoke-a-token"}]},{"group":"OAuth Discovery","pages":[{"title":"JSON Web Key Set","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /jwks","href":"/platform/oauth/oauth-discovery/json-web-key-set"},{"title":"Authorization-server metadata","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /.well-known/oauth-authorization-server","href":"/platform/oauth/oauth-discovery/authorization-server-metadata"},{"title":"Protected-resource metadata","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /.well-known/oauth-protected-resource","href":"/platform/oauth/oauth-discovery/protected-resource-metadata"}]}]},{"group":"Campaigns \u0026 Contracts","expanded":true,"pages":[{"group":"Campaigns","pages":[{"title":"List campaigns","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /campaigns","href":"/platform/oauth/campaigns/list-campaigns"},{"title":"Get a campaign","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /campaigns/{id}","href":"/platform/oauth/campaigns/get-a-campaign"},{"title":"Get campaign handles export link (CSV)","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /campaigns/{id}/handles-export-link","href":"/platform/oauth/exports/get-campaign-handles-export-link-csv"},{"title":"Get a campaign's payment structure","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /campaigns/{id}/payment-structure","href":"/platform/oauth/campaigns/get-a-campaigns-payment-structure"},{"title":"Create a campaign","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /campaigns","href":"/platform/oauth/campaigns/create-a-campaign"},{"title":"Archive a campaign","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /campaigns/{id}/archive","href":"/platform/oauth/campaigns/archive-a-campaign"},{"title":"Duplicate a campaign","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /campaigns/{id}/duplicate","href":"/platform/oauth/campaigns/duplicate-a-campaign"},{"title":"Import analytics history","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /campaigns/{id}/analytics-history","href":"/platform/oauth/campaigns/import-analytics-history"},{"title":"Add a ghost handle to a campaign","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /campaigns/{id}/ghost-handles","href":"/platform/oauth/campaigns/add-a-ghost-handle-to-a-campaign"},{"title":"Bulk add ghost handles to a campaign","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /campaigns/{id}/ghost-handles/bulk","href":"/platform/oauth/campaigns/bulk-add-ghost-handles-to-a-campaign"},{"title":"Attach an existing ghost handle to a creator","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /campaigns/{id}/ghost-handles/{contractId}/attach","href":"/platform/oauth/campaigns/attach-an-existing-ghost-handle-to-a-creator"},{"title":"Convert a ghost handle to a pending creator contract","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /campaigns/{id}/ghost-handles/{contractId}/convert","href":"/platform/oauth/campaigns/convert-a-ghost-handle-to-a-pending-creator-contract"},{"title":"Add a ghost video to a campaign","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /campaigns/{id}/ghost-videos","href":"/platform/oauth/campaigns/add-a-ghost-video-to-a-campaign"},{"title":"Bulk add ghost videos to a campaign","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /campaigns/{id}/ghost-videos/bulk","href":"/platform/oauth/campaigns/bulk-add-ghost-videos-to-a-campaign"},{"title":"Update a campaign","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml patch /campaigns/{id}","href":"/platform/oauth/campaigns/update-a-campaign"},{"title":"Delete a campaign","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml delete /campaigns/{id}","href":"/platform/oauth/campaigns/delete-a-campaign"}]},{"group":"Contracts","pages":[{"title":"List contracts","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /contracts","href":"/platform/oauth/contracts/list-contracts"},{"title":"List active non-ghost contract PDF links","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /contracts/pdf-links","href":"/platform/oauth/contracts/list-active-non-ghost-contract-pdf-links"},{"title":"Get stored contract PDF links","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /contracts/pdfs","href":"/platform/oauth/contracts/get-stored-contract-pdf-links"},{"title":"Get a contract","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /contracts/{id}","href":"/platform/oauth/contracts/get-a-contract"},{"title":"Get a contract's content","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /contracts/{id}/content","href":"/platform/oauth/contracts/get-a-contracts-content"},{"title":"Get contract details","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /contracts/{id}/details","href":"/platform/oauth/contracts/get-contract-details"},{"title":"Get a contract's history","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /contracts/{id}/history","href":"/platform/oauth/contracts/get-a-contracts-history"},{"title":"Get a contract's metrics","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /contracts/{id}/metrics","href":"/platform/oauth/contracts/get-a-contracts-metrics"},{"title":"Get a contract preview PDF","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /contracts/{id}/preview-pdf","href":"/platform/oauth/contracts/get-a-contract-preview-pdf"},{"title":"Create/offer a contract","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /contracts","href":"/platform/oauth/contracts/createoffer-a-contract"},{"title":"Cancel a contract","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /contracts/{id}/cancel","href":"/platform/oauth/contracts/cancel-a-contract"},{"title":"Add a social account to a contract","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /contracts/{id}/handles","href":"/platform/oauth/contracts/add-a-social-account-to-a-contract"},{"title":"Regenerate a contract","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /contracts/{id}/regen","href":"/platform/oauth/contracts/regenerate-a-contract"},{"title":"Reject a contract","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /contracts/{id}/reject","href":"/platform/oauth/contracts/reject-a-contract"},{"title":"Save a contract signature","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /contracts/{id}/signature","href":"/platform/oauth/contracts/save-a-contract-signature"},{"title":"Update a creator contract","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml patch /contracts/{id}","href":"/platform/oauth/contracts/update-a-creator-contract"},{"title":"Update a contract's content","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml patch /contracts/{id}/content","href":"/platform/oauth/contracts/update-a-contracts-content"},{"title":"Update contract fields (not available)","deprecated":true,"version":null,"openapi":"/openapi/oauth.yaml patch /contracts/{id}/fields","href":"/platform/oauth/contracts/update-contract-fields-not-available"},{"title":"Update a contract's payment structure","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml patch /contracts/{id}/payment","href":"/platform/oauth/contracts/update-a-contracts-payment-structure"}]},{"group":"Invites","pages":[{"title":"List invite links","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /invites","href":"/platform/oauth/invites/list-invite-links"},{"title":"Create an invite link","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /invites","href":"/platform/oauth/invites/create-an-invite-link"},{"title":"Revoke an invite link","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml delete /invites/{id}","href":"/platform/oauth/invites/revoke-an-invite-link"}]}]},{"group":"Creators \u0026 Recruiting","expanded":true,"pages":[{"group":"Creators","pages":[{"title":"List creators","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /creators","href":"/platform/oauth/creators/list-creators"},{"title":"Get a CSV export download link","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /posts/export-link","href":"/platform/oauth/exports/get-a-csv-export-download-link"},{"title":"Get a creator","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /creators/{id}","href":"/platform/oauth/creators/get-a-creator"},{"title":"List creator collections","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /creator-collections","href":"/platform/oauth/creators/list-creator-collections"},{"title":"Get creator notes","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /creators/{id}/notes","href":"/platform/oauth/creators/get-creator-notes"},{"title":"Create a campaign invite","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /campaigns/{id}/invites","href":"/platform/oauth/creators/create-a-campaign-invite"},{"title":"Create a creator collection","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /creator-collections","href":"/platform/oauth/creators/create-a-creator-collection"},{"title":"Create a creator invite link","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /creators/invites","href":"/platform/oauth/creators/create-a-creator-invite-link"}]},{"group":"Creator Collections","pages":[{"title":"Update a creator collection","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml put /creator-collections/{id}","href":"/platform/oauth/creator-collections/update-a-creator-collection"},{"title":"Remove a creator from a collection","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml delete /creator-collections/{id}/remove-creator","href":"/platform/oauth/creator-collections/remove-a-creator-from-a-collection"},{"title":"Delete a creator collection","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml delete /creator-collections/{id}","href":"/platform/oauth/creator-collections/delete-a-creator-collection"}]},{"group":"Discover","pages":[{"title":"Get a Discover offer","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /discover/offers/{id}","href":"/platform/oauth/discover/get-a-discover-offer"},{"title":"Get Discover offer","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /discover/offers","href":"/platform/oauth/discover/get-discover-offer"},{"title":"Get a Discover lead","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /discover/leads/{id}","href":"/platform/oauth/discover/get-a-discover-lead"},{"title":"List Discover leads","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /discover/leads","href":"/platform/oauth/discover/list-discover-leads"},{"title":"Save Discover offer","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /discover/offers","href":"/platform/oauth/discover/save-discover-offer"},{"title":"Create a Discover calendar host","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /discover/cal-hosts","href":"/platform/oauth/discover/create-a-discover-calendar-host"},{"title":"Submit a Discover lead","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /discover/leads","href":"/platform/oauth/discover/submit-a-discover-lead"},{"title":"Message a Discover agency","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /discover/message","href":"/platform/oauth/discover/message-a-discover-agency"},{"title":"Send lead status reminders","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /discover/leads/reminders","href":"/platform/oauth/discover/send-lead-status-reminders"},{"title":"Update a Discover lead","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml patch /discover/leads/{id}","href":"/platform/oauth/discover/update-a-discover-lead"},{"title":"Delete Discover offer","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml delete /discover/offers","href":"/platform/oauth/discover/delete-discover-offer"}]},{"group":"Jobs","pages":[{"title":"Get a job","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /jobs/{id}","href":"/platform/oauth/jobs/get-a-job"},{"title":"List job duplicate targets","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /jobs/duplicate-targets","href":"/platform/oauth/jobs/list-job-duplicate-targets"},{"title":"List public marketplace jobs","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /jobs/public","href":"/platform/oauth/jobs/list-public-marketplace-jobs"},{"title":"List jobs","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /jobs","href":"/platform/oauth/jobs/list-jobs"},{"title":"Boost a job","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /jobs/boost","href":"/platform/oauth/jobs/boost-a-job"},{"title":"Update job status","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /jobs/{id}","href":"/platform/oauth/jobs/update-job-status"},{"title":"Repost an expired job","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /jobs/repost","href":"/platform/oauth/jobs/repost-an-expired-job"},{"title":"Create or update a job","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /jobs","href":"/platform/oauth/jobs/create-or-update-a-job"},{"title":"Partially update a job","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml patch /jobs/{id}","href":"/platform/oauth/jobs/partially-update-a-job"}]},{"group":"Applications","pages":[{"title":"List campaign applications","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /applications","href":"/platform/oauth/applications/list-campaign-applications"},{"title":"Get a campaign application","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /applications/{id}","href":"/platform/oauth/applications/get-a-campaign-application"},{"title":"List creator invites","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /applications/creator-invites","href":"/platform/oauth/applications/list-creator-invites"},{"title":"Count pending handle requests","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /applications/handle-requests/count","href":"/platform/oauth/applications/count-pending-handle-requests"},{"title":"Review a campaign application","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /applications/{id}/status","href":"/platform/oauth/applications/review-a-campaign-application"},{"title":"Respond to a creator invite","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /applications/creator-invites/{id}/action","href":"/platform/oauth/applications/respond-to-a-creator-invite"}]},{"group":"Applicants","pages":[{"title":"List applicants with advanced filters","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /applicants/advanced","href":"/platform/oauth/applicants/list-applicants-with-advanced-filters"},{"title":"Get applicant counts","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /applicants/counts","href":"/platform/oauth/applicants/get-applicant-counts"},{"title":"Export applicants as CSV","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /applicants/export","href":"/platform/oauth/applicants/export-applicants-as-csv"},{"title":"Get a CSV export download link","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /posts/export-link","href":"/platform/oauth/exports/get-a-csv-export-download-link"},{"title":"List job applicants","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /applicants","href":"/platform/oauth/applicants/list-job-applicants"},{"title":"List applicants across every job","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /applicants/overview","href":"/platform/oauth/applicants/list-applicants-across-every-job"},{"title":"Get an applicant's top posts","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /applicants/top-posts","href":"/platform/oauth/applicants/get-an-applicants-top-posts"},{"title":"Bookmark or unbookmark an applicant","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /applicants/bookmark","href":"/platform/oauth/applicants/bookmark-or-unbookmark-an-applicant"},{"title":"Update an applicant's status","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /applicants/status","href":"/platform/oauth/applicants/update-an-applicants-status"},{"title":"Open an applicant support channel","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /applicants/support-channel","href":"/platform/oauth/applicants/open-an-applicant-support-channel"},{"title":"Send a new message to an applicant","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /applicants/message","href":"/platform/oauth/applicants/send-a-new-message-to-an-applicant"}]},{"group":"Recruit","pages":[{"title":"Get a recruit candidate","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /recruit/students/{id}","href":"/platform/oauth/recruit/get-a-recruit-candidate"},{"title":"Mint an action token","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /recruit/action-token","href":"/platform/oauth/recruit/mint-an-action-token"},{"title":"Get bookmarked recruits","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /recruit/bookmarks","href":"/platform/oauth/recruit/get-bookmarked-recruits"},{"title":"Update a recruit bookmark","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /recruit/bookmarks/update","href":"/platform/oauth/recruit/update-a-recruit-bookmark"},{"title":"Send a recruit invite","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /recruit/send-invite","href":"/platform/oauth/recruit/send-a-recruit-invite"},{"title":"Search recruit students","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /recruit/students","href":"/platform/oauth/recruit/search-recruit-students"}]}]},{"group":"Content \u0026 Analytics","expanded":true,"pages":[{"group":"Posts","pages":[{"title":"List posts","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /posts","href":"/platform/oauth/posts/list-posts"},{"title":"Get a post","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /posts/{id}","href":"/platform/oauth/posts/get-a-post"},{"title":"Get a post's metrics history","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /posts/{id}/metrics-history","href":"/platform/oauth/posts/get-a-posts-metrics-history"},{"title":"Get re-scrape status","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /posts/rescrape","href":"/platform/oauth/posts/get-re-scrape-status"},{"title":"Export posts as CSV","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /posts/export","href":"/platform/oauth/posts/export-posts-as-csv"},{"title":"Get a CSV export download link","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /posts/export-link","href":"/platform/oauth/exports/get-a-csv-export-download-link"},{"title":"Get post analytics export links (CSV)","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /posts/analytics-export-links","href":"/platform/oauth/exports/get-post-analytics-export-links-csv"},{"title":"Set a post's approval status","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /posts/{id}/approval","href":"/platform/oauth/posts/set-a-posts-approval-status"},{"title":"Set a post's deletion status","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /posts/{id}/deletion","href":"/platform/oauth/posts/set-a-posts-deletion-status"},{"title":"Hide a post from analytics","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /posts/{id}/analytics-hidden","href":"/platform/oauth/posts/hide-a-post-from-analytics"},{"title":"Bulk update analytics tags","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /posts/bulk-analytics-tags","href":"/platform/oauth/posts/bulk-update-analytics-tags"},{"title":"Re-scrape a contract's posts","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /posts/rescrape","href":"/platform/oauth/posts/re-scrape-a-contracts-posts"},{"title":"Set a post's analytics tags","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml put /posts/{id}/analytics-tags","href":"/platform/oauth/posts/set-a-posts-analytics-tags"}]},{"group":"Video Submissions","pages":[{"title":"List video submissions","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /video-submissions","href":"/platform/oauth/video-submissions/list-video-submissions"},{"title":"Review a video submission","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /video-submissions/{id}/review","href":"/platform/oauth/video-submissions/review-a-video-submission"},{"title":"Delete a video submission","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml delete /video-submissions/{id}","href":"/platform/oauth/video-submissions/delete-a-video-submission"}]},{"group":"Brand Content Pages","pages":[{"title":"Get a brand content page","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /brand-content-pages/{id}","href":"/platform/oauth/brand-content-pages/get-a-brand-content-page"},{"title":"List brand content pages","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /brand-content-pages","href":"/platform/oauth/brand-content-pages/list-brand-content-pages"},{"title":"Create a brand content page","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /brand-content-pages","href":"/platform/oauth/brand-content-pages/create-a-brand-content-page"},{"title":"Update a brand content page","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml patch /brand-content-pages/{id}","href":"/platform/oauth/brand-content-pages/update-a-brand-content-page"}]},{"group":"Analytics","pages":[{"title":"Tracked account analytics","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /analytics/accounts","href":"/platform/oauth/analytics/tracked-account-analytics"},{"title":"List campaign names and statuses","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /analytics/campaigns","href":"/platform/oauth/analytics/list-campaign-names-and-statuses"},{"title":"Creator audience demographics","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /analytics/creator-audience","href":"/platform/oauth/analytics/creator-audience-demographics"},{"title":"List creator display identities","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /analytics/creators","href":"/platform/oauth/analytics/list-creator-display-identities"},{"title":"Dashboard KPIs","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /analytics/kpis","href":"/platform/oauth/analytics/dashboard-kpis"},{"title":"Dashboard overview","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /analytics/overview","href":"/platform/oauth/analytics/dashboard-overview"},{"title":"Export safe daily post metric history in bulk","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /analytics/posts/metrics-history","href":"/platform/oauth/analytics/export-safe-daily-post-metric-history-in-bulk"},{"title":"Get safe daily post metric changes","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /analytics/posts/{id}/metrics-history","href":"/platform/oauth/analytics/get-safe-daily-post-metric-changes"},{"title":"Daily metrics time series","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /analytics/time-series","href":"/platform/oauth/analytics/daily-metrics-time-series"},{"title":"Tracked videos","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /analytics/videos","href":"/platform/oauth/analytics/tracked-videos"}]},{"group":"Performance","pages":[{"title":"Brand portfolio health","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /performance/brand-health","href":"/platform/oauth/performance/brand-portfolio-health"},{"title":"Get one own campaign's performance health","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /performance/campaigns/{campaignId}/health","href":"/platform/oauth/performance/get-one-own-campaigns-performance-health"},{"title":"Get one own contract's performance scorecard","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /performance/contracts/{contractId}/scorecard","href":"/platform/oauth/performance/get-one-own-contracts-performance-scorecard"},{"title":"Creator relationship","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /performance/creators/{creatorId}","href":"/platform/oauth/performance/creator-relationship"},{"title":"Performance attention items","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /performance/attention","href":"/platform/oauth/performance/performance-attention-items"},{"title":"Available performance metrics","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /performance/metrics","href":"/platform/oauth/performance/available-performance-metrics"},{"title":"Get performance data freshness","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /performance/runs/latest","href":"/platform/oauth/performance/get-performance-data-freshness"},{"title":"Get the agency portfolio health rollup","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /performance/portfolio","href":"/platform/oauth/performance/get-the-agency-portfolio-health-rollup"},{"title":"Campaign cohort benchmark","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /performance/campaigns/{campaignId}/benchmark","href":"/platform/oauth/performance/campaign-cohort-benchmark"},{"title":"Read PII-safe creator spend for a contract campaign","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /performance/campaigns/{campaignId}/creator-spend","href":"/platform/oauth/performance/read-pii-safe-creator-spend-for-a-contract-campaign"},{"title":"Campaign pacing verdict","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /performance/campaigns/{campaignId}/pacing","href":"/platform/oauth/performance/campaign-pacing-verdict"},{"title":"Campaign top performers","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /performance/campaigns/{campaignId}/top-performers","href":"/platform/oauth/performance/campaign-top-performers"},{"title":"List all PII-safe creator payouts for the token tenant","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /performance/creator-spend","href":"/platform/oauth/performance/list-all-pii-safe-creator-payouts-for-the-token-tenant"},{"title":"Contract risk flags","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /performance/contract-risks","href":"/platform/oauth/performance/contract-risk-flags"},{"title":"Campaign portfolio context","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /performance/campaign-portfolio","href":"/platform/oauth/performance/campaign-portfolio-context"},{"title":"Creator rate benchmarks","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /performance/rate-benchmark","href":"/platform/oauth/performance/creator-rate-benchmarks"},{"title":"creator shortlist for an OWN campaign's brief","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /performance/match","href":"/platform/oauth/performance/creator-shortlist-for-an-own-campaigns-brief"}]},{"group":"Ads","pages":[{"title":"GET handler","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/tiktok/campaign-shells","href":"/platform/oauth/ads/get-handler"},{"title":"GET handler","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/tiktok/campaign-shells","href":"/platform/oauth/ads/get-handler"},{"title":"GET handler","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/tiktok/campaign-shells","href":"/platform/oauth/ads/get-handler"},{"title":"List TikTok Spark code requests","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/code-requests","href":"/platform/oauth/ads/list-tiktok-spark-code-requests"},{"title":"GET handler","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/tiktok/campaign-shells","href":"/platform/oauth/ads/get-handler"},{"title":"GET handler","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/tiktok/campaign-shells","href":"/platform/oauth/ads/get-handler"},{"title":"Read selected Google ad copy for reuse","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/google/ad-copy","href":"/platform/oauth/ads/read-selected-google-ad-copy-for-reuse"},{"title":"Read selected Google readiness, targeting options and advertiser logo","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/google/configuration","href":"/platform/oauth/ads/read-selected-google-readiness-targeting-options-and-advertiser-logo"},{"title":"Read native Google settings-copy source identities","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/google/copy-settings","href":"/platform/oauth/ads/read-native-google-settings-copy-source-identities"},{"title":"Read a native Google Demand Gen reach forecast","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /ads/google/forecast","href":"/platform/oauth/ads/read-a-native-google-demand-gen-reach-forecast"},{"title":"Read selected Google campaigns, ad groups, inherited budgets and targeting","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/google/inventory","href":"/platform/oauth/ads/read-selected-google-campaigns-ad-groups-inherited-budgets-and-targeting"},{"title":"Read optional YouTube shared-code requests","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/google/partnership-code-requests","href":"/platform/oauth/ads/read-optional-youtube-shared-code-requests"},{"title":"GET handler","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/tiktok/campaign-shells","href":"/platform/oauth/ads/get-handler"},{"title":"GET handler","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/tiktok/campaign-shells","href":"/platform/oauth/ads/get-handler"},{"title":"GET handler","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/tiktok/campaign-shells","href":"/platform/oauth/ads/get-handler"},{"title":"List native LinkedIn campaign groups","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/linkedin/campaign-groups","href":"/platform/oauth/ads/list-native-linkedin-campaign-groups"},{"title":"List native LinkedIn campaigns","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/linkedin/campaigns","href":"/platform/oauth/ads/list-native-linkedin-campaigns"},{"title":"Read a native LinkedIn Page post","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/linkedin/posts/{postId}","href":"/platform/oauth/ads/read-a-native-linkedin-page-post"},{"title":"List native LinkedIn Page posts","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/linkedin/posts","href":"/platform/oauth/ads/list-native-linkedin-page-posts"},{"title":"Read LinkedIn store tracking readiness","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/linkedin/tracking","href":"/platform/oauth/ads/read-linkedin-store-tracking-readiness"},{"title":"GET handler","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/tiktok/campaign-shells","href":"/platform/oauth/ads/get-handler"},{"title":"GET handler","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/tiktok/campaign-shells","href":"/platform/oauth/ads/get-handler"},{"title":"GET handler","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/tiktok/campaign-shells","href":"/platform/oauth/ads/get-handler"},{"title":"GET handler","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/tiktok/campaign-shells","href":"/platform/oauth/ads/get-handler"},{"title":"GET handler","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/tiktok/campaign-shells","href":"/platform/oauth/ads/get-handler"},{"title":"GET handler","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/tiktok/campaign-shells","href":"/platform/oauth/ads/get-handler"},{"title":"List Meta partnership code requests","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/meta/partnership-code-requests","href":"/platform/oauth/ads/list-meta-partnership-code-requests"},{"title":"Read the saved Meta partnership ad code for a post","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/meta/partnership-code","href":"/platform/oauth/ads/read-the-saved-meta-partnership-ad-code-for-a-post"},{"title":"GET handler","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/tiktok/campaign-shells","href":"/platform/oauth/ads/get-handler"},{"title":"Read a background ad operation","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/operations/{id}","href":"/platform/oauth/ads/read-a-background-ad-operation"},{"title":"GET handler","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/tiktok/campaign-shells","href":"/platform/oauth/ads/get-handler"},{"title":"GET handler","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/tiktok/campaign-shells","href":"/platform/oauth/ads/get-handler"},{"title":"GET handler","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/tiktok/campaign-shells","href":"/platform/oauth/ads/get-handler"},{"title":"Read Snapchat campaign inventory","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/snapchat/inventory","href":"/platform/oauth/ads/read-snapchat-campaign-inventory"},{"title":"Check an exact Snapchat native-upload source","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/snapchat/source","href":"/platform/oauth/ads/check-an-exact-snapchat-native-upload-source"},{"title":"List Snapchat creator permissions","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/snapchat/creator-authorizations","href":"/platform/oauth/ads/list-snapchat-creator-permissions"},{"title":"Read one Snapchat creator permission","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/snapchat/creator-authorizations/{id}","href":"/platform/oauth/ads/read-one-snapchat-creator-permission"},{"title":"List Snapchat ad-code requests","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/snapchat/code-requests","href":"/platform/oauth/ads/list-snapchat-ad-code-requests"},{"title":"Read a Snapchat operation","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/snapchat/operations/{id}","href":"/platform/oauth/ads/read-a-snapchat-operation"},{"title":"Read Snapchat account and profile setup","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/snapchat/setup","href":"/platform/oauth/ads/read-snapchat-account-and-profile-setup"},{"title":"Select Snapchat advertiser account and Public Profile","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml patch /ads/snapchat/setup","href":"/platform/oauth/ads/select-snapchat-advertiser-account-and-public-profile"},{"title":"Read the headlines the Reddit ad account's own ads run, for reuse","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/reddit/ad-copy","href":"/platform/oauth/ads/read-the-headlines-the-reddit-ad-accounts-own-ads-run-for-reuse"},{"title":"Read one Reddit campaign's ad groups","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/reddit/ad-groups","href":"/platform/oauth/ads/read-one-reddit-campaigns-ad-groups"},{"title":"Read the Reddit ad account's campaigns","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/reddit/campaigns","href":"/platform/oauth/ads/read-the-reddit-ad-accounts-campaigns"},{"title":"Read the Reddit ad account's payment methods","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/reddit/funding-instruments","href":"/platform/oauth/ads/read-the-reddit-ad-accounts-payment-methods"},{"title":"Read each Reddit connection's ad account and brand profile for a launch","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/reddit/launch-accounts","href":"/platform/oauth/ads/read-each-reddit-connections-ad-account-and-brand-profile-for-a-launch"},{"title":"GET handler","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/tiktok/campaign-shells","href":"/platform/oauth/ads/get-handler"},{"title":"GET handler","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/tiktok/campaign-shells","href":"/platform/oauth/ads/get-handler"},{"title":"Read the X handle's ad copy for reuse","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/x/ad-copy","href":"/platform/oauth/ads/read-the-x-handles-ad-copy-for-reuse"},{"title":"Read X website event tags and apps","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/x/assets","href":"/platform/oauth/ads/read-x-website-event-tags-and-apps"},{"title":"Read X campaigns and ad groups a launch can join","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/x/inventory","href":"/platform/oauth/ads/read-x-campaigns-and-ad-groups-a-launch-can-join"},{"title":"Read recent X posts the ad account may promote","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/x/posts","href":"/platform/oauth/ads/read-recent-x-posts-the-ad-account-may-promote"},{"title":"Check which X posts the ad account may promote","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /ads/x/promotable","href":"/platform/oauth/ads/check-which-x-posts-the-ad-account-may-promote"},{"title":"POST handler","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /ads/tiktok/launch","href":"/platform/oauth/ads/post-handler"},{"title":"Request a TikTok Spark code from a creator","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /ads/code-requests","href":"/platform/oauth/ads/request-a-tiktok-spark-code-from-a-creator"},{"title":"Save a TikTok Spark code a creator sent","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /ads/codes","href":"/platform/oauth/ads/save-a-tiktok-spark-code-a-creator-sent"},{"title":"mint a browser-only provider connection pointer","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /ads/connection-handoff","href":"/platform/oauth/ads/mint-a-browser-only-provider-connection-pointer"},{"title":"Draft a shallow paused Google settings copy","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /ads/google/copy-settings","href":"/platform/oauth/ads/draft-a-shallow-paused-google-settings-copy"},{"title":"Send a registered creator a message requesting an optional YouTube shared-code link","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /ads/google/partnership-code-requests","href":"/platform/oauth/ads/send-a-registered-creator-a-message-requesting-an-optional-youtube-shared-code-link"},{"title":"Save an optional YouTube shared-code link","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /ads/google/partnership-codes","href":"/platform/oauth/ads/save-an-optional-youtube-shared-code-link"},{"title":"Accept creator-initiated native video access for one selected source","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /ads/google/partnerships/accept","href":"/platform/oauth/ads/accept-creator-initiated-native-video-access-for-one-selected-source"},{"title":"Read native approval for the selected company-owned YouTube posts","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /ads/google/partnerships/check","href":"/platform/oauth/ads/read-native-approval-for-the-selected-company-owned-youtube-posts"},{"title":"Request native video access and send creator guides for the selected source indices","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /ads/google/partnerships/request","href":"/platform/oauth/ads/request-native-video-access-and-send-creator-guides-for-the-selected-source-indices"},{"title":"Launch an ad in the background","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /ads/launches","href":"/platform/oauth/ads/launch-an-ad-in-the-background"},{"title":"Read native LinkedIn launch configuration","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /ads/linkedin/configuration","href":"/platform/oauth/ads/read-native-linkedin-launch-configuration"},{"title":"Accept a Snapchat native ad launch","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /ads/snapchat/launch","href":"/platform/oauth/ads/accept-a-snapchat-native-ad-launch"},{"title":"Invite or revoke Snapchat creator permission","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /ads/snapchat/creator-authorizations","href":"/platform/oauth/ads/invite-or-revoke-snapchat-creator-permission"},{"title":"Check an existing Snapchat creator permission","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /ads/snapchat/creator-authorizations/{id}/reconcile","href":"/platform/oauth/ads/check-an-existing-snapchat-creator-permission"},{"title":"Request a Snapchat ad code from a creator","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /ads/snapchat/code-requests","href":"/platform/oauth/ads/request-a-snapchat-ad-code-from-a-creator"},{"title":"Save a Snapchat ad code a creator sent","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /ads/snapchat/codes","href":"/platform/oauth/ads/save-a-snapchat-ad-code-a-creator-sent"},{"title":"POST handler","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /ads/tiktok/launch","href":"/platform/oauth/ads/post-handler"},{"title":"POST handler","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /ads/tiktok/launch","href":"/platform/oauth/ads/post-handler"},{"title":"POST handler","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /ads/tiktok/launch","href":"/platform/oauth/ads/post-handler"},{"title":"Request a Meta partnership ad code from a creator","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /ads/meta/partnership-code-requests","href":"/platform/oauth/ads/request-a-meta-partnership-ad-code-from-a-creator"},{"title":"Save a Meta partnership ad code a creator sent","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /ads/meta/partnership-code","href":"/platform/oauth/ads/save-a-meta-partnership-ad-code-a-creator-sent"},{"title":"POST handler","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /ads/tiktok/launch","href":"/platform/oauth/ads/post-handler"},{"title":"Archive a promoted ad","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /ads/promoted/{id}/archive","href":"/platform/oauth/ads/archive-a-promoted-ad"},{"title":"POST handler","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /ads/tiktok/launch","href":"/platform/oauth/ads/post-handler"},{"title":"POST handler","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /ads/tiktok/launch","href":"/platform/oauth/ads/post-handler"},{"title":"POST handler","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /ads/tiktok/launch","href":"/platform/oauth/ads/post-handler"},{"title":"PATCH handler","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml patch /ads/promoted/{id}/budget","href":"/platform/oauth/ads/patch-handler"},{"title":"PATCH handler","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml patch /ads/promoted/{id}/budget","href":"/platform/oauth/ads/patch-handler"},{"title":"PUT handler","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml put /ads/link-settings","href":"/platform/oauth/ads/put-handler"},{"title":"Set up LinkedIn store tracking","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml put /ads/linkedin/tracking","href":"/platform/oauth/ads/set-up-linkedin-store-tracking"},{"title":"DELETE handler","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml delete /ads/promoted/{id}","href":"/platform/oauth/ads/delete-handler"},{"title":"DELETE handler","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml delete /ads/promoted/{id}","href":"/platform/oauth/ads/delete-handler"}]},{"group":"Commerce \u0026 Shopify","pages":[{"title":"List commerce stores","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /commerce/stores","href":"/platform/oauth/commerce/list-commerce-stores"},{"title":"List catalog products","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /commerce/products","href":"/platform/oauth/commerce/list-catalog-products"},{"title":"List attributed orders","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /commerce/orders","href":"/platform/oauth/commerce/list-attributed-orders"},{"title":"List sample requests","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /commerce/samples","href":"/platform/oauth/commerce/list-sample-requests"},{"title":"Query Shopify Admin API","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /commerce/shopify/query","href":"/platform/oauth/commerce/query-shopify-admin-api"},{"title":"Sync Shopify products","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /commerce/stores/{storeId}/sync","href":"/platform/oauth/commerce/sync-shopify-products"},{"title":"Review a creator sample","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /commerce/samples/{sampleId}/review","href":"/platform/oauth/commerce/review-a-creator-sample"}]}]},{"group":"Payments \u0026 Finance","expanded":true,"pages":[{"group":"Payouts","pages":[{"title":"List payout history","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /payouts","href":"/platform/oauth/payouts/list-payout-history"},{"title":"List pending payouts","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /payouts/pending","href":"/platform/oauth/payouts/list-pending-payouts"},{"title":"Get wallet + payout stats","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /payouts/stats","href":"/platform/oauth/payouts/get-wallet-+-payout-stats"},{"title":"Get payout and deposit receipt download links","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /payouts/receipt-links","href":"/platform/oauth/exports/get-payout-and-deposit-receipt-download-links"},{"title":"Download a payout or deposit receipt PDF","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /payouts/{id}/receipt","href":"/platform/oauth/exports/download-a-payout-or-deposit-receipt-pdf"},{"title":"Get bonus milestone dates","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /payouts/contracts/{id}/bonus-dates","href":"/platform/oauth/payouts/get-bonus-milestone-dates"},{"title":"Get payout breakdown","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /payouts/contracts/{id}/breakdown","href":"/platform/oauth/payouts/get-payout-breakdown"},{"title":"List payout-table contracts","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /payouts/contracts","href":"/platform/oauth/payouts/list-payout-table-contracts"},{"title":"Get total-owed summary","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /payouts/contracts/summary","href":"/platform/oauth/payouts/get-total-owed-summary"},{"title":"Execute contract payouts","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /payouts/execute","href":"/platform/oauth/payouts/execute-contract-payouts"},{"title":"Quick Pay by email","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /payouts/quick-pay","href":"/platform/oauth/payouts/quick-pay-by-email"},{"title":"Retry a reversed payout","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /payouts/{id}/retry","href":"/platform/oauth/payouts/retry-a-reversed-payout"},{"title":"Send a custom bonus","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /payouts/contracts/{id}/custom-bonus","href":"/platform/oauth/payouts/send-a-custom-bonus"},{"title":"Skip a payment cycle","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /payouts/contracts/{id}/ignore-cycle","href":"/platform/oauth/payouts/skip-a-payment-cycle"},{"title":"Recalculate a payout","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /payouts/contracts/{id}/recalculate","href":"/platform/oauth/payouts/recalculate-a-payout"},{"title":"Set a payout start date","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /payouts/contracts/{id}/start-date","href":"/platform/oauth/payouts/set-a-payout-start-date"},{"title":"Send a one-time payout","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /payouts/one-time","href":"/platform/oauth/payouts/send-a-one-time-payout"},{"title":"Preview a Quick Pay","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /payouts/quick-pay/preview","href":"/platform/oauth/payouts/preview-a-quick-pay"}]},{"group":"Quick-Pay","pages":[{"title":"List quick-pay drafts","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /quick-pay/drafts","href":"/platform/oauth/quick-pay/list-quick-pay-drafts"},{"title":"Look up a user by email","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /quick-pay/lookup","href":"/platform/oauth/quick-pay/look-up-a-user-by-email"},{"title":"List pending payments","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /quick-pay/pending","href":"/platform/oauth/quick-pay/list-pending-payments"},{"title":"List recent recipients","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /quick-pay/recent","href":"/platform/oauth/quick-pay/list-recent-recipients"},{"title":"List active+paused recurring schedules","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /quick-pay/schedules","href":"/platform/oauth/quick-pay/list-active+paused-recurring-schedules"},{"title":"List a company's quick-pay templates","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /quick-pay/templates","href":"/platform/oauth/quick-pay/list-a-companys-quick-pay-templates"},{"title":"Create a Quick Pay claim link","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /quick-pay/claim-link","href":"/platform/oauth/quick-pay/create-a-quick-pay-claim-link"},{"title":"Cancel a pending Quick Pay","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /quick-pay/{id}/cancel","href":"/platform/oauth/quick-pay/cancel-a-pending-quick-pay"},{"title":"Send a quick-pay draft","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /quick-pay/drafts/{id}/send","href":"/platform/oauth/quick-pay/send-a-quick-pay-draft"},{"title":"Create a quick-pay draft","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /quick-pay/drafts","href":"/platform/oauth/quick-pay/create-a-quick-pay-draft"},{"title":"Cancel a schedule","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /quick-pay/schedules/{id}/cancel","href":"/platform/oauth/quick-pay/cancel-a-schedule"},{"title":"Create a recurring schedule (not available)","deprecated":true,"version":null,"openapi":"/openapi/oauth.yaml post /quick-pay/schedules","href":"/platform/oauth/quick-pay/create-a-recurring-schedule-not-available"},{"title":"Create a quick-pay template","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /quick-pay/templates","href":"/platform/oauth/quick-pay/create-a-quick-pay-template"},{"title":"Edit a pending draft's recipients","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml patch /quick-pay/drafts/{id}","href":"/platform/oauth/quick-pay/edit-a-pending-drafts-recipients"},{"title":"Update a schedule (not available)","deprecated":true,"version":null,"openapi":"/openapi/oauth.yaml patch /quick-pay/schedules/{id}","href":"/platform/oauth/quick-pay/update-a-schedule-not-available"},{"title":"Update a template's name/recipients","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml patch /quick-pay/templates/{id}","href":"/platform/oauth/quick-pay/update-a-templates-namerecipients"},{"title":"Delete a pending draft","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml delete /quick-pay/drafts/{id}","href":"/platform/oauth/quick-pay/delete-a-pending-draft"},{"title":"Delete a quick-pay template","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml delete /quick-pay/templates/{id}","href":"/platform/oauth/quick-pay/delete-a-quick-pay-template"}]},{"group":"Wallet","pages":[{"title":"Get agency wallet balance","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /wallet/agency-balance","href":"/platform/oauth/wallet/get-agency-wallet-balance"},{"title":"Get wallet balance","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /wallet/balance","href":"/platform/oauth/wallet/get-wallet-balance"},{"title":"Get wallet balance summary","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /wallet/balance/summary","href":"/platform/oauth/wallet/get-wallet-balance-summary"},{"title":"Get wallet ledger","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /wallet/ledger","href":"/platform/oauth/wallet/get-wallet-ledger"},{"title":"Get spending report and wallet statement download links","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /wallet/spending-report-links","href":"/platform/oauth/exports/get-spending-report-and-wallet-statement-download-links"},{"title":"Get connected accounts export link (CSV)","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /embed/connected-accounts/export-link","href":"/platform/oauth/exports/get-connected-accounts-export-link-csv"},{"title":"Transfer wallet balance","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /wallet/transfer-balance","href":"/platform/oauth/wallet/transfer-wallet-balance"}]},{"group":"Invoices","pages":[{"title":"List invoices","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /invoices","href":"/platform/oauth/invoices/list-invoices"},{"title":"Get an invoices CSV export download link","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /invoices/export-link","href":"/platform/oauth/exports/get-an-invoices-csv-export-download-link"},{"title":"Get an invoice","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /invoices/{id}","href":"/platform/oauth/invoices/get-an-invoice"},{"title":"Get invoice payment record","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /invoices/{id}/payment-details","href":"/platform/oauth/invoices/get-invoice-payment-record"},{"title":"Create + send an invoice","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /invoices","href":"/platform/oauth/invoices/create-+-send-an-invoice"},{"title":"Resend an invoice email","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /invoices/{id}/send","href":"/platform/oauth/invoices/resend-an-invoice-email"},{"title":"Void an invoice","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /invoices/{id}/void","href":"/platform/oauth/invoices/void-an-invoice"},{"title":"Send an invoice receipt","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /invoices/{id}/receipt","href":"/platform/oauth/invoices/send-an-invoice-receipt"},{"title":"Refund an invoice","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /invoices/{id}/refund","href":"/platform/oauth/invoices/refund-an-invoice"},{"title":"Stop invoice reminders","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /invoices/{id}/stop-reminders","href":"/platform/oauth/invoices/stop-invoice-reminders"},{"title":"Verify an invoice payment","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /invoices/{id}/verify","href":"/platform/oauth/invoices/verify-an-invoice-payment"}]},{"group":"Billing","pages":[{"title":"List payment methods","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /billing/payment-methods","href":"/platform/oauth/billing/list-payment-methods"},{"title":"Get subscription status","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /billing/subscription","href":"/platform/oauth/billing/get-subscription-status"},{"title":"Get billing history","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /billing/history","href":"/platform/oauth/billing/get-billing-history"},{"title":"Get SideShift receipt download links","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /billing/receipt-links","href":"/platform/oauth/exports/get-sideshift-receipt-download-links"},{"title":"Download a SideShift receipt PDF","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /billing/receipts/{id}","href":"/platform/oauth/exports/download-a-sideshift-receipt-pdf"},{"title":"Preview a plan change","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /billing/preview-upgrade","href":"/platform/oauth/billing/preview-a-plan-change"},{"title":"Poll a billing handoff link","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /billing/handoff-link/{code}","href":"/platform/oauth/billing/poll-a-billing-handoff-link"},{"title":"Set default payment method","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /billing/payment-methods/default","href":"/platform/oauth/billing/set-default-payment-method"},{"title":"Cancel a subscription","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /billing/subscription/cancel","href":"/platform/oauth/billing/cancel-a-subscription"},{"title":"Mint a browser billing handoff link","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /billing/handoff-link","href":"/platform/oauth/billing/mint-a-browser-billing-handoff-link"}]},{"group":"Disputes","pages":[{"title":"Get a dispute","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /disputes/{id}","href":"/platform/oauth/disputes/get-a-dispute"},{"title":"List disputes","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /disputes","href":"/platform/oauth/disputes/list-disputes"},{"title":"Prepare a dispute evidence upload","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /disputes/{id}/prepare-upload","href":"/platform/oauth/disputes/prepare-a-dispute-evidence-upload"},{"title":"Resolve a dispute","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /disputes/{id}/resolve","href":"/platform/oauth/disputes/resolve-a-dispute"}]}]},{"group":"Messaging","expanded":true,"pages":[{"group":"Messages","pages":[{"title":"List conversations","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /conversations","href":"/platform/oauth/messages/list-conversations"},{"title":"List messages in a conversation","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /conversations/{id}/messages","href":"/platform/oauth/messages/list-messages-in-a-conversation"},{"title":"List the merged conversation inbox","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /inbox","href":"/platform/oauth/messages/list-the-merged-conversation-inbox"},{"title":"List support channels","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /support-channels","href":"/platform/oauth/messages/list-support-channels"},{"title":"List messages in a support channel","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /support-channels/{id}/messages","href":"/platform/oauth/messages/list-messages-in-a-support-channel"},{"title":"Send a message","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /messages","href":"/platform/oauth/messages/send-a-message"},{"title":"Send a support-channel message","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /support-channels/{id}/messages","href":"/platform/oauth/messages/send-a-support-channel-message"}]},{"group":"Conversations","pages":[{"title":"Create a conversation","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /conversations","href":"/platform/oauth/conversations/create-a-conversation"},{"title":"Forward a message","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /conversations/{id}/forward","href":"/platform/oauth/conversations/forward-a-message"},{"title":"Add a conversation member","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /conversations/{id}/members","href":"/platform/oauth/conversations/add-a-conversation-member"},{"title":"React to a message","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /conversations/{id}/reactions","href":"/platform/oauth/conversations/react-to-a-message"},{"title":"Rename a conversation","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml patch /conversations/{id}","href":"/platform/oauth/conversations/rename-a-conversation"},{"title":"Leave a conversation","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml delete /conversations/{id}/members","href":"/platform/oauth/conversations/leave-a-conversation"}]}]},{"group":"Company \u0026 Team","expanded":true,"pages":[{"group":"Companies","pages":[{"title":"Get invoicing profile","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /companies/billing","href":"/platform/oauth/companies/get-invoicing-profile"},{"title":"Get the agency tree","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /companies/agency-tree","href":"/platform/oauth/companies/get-the-agency-tree"},{"title":"List companies","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /companies","href":"/platform/oauth/companies/list-companies"},{"title":"Create a company","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /companies/create","href":"/platform/oauth/companies/create-a-company"},{"title":"Invite team members","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /companies/invite-team","href":"/platform/oauth/companies/invite-team-members"},{"title":"Join additional agency companies","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /companies/join","href":"/platform/oauth/companies/join-additional-agency-companies"},{"title":"Sync company name and logo","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /companies/sync-name","href":"/platform/oauth/companies/sync-company-name-and-logo"},{"title":"Set company niche","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /companies/update-niche","href":"/platform/oauth/companies/set-company-niche"},{"title":"Set invoicing signed name","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /companies/update-signed-name","href":"/platform/oauth/companies/set-invoicing-signed-name"},{"title":"Update invoicing profile","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml patch /companies/billing","href":"/platform/oauth/companies/update-invoicing-profile"}]},{"group":"Team","pages":[{"title":"Preview a team invite","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /team/invites/{code}","href":"/platform/oauth/team/preview-a-team-invite"},{"title":"List team invites","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /team/invites","href":"/platform/oauth/team/list-team-invites"},{"title":"List team members","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /team","href":"/platform/oauth/team/list-team-members"},{"title":"Accept a team invite","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /team/invites/{code}","href":"/platform/oauth/team/accept-a-team-invite"},{"title":"Send a team invite","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /team/invites","href":"/platform/oauth/team/send-a-team-invite"},{"title":"Resend a team invite","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /team/invites/send","href":"/platform/oauth/team/resend-a-team-invite"},{"title":"Update member permissions","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /team/members/permissions","href":"/platform/oauth/team/update-member-permissions"},{"title":"Add a team member","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /team/members","href":"/platform/oauth/team/add-a-team-member"},{"title":"Remove a team member","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml delete /team/members","href":"/platform/oauth/team/remove-a-team-member"}]},{"group":"Settings","pages":[{"title":"Get company settings","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /settings","href":"/platform/oauth/settings/get-company-settings"},{"title":"Get the company profile","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /company","href":"/platform/oauth/settings/get-the-company-profile"},{"title":"Update company settings","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml patch /settings","href":"/platform/oauth/settings/update-company-settings"}]},{"group":"Integrations","pages":[{"title":"Get agency Slack config","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /integrations/slack/agency","href":"/platform/oauth/integrations/get-agency-slack-config"},{"title":"List Slack channels","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /integrations/slack/channels","href":"/platform/oauth/integrations/list-slack-channels"},{"title":"Get Slack integration","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /integrations/slack","href":"/platform/oauth/integrations/get-slack-integration"},{"title":"Get integration metrics export link (CSV)","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /integrations/metrics-export-link","href":"/platform/oauth/exports/get-integration-metrics-export-link-csv"},{"title":"List Slack templates","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /integrations/slack/templates","href":"/platform/oauth/integrations/list-slack-templates"},{"title":"Sync agency Slack config","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /integrations/slack/agency","href":"/platform/oauth/integrations/sync-agency-slack-config"},{"title":"Remove subaccount workflows","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /integrations/slack/agency/workflows","href":"/platform/oauth/integrations/remove-subaccount-workflows"},{"title":"Save a Slack channel","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /integrations/slack/channels","href":"/platform/oauth/integrations/save-a-slack-channel"},{"title":"Start Slack OAuth","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /integrations/slack/oauth/start","href":"/platform/oauth/integrations/start-slack-oauth"},{"title":"Save Slack integration","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /integrations/slack","href":"/platform/oauth/integrations/save-slack-integration"},{"title":"Save a Slack template","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /integrations/slack/templates","href":"/platform/oauth/integrations/save-a-slack-template"},{"title":"Test a Slack workflow","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /integrations/slack/test-workflow","href":"/platform/oauth/integrations/test-a-slack-workflow"},{"title":"Delete a Slack template","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml delete /integrations/slack/templates","href":"/platform/oauth/integrations/delete-a-slack-template"}]},{"group":"Brand Verification","pages":[{"title":"Get brand verification status","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /brand-verification","href":"/platform/oauth/brand-verification/get-brand-verification-status"}]},{"group":"Verifications","pages":[{"title":"Get verification","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /verifications/{verificationId}","href":"/platform/oauth/verifications/get-verification"}]},{"group":"Agencies","pages":[{"title":"Get client notes","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /agencies/clients/{clientId}/notes","href":"/platform/oauth/agencies/get-client-notes"},{"title":"Get contract notes","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /agencies/contracts/{contractId}/notes","href":"/platform/oauth/agencies/get-contract-notes"},{"title":"Get creator receipts","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /agencies/creators/receipts","href":"/platform/oauth/agencies/get-creator-receipts"},{"title":"List agency creators","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /agencies/creators","href":"/platform/oauth/agencies/list-agency-creators"},{"title":"Get agency dashboard","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /agencies/dashboard","href":"/platform/oauth/agencies/get-agency-dashboard"},{"title":"List creators for a program","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /agencies/programs/{programId}/creators","href":"/platform/oauth/agencies/list-creators-for-a-program"},{"title":"Get program notes","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /agencies/programs/{programId}/notes","href":"/platform/oauth/agencies/get-program-notes"},{"title":"Get billing profile","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /agency/billing","href":"/platform/oauth/agencies/get-billing-profile"},{"title":"Get per-client billing state","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /agency/billing/state","href":"/platform/oauth/agencies/get-per-client-billing-state"},{"title":"Start agency client checkout","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /agency/billing/subscription-link","href":"/platform/oauth/agencies/start-agency-client-checkout"},{"title":"Enable per-client subscriptions","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /agency/billing/separate-subs","href":"/platform/oauth/agencies/enable-per-client-subscriptions"},{"title":"Assign the per-client billing client","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml post /agency/billing/assign-free-client","href":"/platform/oauth/agencies/assign-the-per-client-billing-client"},{"title":"Archive or unarchive a client","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml patch /agencies/clients/{clientId}/archive","href":"/platform/oauth/agencies/archive-or-unarchive-a-client"},{"title":"Update client notes","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml patch /agencies/clients/{clientId}/notes","href":"/platform/oauth/agencies/update-client-notes"},{"title":"Update contract notes","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml patch /agencies/contracts/{contractId}/notes","href":"/platform/oauth/agencies/update-contract-notes"},{"title":"Update program dashboard notes","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml patch /agencies/programs/{programId}/notes","href":"/platform/oauth/agencies/update-program-dashboard-notes"},{"title":"Update program dashboard status","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml patch /agencies/programs/{programId}/status","href":"/platform/oauth/agencies/update-program-dashboard-status"},{"title":"Update billing profile","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml patch /agency/billing","href":"/platform/oauth/agencies/update-billing-profile"}]},{"group":"Exports","pages":[{"title":"Download an export file","deprecated":null,"version":null,"openapi":"/openapi/oauth.yaml get /exports/{kind}","href":"/platform/oauth/exports/download-an-export-file"}]}]}]},{"group":"Legacy API (Deprecated)","pages":[{"group":"Programs","pages":[{"title":"List programs","deprecated":null,"version":null,"openapi":"/openapi/platform-apikey.yaml get /programs","href":"/platform/api-key/programs/list-programs"},{"title":"Request program invite link","deprecated":null,"version":null,"openapi":"/openapi/platform-apikey.yaml post /programs/{id}/invite","href":"/platform/api-key/programs/request-program-invite-link"}]},{"group":"Posts","pages":[{"title":"List posts","deprecated":null,"version":null,"openapi":"/openapi/platform-apikey.yaml get /posts","href":"/platform/api-key/posts/list-posts"},{"title":"Get video details","deprecated":null,"version":null,"openapi":"/openapi/platform-apikey.yaml get /posts/{id}","href":"/platform/api-key/posts/get-video-details"},{"title":"Get video metrics history","deprecated":null,"version":null,"openapi":"/openapi/platform-apikey.yaml get /posts/{id}/metrics-history","href":"/platform/api-key/posts/get-video-metrics-history"},{"title":"Export posts as CSV","deprecated":null,"version":null,"openapi":"/openapi/platform-apikey.yaml post /posts/export","href":"/platform/api-key/posts/export-posts-as-csv"},{"title":"Export unique creator handles as CSV","deprecated":null,"version":null,"openapi":"/openapi/platform-apikey.yaml post /posts/export-handles","href":"/platform/api-key/posts/export-unique-creator-handles-as-csv"}]},{"group":"Analytics","pages":[{"title":"Get comprehensive KPIs","deprecated":null,"version":null,"openapi":"/openapi/platform-apikey.yaml get /analytics/kpis","href":"/platform/api-key/analytics/get-comprehensive-kpis"},{"title":"List all tracked videos with analytics","deprecated":null,"version":null,"openapi":"/openapi/platform-apikey.yaml get /analytics/videos","href":"/platform/api-key/analytics/list-all-tracked-videos-with-analytics"},{"title":"List all tracked accounts","deprecated":null,"version":null,"openapi":"/openapi/platform-apikey.yaml get /analytics/accounts","href":"/platform/api-key/analytics/list-all-tracked-accounts"},{"title":"General analytics overview","deprecated":null,"version":null,"openapi":"/openapi/platform-apikey.yaml get /analytics/overview","href":"/platform/api-key/analytics/general-analytics-overview"},{"title":"Get daily recruitment outreach analytics","deprecated":null,"version":null,"openapi":"/openapi/platform-apikey.yaml get /analytics/recruitment","href":"/platform/api-key/analytics/get-daily-recruitment-outreach-analytics"}]},{"group":"Payouts","pages":[{"title":"List wallet activity","deprecated":null,"version":null,"openapi":"/openapi/platform-apikey.yaml get /payouts","href":"/platform/api-key/payouts/list-wallet-activity"},{"title":"Get payout wallet stats","deprecated":null,"version":null,"openapi":"/openapi/platform-apikey.yaml get /payouts/stats","href":"/platform/api-key/payouts/get-payout-wallet-stats"},{"title":"Get pending payouts","deprecated":null,"version":null,"openapi":"/openapi/platform-apikey.yaml get /payouts/pending","href":"/platform/api-key/payouts/get-pending-payouts"}]},{"group":"Contracts","pages":[{"title":"List contracts","deprecated":null,"version":null,"openapi":"/openapi/platform-apikey.yaml get /contracts","href":"/platform/api-key/contracts/list-contracts"}]},{"group":"Creators","pages":[{"title":"List creators","deprecated":null,"version":null,"openapi":"/openapi/platform-apikey.yaml get /creators","href":"/platform/api-key/creators/list-creators"},{"title":"List creator collections","deprecated":null,"version":null,"openapi":"/openapi/platform-apikey.yaml get /creators/collections","href":"/platform/api-key/creators/list-creator-collections"}]},{"group":"Invoices","pages":[{"title":"List invoices","description":"List invoices for the authenticated company, ordered newest-first.\n","deprecated":null,"version":null,"openapi":"/openapi/platform-apikey.yaml get /invoices","href":"/platform/api-key/invoices/list-invoices"},{"title":"Get invoice","deprecated":null,"version":null,"openapi":"/openapi/platform-apikey.yaml get /invoices/{invoiceId}","href":"/platform/api-key/invoices/get-invoice"},{"title":"Create and send an invoice","description":"Create an invoice for a customer and (by default) email the hosted\npayment link to them. Returns the saved invoice along with the hosted\npayment URL.\n\n- Set `sendEmail` to `false` if you only want to create the invoice without\n delivering it. You can email it later via `POST /invoices/{invoiceId}/send`.\n\nPayment links: set `invoiceType` to `payment_link` for a recipient-free\ncheckout link. Payment-link templates are listed alongside regular invoices;\nreusable links mint a child invoice per payment. Sending email on a payment\nlink returns `409`.\n- All amounts are integer cents (`unitPriceCents`, `taxCents`,\n `discountCents`).\n- `dueDate` must be an ISO 8601 date or date-time string.\n- `allowedPaymentTypes` defaults to `[\"card\"]`. See the schema for\n supported values.\n- Card and Plaid-ACH payments are handled by the `card` and\n `us_bank_account` methods (Whop checkout). Use those for any flow\n that pulls funds from the customer's account.\n- **BNPL (pay over time):** including one or more BNPL values (see\n the `allowedPaymentTypes` enum — `klarna`, `affirm`,\n `afterpay_clearpay`, `sezzle`, `zip`, card installments, and more)\n lets the payer choose **Pay now / Pay over time** on the hosted\n invoice page. BNPL payments are processed by Whop. The payer is\n charged the invoice total unchanged; the merchant's net proceeds\n are reduced by a **16%** merchant fee when the payer pays over\n time. Each BNPL option is shown only when the provider is enabled\n for the account, supports the invoice currency, and the invoice\n total is within the provider's supported amount range. Renewal\n invoices do not offer BNPL.\n- Including `bank_transfer` provisions a Stripe virtual bank account\n dedicated to **wire transfers**. The response will include\n `bankTransferInstructions` with a unique account number, routing\n number, and reference code (USD, EUR, GBP, JPY, or MXN). We never\n link out to a Stripe-hosted page — render the fields inline in\n your UI / email / PDF. The customer must include the `reference`\n string in the wire memo so Stripe can match the inbound payment\n to the correct invoice.\n- **Wire fee:** invoices that include `bank_transfer` carry a 1%\n platform fee on top of `totalCents`. The customer wires\n `bankTransferAmountCents` (`totalCents + bankTransferFeeCents`);\n the merchant is credited only `totalCents`. Card and ACH rails\n do not include this fee.\n- If Stripe Customer Balance is not yet enabled on the account when\n the invoice is created, `bankTransferInstructions` will be `null`\n on the create response. They self-heal — the next call to\n `GET /invoices/{invoiceId}` will lazily provision and persist the\n virtual receiving account.\n","deprecated":null,"version":null,"openapi":"/openapi/platform-apikey.yaml post /invoices","href":"/platform/api-key/invoices/create-and-send-an-invoice"},{"title":"Email an invoice to its customer","deprecated":null,"version":null,"openapi":"/openapi/platform-apikey.yaml post /invoices/{invoiceId}/send","href":"/platform/api-key/invoices/email-an-invoice-to-its-customer"},{"title":"Void an unpaid invoice","deprecated":null,"version":null,"openapi":"/openapi/platform-apikey.yaml post /invoices/{invoiceId}/void","href":"/platform/api-key/invoices/void-an-unpaid-invoice"}]},{"group":"Discover","pages":[{"title":"List Discover leads","deprecated":null,"version":null,"openapi":"/openapi/platform-apikey.yaml get /discover/leads","href":"/platform/api-key/discover/list-discover-leads"},{"title":"Get a Discover lead","deprecated":null,"version":null,"openapi":"/openapi/platform-apikey.yaml get /discover/leads/{leadId}","href":"/platform/api-key/discover/get-a-discover-lead"}]}]}]},{"tab":"Connect","icon":"wallet","pages":[{"title":"Connect","href":"/connect"}]},{"tab":"Scraper","icon":"search","pages":[{"title":"Scraper","href":"/scraper"}]},{"tab":"Sidekick","icon":"blocks","pages":[{"title":"Sidekick","href":"/sidekick/connectors"}]},{"tab":"MCP","icon":"plug","pages":[{"title":"MCP","href":"/mcp-server"}]}]},"basePath":"","title":"Get invoice - SideShift","buildId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","deploymentId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CBsVopKK.js","utils-DZAk68jJ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-D32AYZrP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D_A5_cny.js","snippetPresets-xNRfS9th.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BIB25-tq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CydJ4w4j.js","shallow-CYPBeQSG.js","getApiPlaygroundDisplay-A5xJVBOu.js","CodeSnippet-BVRTgi3m.js","CodeSnippets-DjD6BSlt.js","Page-Dr40SSJq.js","getPastedJson-D4V4JyrR.js","icon-uhcnG22T.js","MethodPill-CM-ZQdGH.js","DuplicateIcon-B_WnOiNf.js","createIcon-CJsb8utt.js","DynamicMarkdown-D-2HDKEp.js","SectionHeading-KP5xmMgQ.js","axios-vUo_bRtp.js","Markdown-D_k0dg6k.js","clsx-DK3K4Z1S.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DE3EVdvd.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-fN9H9n9g.js"]}