Represents a user with detailed merchant-related information.
Show child attributes
Last modified on December 1, 2025
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Komerza Documentation","colors":{"primary":"#3b82f6","light":"#3b82f6","dark":"#2563eb"},"logo":{"light":"https://mintcdn.com/komerza/b8Ru_h-4KK1SQzzO/logo/light.svg?fit=max\u0026auto=format\u0026n=b8Ru_h-4KK1SQzzO\u0026q=85\u0026s=0f9ba8d2c97d0b7886be5ab88b8a1521","dark":"https://mintcdn.com/komerza/b8Ru_h-4KK1SQzzO/logo/dark.svg?fit=max\u0026auto=format\u0026n=b8Ru_h-4KK1SQzzO\u0026q=85\u0026s=d1f22d39eb73b84e71c17d38abfb45d7","href":"https://komerza.com"},"favicon":"https://mintcdn.com/komerza/b8Ru_h-4KK1SQzzO/favicon.svg?fit=max\u0026auto=format\u0026n=b8Ru_h-4KK1SQzzO\u0026q=85\u0026s=75bc08b60ad0a7f1695e7cdb5efa5130","api":{"playground":{"proxy":false},"examples":{"autogenerate":true}},"navbar":{"links":[{"href":"https://komerza.com","label":"Komerza"},{"href":"https://komerza.com/pricing","label":"Pricing"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.komerza.com"}},"footer":{"socials":{"x":"https://x.com/komerzaecom","github":"https://github.com/komerza","telegram":"https://t.me/komerzaecom"},"links":[{"header":"Komerza","items":[{"label":"Home","href":"https://komerza.com"},{"label":"Pricing","href":"https://komerza.com/pricing"},{"label":"Features","href":"https://komerza.com/features"},{"label":"Blog","href":"https://komerza.com/blog"}]},{"header":"Company","items":[{"label":"About","href":"https://komerza.com/about"},{"label":"Compare platforms","href":"https://komerza.com/alternatives"},{"label":"Brand","href":"https://komerza.com/brand"},{"label":"Legal","href":"https://komerza.com/legal"}]}]},"fonts":{"family":"Inter"},"integrations":{"intercom":{"appId":"hekgn53e"}},"errors":{"404":{"redirect":false,"title":"Page not found","description":"The page you're looking for doesn't exist. Head back to the [home page](/), explore the [API Reference](/api-reference/introduction), or browse the [Guides](/)."}},"contextual":{"options":["copy","view","chatgpt","claude","vscode","cursor"],"display":"header"},"metadata":{"timestamp":true},"markdown":{"schema":false},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"System Status","icon":"wave-pulse","href":"https://status.komerza.com"},{"anchor":"Telegram","icon":"telegram","href":"https://t.me/komerzaecom"},{"anchor":"Discord","icon":"discord","href":"https://discord.gg/komerza"}]},"languages":[{"language":"en","href":""},{"language":"fr","href":"fr"},{"language":"de","href":"de"},{"language":"pl","href":"pl"},{"language":"es","href":"es"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"komerza","hasAudioNarration":false,"actualSubdomain":"komerza","customDomains":["docs.komerza.com"],"gitSource":{"type":"github","owner":"komerza","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adb977a27ec6dc3da981b39","collectionId":"f85ed26f-69be-4996-acd1-95a3687c9c74","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adb977a27ec6dc3da981b39"},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{},"buildId":"6adb977a27ec6dc3da981b39","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"API Reference","count":169},{"language":"en","tag":"Guides","count":40},{"language":"default","tag":"Reseller Programme","count":28},{"language":"default","tag":"Variants","count":25},{"language":"default","tag":"Products","count":17},{"language":"default","tag":"Reselling","count":17},{"language":"default","tag":"Affiliates","count":13},{"language":"en","tag":"Payment Setup","count":13},{"language":"de","tag":"Anleitungen","count":11},{"language":"es","tag":"Guías","count":11},{"language":"fr","tag":"Guides","count":11},{"language":"pl","tag":"Przewodniki","count":11},{"language":"en","tag":"Storefront SDK","count":10},{"language":"default","tag":"Categories","count":8},{"language":"default","tag":"Orders","count":8},{"language":"default","tag":"Webhooks","count":8},{"language":"default","tag":"Reference","count":7},{"language":"de","tag":"Storefront-SDK","count":7},{"language":"es","tag":"SDK de Tienda","count":7},{"language":"fr","tag":"SDK Storefront","count":7},{"language":"en","tag":"Integration Guides","count":7},{"language":"pl","tag":"SDK Sklepowy","count":7},{"language":"en","tag":"Store Setup","count":6},{"language":"en","tag":"Client Library","count":6},{"language":"de","tag":"Zahlungseinrichtung","count":5},{"language":"de","tag":"Client Library","count":5},{"language":"es","tag":"Configuración de Pagos","count":5},{"language":"es","tag":"Client Library","count":5},{"language":"fr","tag":"Configuration des Paiements","count":5},{"language":"fr","tag":"Client Library","count":5},{"language":"en","tag":"Storefront Builder","count":5},{"language":"pl","tag":"Konfiguracja Płatności","count":5},{"language":"pl","tag":"Client Library","count":5},{"language":"en","tag":"Getting Started","count":4},{"language":"de","tag":"Integrationsleitfäden","count":3},{"language":"es","tag":"Guías de Integración","count":3},{"language":"fr","tag":"Guides d'Intégration","count":3},{"language":"en","tag":"Orders \u0026 Customers","count":3},{"language":"en","tag":"Get Started","count":3},{"language":"pl","tag":"Przewodniki Integracji","count":3},{"language":"de","tag":"Erste Schritte","count":2},{"language":"de","tag":"Getting Started","count":2},{"language":"es","tag":"Empezar","count":2},{"language":"es","tag":"Getting Started","count":2},{"language":"fr","tag":"Démarrer","count":2},{"language":"fr","tag":"Getting Started","count":2},{"language":"pl","tag":"Pierwsze Kroki","count":2},{"language":"pl","tag":"Getting Started","count":2},{"language":"de","tag":"Shop-Einrichtung","count":1},{"language":"es","tag":"Configuración de la Tienda","count":1},{"language":"fr","tag":"Configuration du Magasin","count":1},{"language":"pl","tag":"Konfiguracja Sklepu","count":1}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"privacy":{"consentBanner":{"enabled":true}},"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":":root{--color-primary-50:#eff6ff;--color-primary-100:#dbeafe;--color-primary-200:#bfdbfe;--color-primary-300:#93c5fd;--color-primary-400:#60a5fa;--color-primary-500:#3b82f6;--color-primary-600:#2563eb;--color-primary-700:#1d4ed8;--color-primary-800:#1e40af;--color-primary-900:#1e3a8a;--color-success-50:#ecfdf5;--color-success-100:#d1fae5;--color-success-200:#a7f3d0;--color-success-300:#6ee7b7;--color-success-400:#34d399;--color-success-500:#10b981;--color-success-600:#059669;--color-success-700:#047857;--color-success-800:#065f46;--color-success-900:#064e3b;--color-warning-50:#fffbeb;--color-warning-100:#fef3c7;--color-warning-200:#fde68a;--color-warning-300:#fcd34d;--color-warning-400:#fbbf24;--color-warning-500:#f59e0b;--color-warning-600:#d97706;--color-warning-700:#b45309;--color-warning-800:#92400e;--color-warning-900:#78350f;--color-error-50:#fef2f2;--color-error-100:#fee2e2;--color-error-200:#fecaca;--color-error-300:#fca5a5;--color-error-400:#f87171;--color-error-500:#ef4444;--color-error-600:#dc2626;--color-error-700:#b91c1c;--color-error-800:#991b1b;--color-error-900:#7f1d1d;--color-gray-50:oklch(98.5% 0 0);--color-gray-100:oklch(97% 0 0);--color-gray-200:oklch(92.2% 0 0);--color-gray-300:oklch(87% 0 0);--color-gray-400:oklch(70.8% 0 0);--color-gray-500:#3c3c3c;--color-gray-600:#303030;--color-gray-700:#242424;--color-gray-800:#151515;--color-gray-900:#0c0c0c;font-family:\"Inter Variable\",system-ui,sans-serif}html{scroll-behavior:smooth}#page-title,h1,h2,h3,h4,h5,h6{font-weight:500}.kicon{display:inline-block;width:1.25rem;height:1.25rem;flex:none;vertical-align:-.2em;background-color:currentColor;-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;-webkit-mask-position:center;mask-position:center;-webkit-mask-size:contain;mask-size:contain}.kicon-sm{width:1rem;height:1rem}.kicon-arrow-up-right{-webkit-mask-image:url(/icons/arrow-up-right.svg);mask-image:url(/icons/arrow-up-right.svg)}.kicon-bell{-webkit-mask-image:url(/icons/bell.svg);mask-image:url(/icons/bell.svg)}.kicon-bolt{-webkit-mask-image:url(/icons/bolt.svg);mask-image:url(/icons/bolt.svg)}.kicon-book{-webkit-mask-image:url(/icons/book.svg);mask-image:url(/icons/book.svg)}.kicon-box{-webkit-mask-image:url(/icons/box.svg);mask-image:url(/icons/box.svg)}.kicon-chart-line{-webkit-mask-image:url(/icons/chart-line.svg);mask-image:url(/icons/chart-line.svg)}.kicon-check-list{-webkit-mask-image:url(/icons/check-list.svg);mask-image:url(/icons/check-list.svg)}.kicon-code{-webkit-mask-image:url(/icons/code.svg);mask-image:url(/icons/code.svg)}.kicon-color-palette{-webkit-mask-image:url(/icons/color-palette.svg);mask-image:url(/icons/color-palette.svg)}.kicon-credit-card{-webkit-mask-image:url(/icons/credit-card.svg);mask-image:url(/icons/credit-card.svg)}.kicon-flask{-webkit-mask-image:url(/icons/flask.svg);mask-image:url(/icons/flask.svg)}.kicon-globe{-webkit-mask-image:url(/icons/globe.svg);mask-image:url(/icons/globe.svg)}.kicon-handshake{-webkit-mask-image:url(/icons/handshake.svg);mask-image:url(/icons/handshake.svg)}.kicon-image{-webkit-mask-image:url(/icons/image.svg);mask-image:url(/icons/image.svg)}.kicon-key{-webkit-mask-image:url(/icons/key.svg);mask-image:url(/icons/key.svg)}.kicon-laptop{-webkit-mask-image:url(/icons/laptop.svg);mask-image:url(/icons/laptop.svg)}.kicon-layers{-webkit-mask-image:url(/icons/layers.svg);mask-image:url(/icons/layers.svg)}.kicon-list{-webkit-mask-image:url(/icons/list.svg);mask-image:url(/icons/list.svg)}.kicon-magnifier{-webkit-mask-image:url(/icons/magnifier.svg);mask-image:url(/icons/magnifier.svg)}.kicon-money-bill{-webkit-mask-image:url(/icons/money-bill.svg);mask-image:url(/icons/money-bill.svg)}.kicon-money-transfer{-webkit-mask-image:url(/icons/money-transfer.svg);mask-image:url(/icons/money-transfer.svg)}.kicon-palette{-webkit-mask-image:url(/icons/palette.svg);mask-image:url(/icons/palette.svg)}.kicon-pulse{-webkit-mask-image:url(/icons/pulse.svg);mask-image:url(/icons/pulse.svg)}.kicon-receipt{-webkit-mask-image:url(/icons/receipt.svg);mask-image:url(/icons/receipt.svg)}.kicon-repeat{-webkit-mask-image:url(/icons/repeat.svg);mask-image:url(/icons/repeat.svg)}.kicon-rocket{-webkit-mask-image:url(/icons/rocket.svg);mask-image:url(/icons/rocket.svg)}.kicon-shield{-webkit-mask-image:url(/icons/shield.svg);mask-image:url(/icons/shield.svg)}.kicon-sliders{-webkit-mask-image:url(/icons/sliders.svg);mask-image:url(/icons/sliders.svg)}.kicon-tag{-webkit-mask-image:url(/icons/tag.svg);mask-image:url(/icons/tag.svg)}.kicon-terminal{-webkit-mask-image:url(/icons/terminal.svg);mask-image:url(/icons/terminal.svg)}.kicon-truck{-webkit-mask-image:url(/icons/truck.svg);mask-image:url(/icons/truck.svg)}.kicon-users{-webkit-mask-image:url(/icons/users.svg);mask-image:url(/icons/users.svg)}.kicon-wallet{-webkit-mask-image:url(/icons/wallet.svg);mask-image:url(/icons/wallet.svg)}.kicon-webhook{-webkit-mask-image:url(/icons/webhook.svg);mask-image:url(/icons/webhook.svg)}svg[style*=\"/arrow-pointer.svg\"]{-webkit-mask-image:url(/icons/button-cursor.svg)!important;mask-image:url(/icons/button-cursor.svg)!important}svg[style*=\"/arrow-right-arrow-left.svg\"]{-webkit-mask-image:url(/icons/swap.svg)!important;mask-image:url(/icons/swap.svg)!important}svg[style*=\"/arrow-right-to-bracket.svg\"]{-webkit-mask-image:url(/icons/rect-login.svg)!important;mask-image:url(/icons/rect-login.svg)!important}svg[style*=\"/arrow-up.svg\"]{-webkit-mask-image:url(/icons/arrow-up.svg)!important;mask-image:url(/icons/arrow-up.svg)!important}svg[style*=\"/ban.svg\"]{-webkit-mask-image:url(/icons/ban.svg)!important;mask-image:url(/icons/ban.svg)!important}svg[style*=\"/bell.svg\"]{-webkit-mask-image:url(/icons/bell.svg)!important;mask-image:url(/icons/bell.svg)!important}svg[style*=\"/bolt.svg\"]{-webkit-mask-image:url(/icons/bolt.svg)!important;mask-image:url(/icons/bolt.svg)!important}svg[style*=\"/book.svg\"]{-webkit-mask-image:url(/icons/book.svg)!important;mask-image:url(/icons/book.svg)!important}svg[style*=\"/box.svg\"]{-webkit-mask-image:url(/icons/box.svg)!important;mask-image:url(/icons/box.svg)!important}svg[style*=\"/caret-right.svg\"]{-webkit-mask-image:url(/icons/chevron-right.svg)!important;mask-image:url(/icons/chevron-right.svg)!important}svg[style*=\"/cart-shopping.svg\"]{-webkit-mask-image:url(/icons/cart-shopping.svg)!important;mask-image:url(/icons/cart-shopping.svg)!important}svg[style*=\"/chart-bar.svg\"]{-webkit-mask-image:url(/icons/chart-bar.svg)!important;mask-image:url(/icons/chart-bar.svg)!important}svg[style*=\"/chart-line.svg\"]{-webkit-mask-image:url(/icons/chart-line.svg)!important;mask-image:url(/icons/chart-line.svg)!important}svg[style*=\"/circle-check.svg\"]{-webkit-mask-image:url(/icons/circle-check.svg)!important;mask-image:url(/icons/circle-check.svg)!important}svg[style*=\"/circle-info.svg\"]{-webkit-mask-image:url(/icons/circle-info.svg)!important;mask-image:url(/icons/circle-info.svg)!important}svg[style*=\"/circle-question.svg\"]{-webkit-mask-image:url(/icons/circle-question.svg)!important;mask-image:url(/icons/circle-question.svg)!important}svg[style*=\"/circle-xmark.svg\"]{-webkit-mask-image:url(/icons/circle-xmark.svg)!important;mask-image:url(/icons/circle-xmark.svg)!important}svg[style*=\"/clock.svg\"]{-webkit-mask-image:url(/icons/clock.svg)!important;mask-image:url(/icons/clock.svg)!important}svg[style*=\"/clock-rotate-left.svg\"]{-webkit-mask-image:url(/icons/arrow-rotate-clockwise.svg)!important;mask-image:url(/icons/arrow-rotate-clockwise.svg)!important}svg[style*=\"/cloud-arrow-up.svg\"]{-webkit-mask-image:url(/icons/cloud-upload.svg)!important;mask-image:url(/icons/cloud-upload.svg)!important}svg[style*=\"/code.svg\"]{-webkit-mask-image:url(/icons/code.svg)!important;mask-image:url(/icons/code.svg)!important}svg[style*=\"/code-merge.svg\"]{-webkit-mask-image:url(/icons/code-merge.svg)!important;mask-image:url(/icons/code-merge.svg)!important}svg[style*=\"/coins.svg\"]{-webkit-mask-image:url(/icons/coins.svg)!important;mask-image:url(/icons/coins.svg)!important}svg[style*=\"/credit-card.svg\"]{-webkit-mask-image:url(/icons/credit-card.svg)!important;mask-image:url(/icons/credit-card.svg)!important}svg[style*=\"/desktop.svg\"]{-webkit-mask-image:url(/icons/monitor.svg)!important;mask-image:url(/icons/monitor.svg)!important}svg[style*=\"/diagram-project.svg\"]{-webkit-mask-image:url(/icons/sitemap.svg)!important;mask-image:url(/icons/sitemap.svg)!important}svg[style*=\"/dollar-sign.svg\"]{-webkit-mask-image:url(/icons/currency-dollar.svg)!important;mask-image:url(/icons/currency-dollar.svg)!important}svg[style*=\"/download.svg\"]{-webkit-mask-image:url(/icons/download.svg)!important;mask-image:url(/icons/download.svg)!important}svg[style*=\"/ellipsis-vertical.svg\"]{-webkit-mask-image:url(/icons/dots-vertical.svg)!important;mask-image:url(/icons/dots-vertical.svg)!important}svg[style*=\"/envelope.svg\"]{-webkit-mask-image:url(/icons/envelope.svg)!important;mask-image:url(/icons/envelope.svg)!important}svg[style*=\"/eye-slash.svg\"]{-webkit-mask-image:url(/icons/eye-slash.svg)!important;mask-image:url(/icons/eye-slash.svg)!important}svg[style*=\"/feather.svg\"]{-webkit-mask-image:url(/icons/feather.svg)!important;mask-image:url(/icons/feather.svg)!important}svg[style*=\"/file-code.svg\"]{-webkit-mask-image:url(/icons/window-code.svg)!important;mask-image:url(/icons/window-code.svg)!important}svg[style*=\"/filter-list.svg\"]{-webkit-mask-image:url(/icons/filter.svg)!important;mask-image:url(/icons/filter.svg)!important}svg[style*=\"/gamepad.svg\"]{-webkit-mask-image:url(/icons/gamepad.svg)!important;mask-image:url(/icons/gamepad.svg)!important}svg[style*=\"/gauge-high.svg\"]{-webkit-mask-image:url(/icons/gauge.svg)!important;mask-image:url(/icons/gauge.svg)!important}svg[style*=\"/globe.svg\"]{-webkit-mask-image:url(/icons/globe.svg)!important;mask-image:url(/icons/globe.svg)!important}svg[style*=\"/handshake.svg\"]{-webkit-mask-image:url(/icons/handshake.svg)!important;mask-image:url(/icons/handshake.svg)!important}svg[style*=\"/headset.svg\"]{-webkit-mask-image:url(/icons/headset.svg)!important;mask-image:url(/icons/headset.svg)!important}svg[style*=\"/house.svg\"]{-webkit-mask-image:url(/icons/house.svg)!important;mask-image:url(/icons/house.svg)!important}svg[style*=\"/key.svg\"]{-webkit-mask-image:url(/icons/key.svg)!important;mask-image:url(/icons/key.svg)!important}svg[style*=\"/laptop-binary.svg\"]{-webkit-mask-image:url(/icons/laptop.svg)!important;mask-image:url(/icons/laptop.svg)!important}svg[style*=\"/layer-group.svg\"]{-webkit-mask-image:url(/icons/layers.svg)!important;mask-image:url(/icons/layers.svg)!important}svg[style*=\"/lock.svg\"]{-webkit-mask-image:url(/icons/lock.svg)!important;mask-image:url(/icons/lock.svg)!important}svg[style*=\"/magnifying-glass.svg\"]{-webkit-mask-image:url(/icons/magnifier.svg)!important;mask-image:url(/icons/magnifier.svg)!important}svg[style*=\"/megaphone.svg\"]{-webkit-mask-image:url(/icons/megaphone.svg)!important;mask-image:url(/icons/megaphone.svg)!important}svg[style*=\"/messages-question.svg\"]{-webkit-mask-image:url(/icons/circle-question.svg)!important;mask-image:url(/icons/circle-question.svg)!important}svg[style*=\"/mobile.svg\"]{-webkit-mask-image:url(/icons/mobile.svg)!important;mask-image:url(/icons/mobile.svg)!important}svg[style*=\"/object-group.svg\"]{-webkit-mask-image:url(/icons/object-selection.svg)!important;mask-image:url(/icons/object-selection.svg)!important}svg[style*=\"/palette.svg\"]{-webkit-mask-image:url(/icons/palette.svg)!important;mask-image:url(/icons/palette.svg)!important}svg[style*=\"/plug.svg\"]{-webkit-mask-image:url(/icons/plug.svg)!important;mask-image:url(/icons/plug.svg)!important}svg[style*=\"/puzzle-piece.svg\"]{-webkit-mask-image:url(/icons/puzzle-piece.svg)!important;mask-image:url(/icons/puzzle-piece.svg)!important}svg[style*=\"/receipt.svg\"]{-webkit-mask-image:url(/icons/receipt.svg)!important;mask-image:url(/icons/receipt.svg)!important}svg[style*=\"/repeat.svg\"]{-webkit-mask-image:url(/icons/repeat.svg)!important;mask-image:url(/icons/repeat.svg)!important}svg[style*=\"/robot.svg\"]{-webkit-mask-image:url(/icons/robot.svg)!important;mask-image:url(/icons/robot.svg)!important}svg[style*=\"/rocket.svg\"]{-webkit-mask-image:url(/icons/rocket.svg)!important;mask-image:url(/icons/rocket.svg)!important}svg[style*=\"/server.svg\"]{-webkit-mask-image:url(/icons/server.svg)!important;mask-image:url(/icons/server.svg)!important}svg[style*=\"/shield.svg\"]{-webkit-mask-image:url(/icons/shield.svg)!important;mask-image:url(/icons/shield.svg)!important}svg[style*=\"/shield-check.svg\"]{-webkit-mask-image:url(/icons/shield-check.svg)!important;mask-image:url(/icons/shield-check.svg)!important}svg[style*=\"/shield-halved.svg\"]{-webkit-mask-image:url(/icons/shield.svg)!important;mask-image:url(/icons/shield.svg)!important}svg[style*=\"/shopping-cart.svg\"]{-webkit-mask-image:url(/icons/cart-shopping.svg)!important;mask-image:url(/icons/cart-shopping.svg)!important}svg[style*=\"/sliders.svg\"]{-webkit-mask-image:url(/icons/sliders.svg)!important;mask-image:url(/icons/sliders.svg)!important}svg[style*=\"/store.svg\"]{-webkit-mask-image:url(/icons/shop.svg)!important;mask-image:url(/icons/shop.svg)!important}svg[style*=\"/swatchbook.svg\"]{-webkit-mask-image:url(/icons/color-palette.svg)!important;mask-image:url(/icons/color-palette.svg)!important}svg[style*=\"/tag.svg\"]{-webkit-mask-image:url(/icons/tag.svg)!important;mask-image:url(/icons/tag.svg)!important}svg[style*=\"/terminal.svg\"]{-webkit-mask-image:url(/icons/terminal.svg)!important;mask-image:url(/icons/terminal.svg)!important}svg[style*=\"/ticket.svg\"]{-webkit-mask-image:url(/icons/ticket.svg)!important;mask-image:url(/icons/ticket.svg)!important}svg[style*=\"/triangle-exclamation.svg\"]{-webkit-mask-image:url(/icons/triangle-warning.svg)!important;mask-image:url(/icons/triangle-warning.svg)!important}svg[style*=\"/truck.svg\"]{-webkit-mask-image:url(/icons/truck.svg)!important;mask-image:url(/icons/truck.svg)!important}svg[style*=\"/user-shield.svg\"]{-webkit-mask-image:url(/icons/user-shield.svg)!important;mask-image:url(/icons/user-shield.svg)!important}svg[style*=\"/users.svg\"]{-webkit-mask-image:url(/icons/users.svg)!important;mask-image:url(/icons/users.svg)!important}svg[style*=\"/vault.svg\"]{-webkit-mask-image:url(/icons/vault.svg)!important;mask-image:url(/icons/vault.svg)!important}svg[style*=\"/wallet.svg\"]{-webkit-mask-image:url(/icons/wallet.svg)!important;mask-image:url(/icons/wallet.svg)!important}svg[style*=\"/wave-pulse.svg\"]{-webkit-mask-image:url(/icons/heart-pulse.svg)!important;mask-image:url(/icons/heart-pulse.svg)!important}svg[style*=\"/webhook.svg\"]{-webkit-mask-image:url(/icons/webhook.svg)!important;mask-image:url(/icons/webhook.svg)!important}.callout [data-component-part=callout-icon]>svg>*{display:none}.callout [data-component-part=callout-icon]>svg{background-color:currentColor;-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;-webkit-mask-position:center;mask-position:center;-webkit-mask-size:contain;mask-size:contain}.callout.border-blue-200 [data-component-part=callout-icon]>svg{-webkit-mask-image:url(/icons/circle-info.svg);mask-image:url(/icons/circle-info.svg)}.callout.border-green-200 [data-component-part=callout-icon]>svg{-webkit-mask-image:url(/icons/circle-check.svg);mask-image:url(/icons/circle-check.svg)}.callout.border-red-200 [data-component-part=callout-icon]>svg{-webkit-mask-image:url(/icons/circle-xmark.svg);mask-image:url(/icons/circle-xmark.svg)}.callout.border-yellow-200 [data-component-part=callout-icon]>svg{-webkit-mask-image:url(/icons/triangle-warning.svg);mask-image:url(/icons/triangle-warning.svg)}.callout.border-neutral-200 [data-component-part=callout-icon]>svg{-webkit-mask-image:url(/icons/circle-info.svg);mask-image:url(/icons/circle-info.svg)}svg[style*=\"/fire.svg\"]{-webkit-mask-image:url(/brands/heleket.svg)!important;mask-image:url(/brands/heleket.svg)!important}svg[style*=\"/paypal.svg\"]{-webkit-mask-image:url(/brands/paypal.svg)!important;mask-image:url(/brands/paypal.svg)!important}svg[style*=\"/sack-dollar.svg\"]{-webkit-mask-image:url(/brands/paddle.svg)!important;mask-image:url(/brands/paddle.svg)!important}svg[style*=\"/shopify.svg\"]{-webkit-mask-image:url(/brands/shopify.svg)!important;mask-image:url(/brands/shopify.svg)!important}svg[style*=\"/square-dollar.svg\"]{-webkit-mask-image:url(/brands/cash-app.svg)!important;mask-image:url(/brands/cash-app.svg)!important}svg[style*=\"/stripe.svg\"]{-webkit-mask-image:url(/brands/stripe.svg)!important;mask-image:url(/brands/stripe.svg)!important}.kflag{display:inline-block;width:1.25rem;height:1.25rem;flex:none;vertical-align:-.2em;margin-right:.4rem;background-repeat:no-repeat;background-position:center;background-size:contain}.kflag-australia{background-image:url(/flags/australia.svg)}.kflag-belgium{background-image:url(/flags/belgium.svg)}.kflag-brazil{background-image:url(/flags/brazil.svg)}.kflag-canada{background-image:url(/flags/canada.svg)}.kflag-france{background-image:url(/flags/france.svg)}.kflag-germany{background-image:url(/flags/germany.svg)}.kflag-hong-kong{background-image:url(/flags/hong-kong.svg)}.kflag-india{background-image:url(/flags/india.svg)}.kflag-italy{background-image:url(/flags/italy.svg)}.kflag-mexico{background-image:url(/flags/mexico.svg)}.kflag-netherlands{background-image:url(/flags/netherlands.svg)}.kflag-poland{background-image:url(/flags/poland.svg)}.kflag-singapore{background-image:url(/flags/singapore.svg)}.kflag-spain{background-image:url(/flags/spain.svg)}.kflag-sweden{background-image:url(/flags/sweden.svg)}.kflag-united-kingdom{background-image:url(/flags/united-kingdom.svg)}.kflag-united-states{background-image:url(/flags/united-states.svg)}.k-btn{display:inline-flex;align-items:center;justify-content:center;gap:.5rem;font-weight:500;border-radius:var(--k-radius);border:1px solid transparent;cursor:pointer;user-select:none;transition:all 200ms;padding:.5rem 1rem;font-size:.875rem;line-height:1.25rem}.k-btn,.k-btn:active,.k-btn:hover,.k-btn:visited{text-decoration:none}.k-btn[aria-disabled=true],.k-btn[disabled]{opacity:.5;cursor:not-allowed;pointer-events:none}.k-btn--sm{padding:.375rem .75rem;font-size:.875rem}.k-btn--lg{padding:.75rem 1.5rem;font-size:1rem}.k-btn--primary{background-color:var(--color-primary-600);color:#fff;box-shadow:0 1px 2px 0 rgb(0 0 0/.05)}.k-btn--primary:hover{background-color:var(--color-primary-700);color:#fff;box-shadow:0 4px 6px -1px rgb(0 0 0/.1),0 2px 4px -2px rgb(0 0 0/.1)}.k-btn--primary:active{background-color:var(--color-primary-800);box-shadow:0 1px 2px 0 rgb(0 0 0/.05)}.k-btn--outline{border-color:var(--color-gray-300);background-color:#fff;color:var(--color-gray-700)}.k-btn--outline:hover{background-color:var(--color-gray-50);color:var(--color-gray-700)}.dark .k-btn--outline{border-color:var(--color-gray-600);background-color:var(--color-gray-800);color:var(--color-gray-300)}.dark .k-btn--outline:hover{background-color:var(--color-gray-700);color:var(--color-gray-300)}.k-btn--ghost,.k-btn--ghost:hover{color:var(--color-gray-700)}.k-btn--ghost:hover{background-color:var(--color-gray-200)}.dark .k-btn--ghost{color:#fff}.dark .k-btn--ghost:hover{background-color:var(--color-gray-700);color:#fff}.k-btn--danger{background-color:var(--color-error-600);color:#fff;box-shadow:0 1px 2px 0 rgb(0 0 0/.05)}.k-btn--danger:hover{background-color:var(--color-error-700);color:#fff}.k-btn--danger:active{background-color:var(--color-error-800)}:root{--k-radius:0.5rem;--color-orange-100:#ffedd5;--color-orange-400:#fb923c;--color-orange-800:#9a3412;--color-orange-900:#7c2d12}#content-area .card,#localization-select-trigger,#navbar li a[href],#search-bar-entry,#search-bar-entry-mobile,#sidebar-content .nav-anchor,#sidebar-content a[href],#theme-preference-menu-trigger,#topbar-cta-button a,#topbar-cta-button a>span,.tryit-button{border-radius:var(--k-radius)}input:not([type=checkbox]):not([type=radio]):not([type=range]),select,textarea{border-radius:var(--k-radius)}div:has(>div>input.chat-assistant-input){border-radius:var(--k-radius)}#content-area input:not([type=checkbox]):not([type=radio]):not([type=range]):not(.chat-assistant-input),#content-area select,#content-area textarea{display:block;width:100%;padding:.5rem .75rem;border:1px solid var(--color-gray-300);background-color:#fff;color:var(--color-gray-900);box-shadow:0 1px 2px 0 rgb(0 0 0/.05);transition:all 200ms}.dark #content-area input:not([type=checkbox]):not([type=radio]):not([type=range]):not(.chat-assistant-input),.dark #content-area select,.dark #content-area textarea{border-color:var(--color-gray-600);background-color:var(--color-gray-700);color:var(--color-gray-100)}#content-area input::placeholder,#content-area textarea::placeholder{color:var(--color-gray-400)}input:not([type=checkbox]):not([type=radio]):not([type=range]):not(.chat-assistant-input):focus,select:focus,textarea:focus{outline:0;border-color:var(--color-primary-500);box-shadow:0 0 0 3px var(--color-primary-500)}.code-block-copy-button button{border-radius:var(--k-radius);color:var(--color-gray-400);transition:color 150ms,background-color 150ms}.code-block-copy-button button:hover{color:var(--color-gray-600);background-color:var(--color-gray-200)}.dark .code-block-copy-button button:hover{color:var(--color-gray-200);background-color:var(--color-gray-600)}#page-context-menu-button{border-top-left-radius:var(--k-radius);border-bottom-left-radius:var(--k-radius)}#page-context-menu>button:last-child{border-top-right-radius:var(--k-radius);border-bottom-right-radius:var(--k-radius)}.code-block,.code-group{border-radius:var(--k-radius);border-color:var(--color-gray-300)}.dark .code-block,.dark .code-group,.dark a[data-component-part=pagination-next]:hover,.dark a[data-component-part=pagination-prev]:hover{border-color:var(--color-gray-600)}.code-group{padding-bottom:0}.code-group [data-component-part=code-block-root],.code-group div:has(>[data-component-part=code-block-root]){border-radius:0 0 calc(var(--k-radius) - 3px) calc(var(--k-radius) - 3px)!important}.code-group div:has(>[data-component-part=code-block-root])::before{border-radius:0 0 calc(var(--k-radius) - 3px) calc(var(--k-radius) - 3px)}.code-group>div:has([data-component-part=code-block-root]){margin-left:-.125rem;margin-right:-.125rem}#content-area table,.callout,.code-block [data-component-part=code-block-root]{border-radius:var(--k-radius)}.method-nav-pill>span{border-radius:9999px;font-weight:500}.method-nav-pill>span.bg-green-400\\/20{background-color:var(--color-success-100);color:var(--color-success-800)}.dark .method-nav-pill>span.bg-green-400\\/20{background-color:color-mix(in srgb,var(--color-success-900) 20%,transparent);color:var(--color-success-400)}.method-nav-pill>span.bg-blue-400\\/20{background-color:var(--color-primary-100);color:var(--color-primary-800)}.dark .callout.border-blue-200,.dark .method-nav-pill>span.bg-blue-400\\/20{background-color:color-mix(in srgb,var(--color-primary-900) 20%,transparent)}.dark .method-nav-pill>span.bg-blue-400\\/20{color:var(--color-primary-400)}.method-nav-pill>span.bg-yellow-400\\/20{background-color:var(--color-warning-100);color:var(--color-warning-800)}.dark .method-nav-pill>span.bg-yellow-400\\/20{background-color:color-mix(in srgb,var(--color-warning-900) 20%,transparent);color:var(--color-warning-400)}.method-nav-pill>span.bg-orange-400\\/20{background-color:var(--color-orange-100);color:var(--color-orange-800)}.dark .method-nav-pill>span.bg-orange-400\\/20{background-color:color-mix(in srgb,var(--color-orange-900) 20%,transparent);color:var(--color-orange-400)}.method-nav-pill>span.bg-red-400\\/20{background-color:var(--color-error-100);color:var(--color-error-800)}.dark .method-nav-pill>span.bg-red-400\\/20{background-color:color-mix(in srgb,var(--color-error-900) 20%,transparent);color:var(--color-error-400)}.method-nav-pill>span.bg-\\[\\#3064E3\\]{background-color:var(--color-primary-600);color:#fff}.callout{padding:1rem}.callout.border-blue-200{background-color:var(--color-primary-50);border-color:var(--color-primary-200)}.dark .callout.border-blue-200{border-color:var(--color-primary-800)}.callout.border-blue-200 [data-component-part=callout-content]{color:var(--color-primary-700)}.dark .callout.border-blue-200 [data-component-part=callout-content]{color:var(--color-primary-300)}.callout.border-blue-200 [data-component-part=callout-icon]>svg{color:var(--color-primary-600)}.dark .callout.border-blue-200 [data-component-part=callout-icon]>svg{color:var(--color-primary-400)}.callout.border-green-200{background-color:var(--color-success-50);border-color:var(--color-success-200)}.dark .callout.border-green-200{background-color:color-mix(in srgb,var(--color-success-900) 20%,transparent);border-color:var(--color-success-800)}.callout.border-green-200 [data-component-part=callout-content]{color:var(--color-success-700)}.dark .callout.border-green-200 [data-component-part=callout-content]{color:var(--color-success-300)}.callout.border-green-200 [data-component-part=callout-icon]>svg{color:var(--color-success-600)}.dark .callout.border-green-200 [data-component-part=callout-icon]>svg{color:var(--color-success-400)}.callout.border-yellow-200{background-color:var(--color-warning-50);border-color:var(--color-warning-200)}.dark .callout.border-yellow-200{background-color:color-mix(in srgb,var(--color-warning-900) 20%,transparent);border-color:var(--color-warning-800)}.callout.border-yellow-200 [data-component-part=callout-content]{color:var(--color-warning-700)}.dark .callout.border-yellow-200 [data-component-part=callout-content]{color:var(--color-warning-300)}.callout.border-yellow-200 [data-component-part=callout-icon]>svg{color:var(--color-warning-600)}.dark .callout.border-yellow-200 [data-component-part=callout-icon]>svg{color:var(--color-warning-400)}.callout.border-red-200{background-color:var(--color-error-50);border-color:var(--color-error-200)}.dark .callout.border-red-200{background-color:color-mix(in srgb,var(--color-error-900) 20%,transparent);border-color:var(--color-error-800)}.callout.border-red-200 [data-component-part=callout-content]{color:var(--color-error-700)}.dark .callout.border-red-200 [data-component-part=callout-content]{color:var(--color-error-300)}.callout.border-red-200 [data-component-part=callout-icon]>svg{color:var(--color-error-600)}.dark .callout.border-red-200 [data-component-part=callout-icon]>svg{color:var(--color-error-400)}.callout.border-neutral-200{background-color:var(--color-gray-50);border-color:var(--color-gray-200)}.dark .callout.border-neutral-200{background-color:var(--color-gray-800);border-color:var(--color-gray-700)}.callout.border-neutral-200 [data-component-part=callout-content]{color:var(--color-gray-700)}.dark .callout.border-neutral-200 [data-component-part=callout-content]{color:var(--color-gray-300)}.callout.border-neutral-200 [data-component-part=callout-icon]>svg{color:var(--color-gray-600)}.dark .callout.border-neutral-200 [data-component-part=callout-icon]>svg{color:var(--color-gray-400)}#content-area table{border-collapse:separate;border-spacing:0;border:1px solid var(--color-gray-200)}.dark #content-area .accordion-group,.dark #content-area details.accordion,.dark #content-area table,.dark a[data-component-part=pagination-next],.dark a[data-component-part=pagination-prev]{border-color:var(--color-gray-700)}#content-area table td,#content-area table th{border:0;border-bottom:1px solid var(--color-gray-200)}.dark #content-area table td,.dark #content-area table th{border-bottom-color:var(--color-gray-700)}#content-area table tbody tr:last-child td{border-bottom:0}#content-area table tbody tr:hover,#content-area table thead{background-color:var(--color-gray-50)}.dark #content-area table thead{background-color:var(--color-gray-800)}#content-area table th{padding:.75rem 1.5rem;text-align:left;font-size:.75rem;line-height:1rem;font-weight:500;text-transform:uppercase;letter-spacing:.05em;color:var(--color-gray-500)}.dark #content-area table th{color:var(--color-gray-400)}#content-area table td{padding:1rem 1.5rem}#content-area table tbody tr{transition:background-color 200ms}.dark #content-area details.accordion>summary:hover,.dark #content-area table tbody tr:hover{background-color:var(--color-gray-700)}#content-area table thead tr:first-child th:first-child{border-top-left-radius:calc(var(--k-radius) - 1px)}#content-area table thead tr:first-child th:last-child{border-top-right-radius:calc(var(--k-radius) - 1px)}#content-area table tbody tr:last-child td:first-child{border-bottom-left-radius:calc(var(--k-radius) - 1px)}#content-area table tbody tr:last-child td:last-child{border-bottom-right-radius:calc(var(--k-radius) - 1px)}#content-area .accordion-group,#content-area details.accordion,a[data-component-part=pagination-next],a[data-component-part=pagination-prev]{border-radius:var(--k-radius);border-color:var(--color-gray-200)}#content-area details.accordion>summary{border-top-left-radius:var(--k-radius);border-top-right-radius:var(--k-radius)}#content-area [data-component-part=field-required-pill]{border-radius:9999px;background-color:var(--color-error-100);color:var(--color-error-800)}.dark #content-area [data-component-part=field-required-pill]{background-color:color-mix(in srgb,var(--color-error-900) 20%,transparent);color:var(--color-error-400)}#content-area [data-component-part=field-info-pill]{border-radius:9999px;background-color:var(--color-gray-100);color:var(--color-gray-800)}.dark #content-area [data-component-part=field-info-pill],.dark #content-area [data-component-part=step-indicator]{background-color:var(--color-gray-700);color:var(--color-gray-300)}#content-area [data-component-part=step-indicator]{background-color:var(--color-gray-200);color:var(--color-gray-700)}#content-area [data-component-part=step-line]{background-color:var(--color-gray-200)}.dark #content-area [data-component-part=step-line]{background-color:var(--color-gray-700)}a[data-component-part=pagination-next]:hover,a[data-component-part=pagination-prev]:hover{border-color:var(--color-gray-300)}#content-area [role=tablist]:has([data-component-part=tab-button]){border-bottom-color:var(--color-gray-200)}.dark #content-area [role=tablist]:has([data-component-part=tab-button]){border-bottom-color:var(--color-gray-700)}#content-area [data-component-part=tab-button]{font-weight:500}#content-area [data-component-part=tab-button][data-active=true]{color:var(--color-primary-500)}.dark #content-area [data-component-part=tab-button][data-active=false]:hover,.dark #content-area [data-component-part=tab-button][data-active=true]{color:var(--color-primary-400)}#content-area [data-component-part=tab-button][data-active=false]{color:var(--color-gray-500)}.dark #content-area [data-component-part=tab-button][data-active=false]{color:var(--color-gray-400)}#content-area [data-component-part=tab-button][data-active=false]:hover{color:var(--color-primary-500)}"}],"page":{"pagePath":"api-reference/endpoint/users/get","slug":"/api-reference/endpoint/users/get","pageMetadata":{"title":"Get User","openapi":"GET /user","description":"Returns the currently authenticated user’s profile data.\nRequires the `user.view` permission.","href":"/api-reference/endpoint/users/get"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Returns the currently authenticated user’s profile data.\\nRequires the \", _jsx(_components.code, {\n children: \"user.view\"\n }), \" permission.\"]\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":{"config":{},"pageMetadata":{"title":"Get User","openapi":"GET /user","description":"Returns the currently authenticated user’s profile data.\nRequires the `user.view` permission.","href":"/api-reference/endpoint/users/get"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/komerza/8afe0a459f8a498b/hero-search.js","/_mintlify/custom/komerza/55d6214b814c5c42/ripple.js"],"openApiReferenceData":{"operation":{"tags":["User"],"summary":"Get user","description":"Returns the currently authenticated user’s profile data.\nRequires the `user.view` permission.","responses":{"200":"2de47786-12f6-47b6-a05f-894c0790e308","401":"21083965-dc25-4836-b122-8ce07dd284c2"},"x-scopes":["user.view"],"method":"get","type":"path","servers":["c163b8df-bb70-462c-8f9f-8d6477f309a9"],"security":["aa17cceb-4c1e-42f0-8e8d-e9efcfdf2797"],"path":"/user","baseUrlOptions":["https://api.komerza.com"],"title":"Get user","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{},"responses":{"2de47786-12f6-47b6-a05f-894c0790e308":{"description":"The object was successfully returned.","content":{"text/plain":{"schema":{"required":["success"],"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the operation or response was successful.","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"oneOf":[{"type":"string","description":"A descriptive message providing additional context or information about the response.","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"A descriptive message providing additional context or information about the response.","uniqueKey":"message.oneOf.1","typeLabel":"null"}],"uniqueKey":"message","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","description":"The error code (if there was an error) to use when referencing the error","uniqueKey":"code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The error code (if there was an error) to use when referencing the error","uniqueKey":"code.oneOf.1","typeLabel":"null"}],"uniqueKey":"code","typeLabel":"string | null"},"data":{"required":["apiKeys","billingSuspended","dateCreated","disabledPaymentMethods","email","fastSpringEnabled","id","integrationErrorReports","integrations","isAuthorizeNetEnabled","isBuyerProtectionManager","isCryptoEnabled","isSumUpEnabled","lastPasswordUpdate","mollieEnabled","moneyMotionEnabled","nmiEnabled","northbridgeEnabled","ovgcEnabled","paddleEnabled","pandabaseEnabled","passkeyEnabled","paypalBusinessEnabled","plan","restrictedPaymentMethods","riskLocked","riskLockedPaymentMethods","shopifyEnabled","squareEnabled","stores","storrikEnabled","stripeEnabled","totpEnabled","twoFactorEnabled","userName","venPayrEnabled"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the user.","isRequired":true,"uniqueKey":"data.id","typeLabel":"string"},"dateCreated":{"type":"string","description":"The date the entity was created","format":"date-time","isRequired":true,"uniqueKey":"data.dateCreated","typeLabel":"string\u003cdate-time>"},"stores":{"type":"array","items":{"required":["branding","currencyCode","dateCreated","description","domain","enableCartRecovery","id","isAutomaticReviewsEnabled","isBalanceTopUpEnabled","isCustomerBalanceEnabled","isDownloadCenterEnabled","isInactive","isKomerzaPayEnabled","isSplitPaymentEnabled","isTicketingEnabled","name","prependProductNameToReceipt","rating","showPublicStats","showRecentOrderToasts","url"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created","format":"date-time","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].dateCreated","typeLabel":"string\u003cdate-time>"},"name":{"type":"string","description":"The name of the store","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].name","typeLabel":"string"},"description":{"type":"string","description":"The description of the store, shown on their about page and on the home of their store page","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].description","typeLabel":"string"},"url":{"type":"string","description":"The subdomain for the store, ONLY the subdomain, not the fully qualified domain","example":"\n store\n ","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].url","typeLabel":"string"},"currencyCode":{"type":"string","description":"The stores preferred currency","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].currencyCode","typeLabel":"string"},"prependProductNameToReceipt":{"type":"boolean","description":"Whether the name of the product should be prepended to the start of delivery receipts to customers","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].prependProductNameToReceipt","typeLabel":"boolean"},"isAutomaticReviewsEnabled":{"type":"boolean","description":"Whether automatic review leaving is enabled","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].isAutomaticReviewsEnabled","typeLabel":"boolean"},"rating":{"type":"number","description":"The combined average rating for all their products","format":"double","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].rating","typeLabel":"number\u003cdouble>"},"domain":{"type":"string","description":"The domain the store is associated with","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].domain","typeLabel":"string"},"isCustomerBalanceEnabled":{"type":"boolean","description":"Whether the customer balance system is enabled on the stores","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].isCustomerBalanceEnabled","typeLabel":"boolean"},"isBalanceTopUpEnabled":{"type":"boolean","description":"Whether customers can top up their store balance using any enabled payment method.","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].isBalanceTopUpEnabled","typeLabel":"boolean"},"isKomerzaPayEnabled":{"type":"boolean","description":"Whether this store accepts Komerza Pay.\n\nPer store rather than per user, unlike every other gateway: one verified legal entity may\n own several stores and switch them on individually, because enabling it makes Komerza the\n merchant of record for that store's orders.","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].isKomerzaPayEnabled","typeLabel":"boolean"},"isSplitPaymentEnabled":{"type":"boolean","description":"Whether customers can pay for an order partly with their store balance and the remainder\nwith another payment method.","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].isSplitPaymentEnabled","typeLabel":"boolean"},"branding":{"type":"object","properties":{"bannerFileName":{"oneOf":[{"maxLength":64,"type":"string","description":"Represents the file name of the banner associated with the checkout options.","uniqueKey":"data.stores.items.[INDEX].branding.bannerFileName.oneOf.0","typeLabel":"string"},{"maxLength":64,"type":"null","description":"Represents the file name of the banner associated with the checkout options.","uniqueKey":"data.stores.items.[INDEX].branding.bannerFileName.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stores.items.[INDEX].branding.bannerFileName","typeLabel":"string | null"},"iconFileName":{"oneOf":[{"maxLength":64,"type":"string","description":"The icon file name, used for favicon","uniqueKey":"data.stores.items.[INDEX].branding.iconFileName.oneOf.0","typeLabel":"string"},{"maxLength":64,"type":"null","description":"The icon file name, used for favicon","uniqueKey":"data.stores.items.[INDEX].branding.iconFileName.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stores.items.[INDEX].branding.iconFileName","typeLabel":"string | null"},"accentColor":{"oneOf":[{"maxLength":9,"type":"string","description":"Represents the accent color used in the checkout options.","uniqueKey":"data.stores.items.[INDEX].branding.accentColor.oneOf.0","typeLabel":"string"},{"maxLength":9,"type":"null","description":"Represents the accent color used in the checkout options.","uniqueKey":"data.stores.items.[INDEX].branding.accentColor.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stores.items.[INDEX].branding.accentColor","typeLabel":"string | null"}},"additionalProperties":false,"description":"Represents the configurable branding options for a store.","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].branding","typeLabel":"object"},"isTicketingEnabled":{"type":"boolean","description":"Whether the built-in support ticket system is enabled for customers","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].isTicketingEnabled","typeLabel":"boolean"},"isDownloadCenterEnabled":{"type":"boolean","description":"Whether the store offers a download centre to its customers.","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].isDownloadCenterEnabled","typeLabel":"boolean"},"showPublicStats":{"type":"boolean","description":"Whether anonymized public statistics are shown to buyers on the storefront.","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].showPublicStats","typeLabel":"boolean"},"showRecentOrderToasts":{"type":"boolean","description":"Whether recent order toast notifications are shown to visitors on the storefront.","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].showRecentOrderToasts","typeLabel":"boolean"},"enableCartRecovery":{"type":"boolean","description":"Whether abandoned cart recovery emails are enabled for this store.","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].enableCartRecovery","typeLabel":"boolean"},"isInactive":{"type":"boolean","description":"Whether the store is inactive","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].isInactive","typeLabel":"boolean"},"googleSiteVerification":{"oneOf":[{"type":"string","description":"Google Search Console site-verification token, or null. Rendered by the router as a\n\u003cmeta name=\"google-site-verification\"> tag. Public by design — it appears on\nevery rendered page — so exposing it here is not a disclosure.","uniqueKey":"data.stores.items.[INDEX].googleSiteVerification.oneOf.0","typeLabel":"string"},{"type":"null","description":"Google Search Console site-verification token, or null. Rendered by the router as a\n\u003cmeta name=\"google-site-verification\"> tag. Public by design — it appears on\nevery rendered page — so exposing it here is not a disclosure.","uniqueKey":"data.stores.items.[INDEX].googleSiteVerification.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stores.items.[INDEX].googleSiteVerification","typeLabel":"string | null"},"customDomain":{"oneOf":[{"type":"string","description":"The custom domain set for the store, will be null if not set","uniqueKey":"data.stores.items.[INDEX].customDomain.oneOf.0","typeLabel":"string"},{"type":"null","description":"The custom domain set for the store, will be null if not set","uniqueKey":"data.stores.items.[INDEX].customDomain.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stores.items.[INDEX].customDomain","typeLabel":"string | null"},"scopes":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"data.stores.items.[INDEX].scopes.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"The permission scopes that the current user can use for the store, only returned on the /user endpoint for stores\nvisible due to team permissions, will also be null on /user if the store is owned by the user and therefore has\nevery (permissions)","uniqueKey":"data.stores.items.[INDEX].scopes.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"The permission scopes that the current user can use for the store, only returned on the /user endpoint for stores\nvisible due to team permissions, will also be null on /user if the store is owned by the user and therefore has\nevery (permissions)","uniqueKey":"data.stores.items.[INDEX].scopes.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stores.items.[INDEX].scopes","typeLabel":"string[] | null"},"maintenanceReason":{"oneOf":[{"type":"string","description":"The reason the store is in maintenance, if this is null then the store is not in maintenance mode","uniqueKey":"data.stores.items.[INDEX].maintenanceReason.oneOf.0","typeLabel":"string"},{"type":"null","description":"The reason the store is in maintenance, if this is null then the store is not in maintenance mode","uniqueKey":"data.stores.items.[INDEX].maintenanceReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stores.items.[INDEX].maintenanceReason","typeLabel":"string | null"},"termsOfServiceUrl":{"oneOf":[{"type":"string","description":"The URL to the store's terms of service page","uniqueKey":"data.stores.items.[INDEX].termsOfServiceUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"The URL to the store's terms of service page","uniqueKey":"data.stores.items.[INDEX].termsOfServiceUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stores.items.[INDEX].termsOfServiceUrl","typeLabel":"string | null"},"refundPolicyUrl":{"oneOf":[{"type":"string","description":"The URL to the store's refund policy page","uniqueKey":"data.stores.items.[INDEX].refundPolicyUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"The URL to the store's refund policy page","uniqueKey":"data.stores.items.[INDEX].refundPolicyUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stores.items.[INDEX].refundPolicyUrl","typeLabel":"string | null"},"privacyPolicyUrl":{"oneOf":[{"type":"string","description":"The URL to the store's privacy policy page","uniqueKey":"data.stores.items.[INDEX].privacyPolicyUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"The URL to the store's privacy policy page","uniqueKey":"data.stores.items.[INDEX].privacyPolicyUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stores.items.[INDEX].privacyPolicyUrl","typeLabel":"string | null"},"affiliateOptions":{"required":["canConvertAffiliateBalance","defaultReturnPercentage","isEnabled","isLinkEditingEnabled","isPublicRegistrationEnabled"],"type":"object","properties":{"isEnabled":{"type":"boolean","description":"Determines if the affiliate settings are active for the store.","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].affiliateOptions.isEnabled","typeLabel":"boolean"},"defaultReturnPercentage":{"maximum":100,"minimum":0,"type":"integer","description":"Specifies the default return percentage for affiliates within a store, ranging from 0 to 100.","format":"int32","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].affiliateOptions.defaultReturnPercentage","typeLabel":"integer\u003cint32>"},"canConvertAffiliateBalance":{"type":"boolean","description":"Whether the store allows affiliate balance to be converted into customer balance to be used on the store, when\nenabled any affiliate can convert their affiliate balance into customer balance automatically","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].affiliateOptions.canConvertAffiliateBalance","typeLabel":"boolean"},"isPublicRegistrationEnabled":{"type":"boolean","description":"Determines whether public registration is enabled for affiliates within the store.","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].affiliateOptions.isPublicRegistrationEnabled","typeLabel":"boolean"},"isLinkEditingEnabled":{"type":"boolean","description":"Indicates whether link editing capabilities are enabled within the affiliate options for a store.","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].affiliateOptions.isLinkEditingEnabled","typeLabel":"boolean"},"defaultPercentageOff":{"oneOf":[{"maximum":100,"minimum":0,"type":"integer","description":"Represents the default percentage off value used in affiliate settings, where the value must be between 0 and 100.","format":"int32","uniqueKey":"data.stores.items.[INDEX].affiliateOptions.defaultPercentageOff.oneOf.0","typeLabel":"integer\u003cint32>"},{"maximum":100,"minimum":0,"type":"null","description":"Represents the default percentage off value used in affiliate settings, where the value must be between 0 and 100.","format":"int32","uniqueKey":"data.stores.items.[INDEX].affiliateOptions.defaultPercentageOff.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stores.items.[INDEX].affiliateOptions.defaultPercentageOff","typeLabel":"integer\u003cint32> | null"}},"additionalProperties":false,"description":"Represents the configuration options for affiliate settings in a store.","uniqueKey":"data.stores.items.[INDEX].affiliateOptions","typeLabel":"object"},"externalSupportUrl":{"oneOf":[{"type":"string","description":"The URL to direct customers to for external support when ticketing is disabled","uniqueKey":"data.stores.items.[INDEX].externalSupportUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"The URL to direct customers to for external support when ticketing is disabled","uniqueKey":"data.stores.items.[INDEX].externalSupportUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stores.items.[INDEX].externalSupportUrl","typeLabel":"string | null"},"externalSupportDescription":{"oneOf":[{"type":"string","description":"A description shown to customers explaining where to get support when ticketing is disabled","uniqueKey":"data.stores.items.[INDEX].externalSupportDescription.oneOf.0","typeLabel":"string"},{"type":"null","description":"A description shown to customers explaining where to get support when ticketing is disabled","uniqueKey":"data.stores.items.[INDEX].externalSupportDescription.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stores.items.[INDEX].externalSupportDescription","typeLabel":"string | null"},"lastOrderAt":{"oneOf":[{"type":"string","description":"The timestamp of the last order created for this store","format":"date-time","uniqueKey":"data.stores.items.[INDEX].lastOrderAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The timestamp of the last order created for this store","format":"date-time","uniqueKey":"data.stores.items.[INDEX].lastOrderAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stores.items.[INDEX].lastOrderAt","typeLabel":"string\u003cdate-time> | null"}},"additionalProperties":false,"description":"A reference to a store which is owned by a merchant that can be used as a front for selling products to customers","uniqueKey":"data.stores.items.[INDEX]","typeLabel":"object"},"description":"Represents the collection of store references associated with a user.","isRequired":true,"uniqueKey":"data.stores","typeLabel":"object[]"},"email":{"type":"string","description":"The user's email address.","isRequired":true,"uniqueKey":"data.email","typeLabel":"string"},"userName":{"type":"string","description":"The username of the user.","isRequired":true,"uniqueKey":"data.userName","typeLabel":"string"},"plan":{"type":"string","description":"The user's subscription plan.","isRequired":true,"uniqueKey":"data.plan","typeLabel":"string"},"isBuyerProtectionManager":{"type":"boolean","description":"Whether the user has been granted the narrowly-scoped Buyer Protection Manager staff role,\nwhich grants access to the Buyer Protection admin surface only. Independent of Plan,\nwhich by design never reflects this role (see BuyerProtectionManager).","isRequired":true,"uniqueKey":"data.isBuyerProtectionManager","typeLabel":"boolean"},"twoFactorEnabled":{"type":"boolean","description":"Indicates whether two-factor authentication is enabled for the user.","isRequired":true,"uniqueKey":"data.twoFactorEnabled","typeLabel":"boolean"},"totpEnabled":{"type":"boolean","description":"Indicates whether TOTP (authenticator app) two-factor authentication is enabled.","isRequired":true,"uniqueKey":"data.totpEnabled","typeLabel":"boolean"},"passkeyEnabled":{"type":"boolean","description":"Indicates whether passkey two-factor authentication is enabled.","isRequired":true,"uniqueKey":"data.passkeyEnabled","typeLabel":"boolean"},"riskLocked":{"type":"boolean","description":"Whether their account is locked due to being too high risk","isRequired":true,"uniqueKey":"data.riskLocked","typeLabel":"boolean"},"billingSuspended":{"type":"boolean","description":"Whether the user is suspended due to failed payments.","isRequired":true,"uniqueKey":"data.billingSuspended","typeLabel":"boolean"},"integrations":{"type":"array","items":{"required":["application","dateCreated","id"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.integrations.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created","format":"date-time","isRequired":true,"uniqueKey":"data.integrations.items.[INDEX].dateCreated","typeLabel":"string\u003cdate-time>"},"application":{"required":["dateCreated","id","name","permissions","redirectUrls","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.integrations.items.[INDEX].application.id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created","format":"date-time","isRequired":true,"uniqueKey":"data.integrations.items.[INDEX].application.dateCreated","typeLabel":"string\u003cdate-time>"},"name":{"maxLength":100,"minLength":2,"type":"string","description":"The name of the application","isRequired":true,"uniqueKey":"data.integrations.items.[INDEX].application.name","typeLabel":"string"},"permissions":{"type":"array","items":{"type":"string","uniqueKey":"data.integrations.items.[INDEX].application.permissions.items.[INDEX]","typeLabel":"string"},"description":"The list of permissions the application requires","isRequired":true,"uniqueKey":"data.integrations.items.[INDEX].application.permissions","typeLabel":"string[]"},"redirectUrls":{"type":"array","items":{"type":"string","uniqueKey":"data.integrations.items.[INDEX].application.redirectUrls.items.[INDEX]","typeLabel":"string"},"description":"The list of redirect URLs that are authorized for the application","isRequired":true,"uniqueKey":"data.integrations.items.[INDEX].application.redirectUrls","typeLabel":"string[]"},"userId":{"type":"string","description":"The ID of the user who owns the application","isRequired":true,"uniqueKey":"data.integrations.items.[INDEX].application.userId","typeLabel":"string"},"imageName":{"oneOf":[{"type":"string","description":"The name of the image to show for the application","uniqueKey":"data.integrations.items.[INDEX].application.imageName.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name of the image to show for the application","uniqueKey":"data.integrations.items.[INDEX].application.imageName.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.integrations.items.[INDEX].application.imageName","typeLabel":"string | null"},"termsOfServiceLink":{"oneOf":[{"maxLength":2000,"type":"string","description":"The link to the application's terms of service","uniqueKey":"data.integrations.items.[INDEX].application.termsOfServiceLink.oneOf.0","typeLabel":"string"},{"maxLength":2000,"type":"null","description":"The link to the application's terms of service","uniqueKey":"data.integrations.items.[INDEX].application.termsOfServiceLink.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.integrations.items.[INDEX].application.termsOfServiceLink","typeLabel":"string | null"},"privacyPolicyLink":{"oneOf":[{"maxLength":2000,"type":"string","description":"The link to the application's privacy policy","uniqueKey":"data.integrations.items.[INDEX].application.privacyPolicyLink.oneOf.0","typeLabel":"string"},{"maxLength":2000,"type":"null","description":"The link to the application's privacy policy","uniqueKey":"data.integrations.items.[INDEX].application.privacyPolicyLink.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.integrations.items.[INDEX].application.privacyPolicyLink","typeLabel":"string | null"}},"additionalProperties":false,"description":"An application to use for OAuth2","isRequired":true,"uniqueKey":"data.integrations.items.[INDEX].application","typeLabel":"object"}},"additionalProperties":false,"description":"Represents an OAuth integration for a specific OAuth2 application.\nThis class is used to expose integration information to the public in a controlled manner.","uniqueKey":"data.integrations.items.[INDEX]","typeLabel":"object"},"description":"A list of connected OAuth integrations for the user.","isRequired":true,"uniqueKey":"data.integrations","typeLabel":"object[]"},"apiKeys":{"type":"array","items":{"required":["dateCreated","id","ipAddresses","label","scopes","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.apiKeys.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created in the database","format":"date-time","isRequired":true,"uniqueKey":"data.apiKeys.items.[INDEX].dateCreated","typeLabel":"string\u003cdate-time>"},"label":{"maxLength":64,"minLength":1,"type":"string","description":"Represents a descriptive or identifiable name assigned to the API key","isRequired":true,"uniqueKey":"data.apiKeys.items.[INDEX].label","typeLabel":"string"},"ipAddresses":{"type":"array","items":{"type":"string","uniqueKey":"data.apiKeys.items.[INDEX].ipAddresses.items.[INDEX]","typeLabel":"string"},"description":"The list of IP addresses which are allowed to access the API","isRequired":true,"uniqueKey":"data.apiKeys.items.[INDEX].ipAddresses","typeLabel":"string[]"},"scopes":{"type":"array","items":{"type":"string","uniqueKey":"data.apiKeys.items.[INDEX].scopes.items.[INDEX]","typeLabel":"string"},"description":"The list of scopes the API key is allowed to access","isRequired":true,"uniqueKey":"data.apiKeys.items.[INDEX].scopes","typeLabel":"string[]"},"userId":{"maxLength":36,"minLength":1,"type":"string","description":"The identifier of the user associated with the API key","isRequired":true,"uniqueKey":"data.apiKeys.items.[INDEX].userId","typeLabel":"string"}},"additionalProperties":false,"description":"Represents an API key associated with a merchant's account, used for identifying and authenticating requests.","uniqueKey":"data.apiKeys.items.[INDEX]","typeLabel":"object"},"description":"The API keys associated with the user.","isRequired":true,"uniqueKey":"data.apiKeys","typeLabel":"object[]"},"disabledPaymentMethods":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"data.disabledPaymentMethods.additionalProperties","typeLabel":"string"},"description":"A collection of payment methods that are disabled for the user.","isRequired":true,"uniqueKey":"data.disabledPaymentMethods","typeLabel":"object"},"stripeEnabled":{"type":"boolean","description":"Indicates whether Stripe integration is enabled for the user.","isRequired":true,"uniqueKey":"data.stripeEnabled","typeLabel":"boolean"},"nmiEnabled":{"type":"boolean","description":"Indicates whether NMI is enabled for the user.","isRequired":true,"uniqueKey":"data.nmiEnabled","typeLabel":"boolean"},"moneyMotionEnabled":{"type":"boolean","description":"Indicates whether moneymotion is enabled for the user.","isRequired":true,"uniqueKey":"data.moneyMotionEnabled","typeLabel":"boolean"},"pandabaseEnabled":{"type":"boolean","description":"Indicates whether the Pandabase integration is enabled for the user.","isRequired":true,"uniqueKey":"data.pandabaseEnabled","typeLabel":"boolean"},"shopifyEnabled":{"type":"boolean","description":"Indicates whether the Shopify integration is enabled for the user.","isRequired":true,"uniqueKey":"data.shopifyEnabled","typeLabel":"boolean"},"storrikEnabled":{"type":"boolean","description":"Indicates whether Storrik integration is enabled for the user.","isRequired":true,"uniqueKey":"data.storrikEnabled","typeLabel":"boolean"},"mollieEnabled":{"type":"boolean","description":"Indicates whether Mollie integration is enabled for the user.","isRequired":true,"uniqueKey":"data.mollieEnabled","typeLabel":"boolean"},"northbridgeEnabled":{"type":"boolean","description":"Indicates whether Northbridge integration is enabled for the user.","isRequired":true,"uniqueKey":"data.northbridgeEnabled","typeLabel":"boolean"},"squareEnabled":{"type":"boolean","description":"Indicates whether Square integration is enabled for the user.","isRequired":true,"uniqueKey":"data.squareEnabled","typeLabel":"boolean"},"paypalBusinessEnabled":{"type":"boolean","description":"Indicates whether PayPal Business integration is enabled for the user.","isRequired":true,"uniqueKey":"data.paypalBusinessEnabled","typeLabel":"boolean"},"isCryptoEnabled":{"type":"boolean","description":"Indicates whether cryptocurrency integration is enabled for the user.","isRequired":true,"uniqueKey":"data.isCryptoEnabled","typeLabel":"boolean"},"isSumUpEnabled":{"type":"boolean","description":"Indicates whether the SumUp integration is enabled for the user.","isRequired":true,"uniqueKey":"data.isSumUpEnabled","typeLabel":"boolean"},"paddleEnabled":{"type":"boolean","description":"Indicates whether Paddle integration is enabled for the user.","isRequired":true,"uniqueKey":"data.paddleEnabled","typeLabel":"boolean"},"fastSpringEnabled":{"type":"boolean","description":"Indicates whether FastSpring integration is enabled for the user.","isRequired":true,"uniqueKey":"data.fastSpringEnabled","typeLabel":"boolean"},"venPayrEnabled":{"type":"boolean","description":"Whether the user has access to the VenPayr gateway.","isRequired":true,"uniqueKey":"data.venPayrEnabled","typeLabel":"boolean"},"ovgcEnabled":{"type":"boolean","description":"Indicates whether OVGC Payments integration is enabled for the user.","isRequired":true,"uniqueKey":"data.ovgcEnabled","typeLabel":"boolean"},"isAuthorizeNetEnabled":{"type":"boolean","description":"Indicates whether Authorize.Net payment integration is enabled for the user.","isRequired":true,"uniqueKey":"data.isAuthorizeNetEnabled","typeLabel":"boolean"},"restrictedPaymentMethods":{"type":"array","items":{"type":"string","uniqueKey":"data.restrictedPaymentMethods.items.[INDEX]","typeLabel":"string"},"description":"The list of payment methods which are restricted for the user.","isRequired":true,"uniqueKey":"data.restrictedPaymentMethods","typeLabel":"string[]"},"riskLockedPaymentMethods":{"type":"array","items":{"type":"string","uniqueKey":"data.riskLockedPaymentMethods.items.[INDEX]","typeLabel":"string"},"description":"The list of payment methods which are risk locked for the user.","isRequired":true,"uniqueKey":"data.riskLockedPaymentMethods","typeLabel":"string[]"},"integrationErrorReports":{"type":"array","items":{"required":["dateCreated","gateway","id","reason","reporter","resolved","type","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.integrationErrorReports.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created in the database","format":"date-time","isRequired":true,"uniqueKey":"data.integrationErrorReports.items.[INDEX].dateCreated","typeLabel":"string\u003cdate-time>"},"reason":{"maxLength":1024,"minLength":3,"type":"string","description":"The reason for the report","isRequired":true,"uniqueKey":"data.integrationErrorReports.items.[INDEX].reason","typeLabel":"string"},"gateway":{"maxLength":64,"minLength":1,"type":"string","description":"The ID of the payment gateway that has the error","isRequired":true,"uniqueKey":"data.integrationErrorReports.items.[INDEX].gateway","typeLabel":"string"},"reporter":{"maxLength":128,"minLength":1,"type":"string","description":"The hostname of the server which reported the issue","isRequired":true,"uniqueKey":"data.integrationErrorReports.items.[INDEX].reporter","typeLabel":"string"},"resolved":{"type":"boolean","description":"Whether the report has been acknowledged and resolved - therefore should not be shown","isRequired":true,"uniqueKey":"data.integrationErrorReports.items.[INDEX].resolved","typeLabel":"boolean"},"type":{"maxLength":256,"minLength":3,"type":"string","description":"The ID/type of report that specifically identifies the detected issue","isRequired":true,"uniqueKey":"data.integrationErrorReports.items.[INDEX].type","typeLabel":"string"},"userId":{"maxLength":36,"type":"string","description":"The user who the report is for (automatically done by EF core)","isRequired":true,"uniqueKey":"data.integrationErrorReports.items.[INDEX].userId","typeLabel":"string"}},"additionalProperties":false,"description":"Represents a report by an integration that defines that a misconfiguration was detected that may cause issues","uniqueKey":"data.integrationErrorReports.items.[INDEX]","typeLabel":"object"},"description":"A collection of error reports related to integrations.","isRequired":true,"uniqueKey":"data.integrationErrorReports","typeLabel":"object[]"},"lastPasswordUpdate":{"type":"string","description":"The timestamp of the user's last password update.","format":"date-time","isRequired":true,"uniqueKey":"data.lastPasswordUpdate","typeLabel":"string\u003cdate-time>"},"signals":{"required":["countryCode","dateCreated","id","registrationFingerprint","registrationIpAddress","userId","verificationStatus"],"type":"object","properties":{"countryCode":{"maxLength":2,"minLength":1,"pattern":"^[A-Z]{2}$","type":"string","description":"The ISO 3166-1 alpha-2 country code associated with the address.\nExamples: \"US\" for the United States, \"CA\" for Canada.","isRequired":true,"uniqueKey":"data.signals.countryCode","typeLabel":"string"},"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.signals.id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created in the database","format":"date-time","isRequired":true,"uniqueKey":"data.signals.dateCreated","typeLabel":"string\u003cdate-time>"},"userId":{"maxLength":36,"minLength":1,"type":"string","description":"The ID of the user the KYC info belongs to","isRequired":true,"uniqueKey":"data.signals.userId","typeLabel":"string"},"registrationIpAddress":{"maxLength":45,"type":"string","description":"Gets or sets the IP address that was used to create the merchant","isRequired":true,"uniqueKey":"data.signals.registrationIpAddress","typeLabel":"string"},"registrationFingerprint":{"maxLength":256,"type":"string","description":"The browser/device-specific fingerprint captured during user registration for identity verification.","isRequired":true,"uniqueKey":"data.signals.registrationFingerprint","typeLabel":"string"},"verificationStatus":{"maxLength":30,"minLength":1,"type":"string","description":"The current verification status of the merchant's KYC process.","isRequired":true,"uniqueKey":"data.signals.verificationStatus","typeLabel":"string"},"legalEntityType":{"oneOf":[{"maxLength":1000,"minLength":1,"type":"string","description":"The legal entity type of the merchant.","uniqueKey":"data.signals.legalEntityType.oneOf.0","typeLabel":"string"},{"maxLength":1000,"minLength":1,"type":"null","description":"The legal entity type of the merchant.","uniqueKey":"data.signals.legalEntityType.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.signals.legalEntityType","typeLabel":"string | null"},"taxId":{"oneOf":[{"maxLength":50,"type":"string","description":"Tax Identification Number or VAT number.","uniqueKey":"data.signals.taxId.oneOf.0","typeLabel":"string"},{"maxLength":50,"type":"null","description":"Tax Identification Number or VAT number.","uniqueKey":"data.signals.taxId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.signals.taxId","typeLabel":"string | null"},"fullName":{"oneOf":[{"maxLength":100,"type":"string","description":"The full name of the individual or entity associated with merchant account.","uniqueKey":"data.signals.fullName.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","description":"The full name of the individual or entity associated with merchant account.","uniqueKey":"data.signals.fullName.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.signals.fullName","typeLabel":"string | null"},"addressLine1":{"oneOf":[{"maxLength":200,"type":"string","description":"The primary address line.\nTypically, includes house number, street name, or building name.","uniqueKey":"data.signals.addressLine1.oneOf.0","typeLabel":"string"},{"maxLength":200,"type":"null","description":"The primary address line.\nTypically, includes house number, street name, or building name.","uniqueKey":"data.signals.addressLine1.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.signals.addressLine1","typeLabel":"string | null"},"addressLine2":{"oneOf":[{"maxLength":200,"type":"string","description":"The secondary address line, if applicable.\nMay include apartment, suite, unit, or floor details.\nOptional field.","uniqueKey":"data.signals.addressLine2.oneOf.0","typeLabel":"string"},{"maxLength":200,"type":"null","description":"The secondary address line, if applicable.\nMay include apartment, suite, unit, or floor details.\nOptional field.","uniqueKey":"data.signals.addressLine2.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.signals.addressLine2","typeLabel":"string | null"},"city":{"oneOf":[{"maxLength":100,"type":"string","description":"The city or locality associated with the address.","uniqueKey":"data.signals.city.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","description":"The city or locality associated with the address.","uniqueKey":"data.signals.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.signals.city","typeLabel":"string | null"},"region":{"oneOf":[{"maxLength":100,"type":"string","description":"The region associated with the address.\nRepresents state, province, or other administrative division.","uniqueKey":"data.signals.region.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","description":"The region associated with the address.\nRepresents state, province, or other administrative division.","uniqueKey":"data.signals.region.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.signals.region","typeLabel":"string | null"},"postalCode":{"oneOf":[{"maxLength":20,"type":"string","description":"The postal or ZIP code for the address.","uniqueKey":"data.signals.postalCode.oneOf.0","typeLabel":"string"},{"maxLength":20,"type":"null","description":"The postal or ZIP code for the address.","uniqueKey":"data.signals.postalCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.signals.postalCode","typeLabel":"string | null"}},"additionalProperties":false,"description":"Represents the risk signal information on a merchant","uniqueKey":"data.signals","typeLabel":"object"},"discordWebhookUrl":{"oneOf":[{"type":"string","description":"The URL for a Discord webhook associated with the user.","uniqueKey":"data.discordWebhookUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"The URL for a Discord webhook associated with the user.","uniqueKey":"data.discordWebhookUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.discordWebhookUrl","typeLabel":"string | null"},"subscription":{"required":["autoRenew","billingInterval","customerIds","dateCreated","emailMarketingSent","expiryDate","failedPaymentCount","id","isExpired","lastSyncedAt","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.subscription.id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created in the database","format":"date-time","isRequired":true,"uniqueKey":"data.subscription.dateCreated","typeLabel":"string\u003cdate-time>"},"expiryDate":{"type":"string","description":"Gets or sets the expiry date of the subscription plan.\nDefaults to DateOnly.MaxValue if the plan does not have an expiration date.","format":"date","isRequired":true,"uniqueKey":"data.subscription.expiryDate","typeLabel":"string\u003cdate>"},"autoRenew":{"type":"boolean","description":"Gets or sets a value indicating whether the subscription will automatically renew.\nDefault is true unless explicitly disabled by the user or system configuration.","isRequired":true,"uniqueKey":"data.subscription.autoRenew","typeLabel":"boolean"},"userId":{"maxLength":36,"minLength":3,"type":"string","description":"Gets or sets the unique identifier for the user associated with the subscription options.\nRequired and must be a string between 3 and 36 characters.","isRequired":true,"uniqueKey":"data.subscription.userId","typeLabel":"string"},"billingInterval":{"maxLength":20,"type":"string","description":"The billing interval for the subscription (e.g., Monthly, Yearly).","isRequired":true,"uniqueKey":"data.subscription.billingInterval","typeLabel":"string"},"failedPaymentCount":{"type":"integer","description":"The number of consecutive failed payment attempts.","format":"int32","isRequired":true,"uniqueKey":"data.subscription.failedPaymentCount","typeLabel":"integer\u003cint32>"},"lastSyncedAt":{"type":"string","description":"Gets or sets the timestamp of the last synchronization event.\nDefault is the current UTC time at instantiation.","format":"date-time","isRequired":true,"uniqueKey":"data.subscription.lastSyncedAt","typeLabel":"string\u003cdate-time>"},"customerIds":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"data.subscription.customerIds.additionalProperties","typeLabel":"string"},"description":"The IDs of the customer on respective payment gateways","isRequired":true,"uniqueKey":"data.subscription.customerIds","typeLabel":"object"},"emailMarketingSent":{"type":"integer","description":"Email marketing emails sent in the current monthly quota window, shared across ALL of the\naccount's stores. The Business plan grants a fixed 50,000/month allowance that resets (does\nnot stack) on the billing anniversary; non-Business accounts have a 0 allowance.","format":"int64","isRequired":true,"uniqueKey":"data.subscription.emailMarketingSent","typeLabel":"integer\u003cint64>"},"isExpired":{"type":"boolean","description":"Gets a value indicating whether the subscription is expired.\nA subscription is considered expired if:\n1. The status is \"trial_expired\" or \"suspended\".\n2. The ExpiryDate has passed AND we're not in a retry grace period.\n3. The TrialEndDate has passed (if applicable).\nFree plan merchants are never considered expired (they can always sell unless explicitly suspended).","readOnly":true,"isRequired":true,"uniqueKey":"data.subscription.isExpired","typeLabel":"boolean"},"startedDate":{"oneOf":[{"type":"string","description":"Gets or sets the start date of the user's subscription.\nThis represents when the subscription started or was activated.","format":"date","uniqueKey":"data.subscription.startedDate.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","description":"Gets or sets the start date of the user's subscription.\nThis represents when the subscription started or was activated.","format":"date","uniqueKey":"data.subscription.startedDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.startedDate","typeLabel":"string\u003cdate> | null"},"status":{"oneOf":[{"maxLength":50,"type":"string","description":"Gets or sets the current subscription status for a user.\nExamples include \"active\" or \"canceled\".","uniqueKey":"data.subscription.status.oneOf.0","typeLabel":"string"},{"maxLength":50,"type":"null","description":"Gets or sets the current subscription status for a user.\nExamples include \"active\" or \"canceled\".","uniqueKey":"data.subscription.status.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.status","typeLabel":"string | null"},"trialEndDate":{"oneOf":[{"type":"string","description":"Gets or sets the trial end date for the user's subscription.\nNull if no trial is assigned.","format":"date","uniqueKey":"data.subscription.trialEndDate.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","description":"Gets or sets the trial end date for the user's subscription.\nNull if no trial is assigned.","format":"date","uniqueKey":"data.subscription.trialEndDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.trialEndDate","typeLabel":"string\u003cdate> | null"},"planId":{"oneOf":[{"maxLength":128,"minLength":0,"type":"string","description":"Gets or sets the identifier for the plan associated with the subscription.","uniqueKey":"data.subscription.planId.oneOf.0","typeLabel":"string"},{"maxLength":128,"minLength":0,"type":"null","description":"Gets or sets the identifier for the plan associated with the subscription.","uniqueKey":"data.subscription.planId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.planId","typeLabel":"string | null"},"lastPaymentFailureDate":{"oneOf":[{"type":"string","description":"The date of the last failed payment attempt.","format":"date-time","uniqueKey":"data.subscription.lastPaymentFailureDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The date of the last failed payment attempt.","format":"date-time","uniqueKey":"data.subscription.lastPaymentFailureDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.lastPaymentFailureDate","typeLabel":"string\u003cdate-time> | null"},"nextRetryDate":{"oneOf":[{"type":"string","description":"The next date to retry billing after a failed payment.\nUsed for exponential backoff retry strategy.\nNull when no retry is pending (payment succeeded or account suspended).","format":"date","uniqueKey":"data.subscription.nextRetryDate.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","description":"The next date to retry billing after a failed payment.\nUsed for exponential backoff retry strategy.\nNull when no retry is pending (payment succeeded or account suspended).","format":"date","uniqueKey":"data.subscription.nextRetryDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.nextRetryDate","typeLabel":"string\u003cdate> | null"},"cancelAt":{"oneOf":[{"type":"string","description":"Gets or sets the date and time when the subscription is set to be canceled.\nNull indicates no cancellation is scheduled by default.","format":"date-time","uniqueKey":"data.subscription.cancelAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Gets or sets the date and time when the subscription is set to be canceled.\nNull indicates no cancellation is scheduled by default.","format":"date-time","uniqueKey":"data.subscription.cancelAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.cancelAt","typeLabel":"string\u003cdate-time> | null"},"canceledAt":{"oneOf":[{"type":"string","description":"Gets or sets the date and time when the subscription was canceled.\nThis property is null if the subscription has not been canceled.","format":"date-time","uniqueKey":"data.subscription.canceledAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Gets or sets the date and time when the subscription was canceled.\nThis property is null if the subscription has not been canceled.","format":"date-time","uniqueKey":"data.subscription.canceledAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.canceledAt","typeLabel":"string\u003cdate-time> | null"},"scheduledPlanId":{"oneOf":[{"maxLength":128,"minLength":0,"type":"string","description":"Gets or sets the scheduled plan ID for a pending downgrade.\nWhen set, the plan will change to this at the end of the current billing period.","uniqueKey":"data.subscription.scheduledPlanId.oneOf.0","typeLabel":"string"},{"maxLength":128,"minLength":0,"type":"null","description":"Gets or sets the scheduled plan ID for a pending downgrade.\nWhen set, the plan will change to this at the end of the current billing period.","uniqueKey":"data.subscription.scheduledPlanId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.scheduledPlanId","typeLabel":"string | null"},"scheduledBillingInterval":{"oneOf":[{"maxLength":20,"type":"string","description":"Gets or sets the scheduled billing interval for a pending downgrade.\nUsed together with ScheduledPlanId.","uniqueKey":"data.subscription.scheduledBillingInterval.oneOf.0","typeLabel":"string"},{"maxLength":20,"type":"null","description":"Gets or sets the scheduled billing interval for a pending downgrade.\nUsed together with ScheduledPlanId.","uniqueKey":"data.subscription.scheduledBillingInterval.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.scheduledBillingInterval","typeLabel":"string | null"},"lastExpiryReminderDate":{"oneOf":[{"type":"string","description":"Tracks the ExpiryDate for which the last expiry reminder was sent.\nUsed to prevent duplicate reminder emails when the Hangfire job uses a date range.\nReset implicitly when ExpiryDate advances on renewal.","format":"date","uniqueKey":"data.subscription.lastExpiryReminderDate.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","description":"Tracks the ExpiryDate for which the last expiry reminder was sent.\nUsed to prevent duplicate reminder emails when the Hangfire job uses a date range.\nReset implicitly when ExpiryDate advances on renewal.","format":"date","uniqueKey":"data.subscription.lastExpiryReminderDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.lastExpiryReminderDate","typeLabel":"string\u003cdate> | null"},"emailMarketingQuotaResetAt":{"oneOf":[{"type":"string","description":"When the email marketing monthly quota window resets EmailMarketingSent back to\nzero. Null until the account first uses email marketing as a Business plan.","format":"date-time","uniqueKey":"data.subscription.emailMarketingQuotaResetAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"When the email marketing monthly quota window resets EmailMarketingSent back to\nzero. Null until the account first uses email marketing as a Business plan.","format":"date-time","uniqueKey":"data.subscription.emailMarketingQuotaResetAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.emailMarketingQuotaResetAt","typeLabel":"string\u003cdate-time> | null"}},"additionalProperties":false,"description":"Represents the subscription configuration and details for a user.","uniqueKey":"data.subscription","typeLabel":"object"},"refreshAt":{"oneOf":[{"type":"string","description":"The timestamp indicating when the user information should be refreshed.","format":"date-time","uniqueKey":"data.refreshAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The timestamp indicating when the user information should be refreshed.","format":"date-time","uniqueKey":"data.refreshAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.refreshAt","typeLabel":"string\u003cdate-time> | null"},"billingSuspensionDate":{"oneOf":[{"type":"string","description":"The date when the billing suspension started.","format":"date-time","uniqueKey":"data.billingSuspensionDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The date when the billing suspension started.","format":"date-time","uniqueKey":"data.billingSuspensionDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.billingSuspensionDate","typeLabel":"string\u003cdate-time> | null"},"cashAppOptions":{"required":["id","isAcceptingRequests","isEnabled","isRestricted","isRiskLocked","notesVersion","requireBillingInformation","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.cashAppOptions.id","typeLabel":"string\u003cuuid>"},"isEnabled":{"type":"boolean","description":"Whether the integration is enabled or not","isRequired":true,"uniqueKey":"data.cashAppOptions.isEnabled","typeLabel":"boolean"},"isRestricted":{"type":"boolean","description":"Whether the payment method is restricted from being used by the PSP","isRequired":true,"uniqueKey":"data.cashAppOptions.isRestricted","typeLabel":"boolean"},"isRiskLocked":{"type":"boolean","description":"Whether the payment method is restricted for setup by the user due to risk concerns","isRequired":true,"uniqueKey":"data.cashAppOptions.isRiskLocked","typeLabel":"boolean"},"userId":{"maxLength":36,"type":"string","description":"The user ID the integration options are for","isRequired":true,"uniqueKey":"data.cashAppOptions.userId","typeLabel":"string"},"requireBillingInformation":{"type":"boolean","description":"Whether to prompt and ask the customer for billing information, reduces conversion and increases anti-fraud\neffectiveness","isRequired":true,"uniqueKey":"data.cashAppOptions.requireBillingInformation","typeLabel":"boolean"},"isAcceptingRequests":{"type":"boolean","description":"Whether to accept Cash App requests as a delivery receipt, this can be dangerous as users can\ncharge back easily at this stage","isRequired":true,"uniqueKey":"data.cashAppOptions.isAcceptingRequests","typeLabel":"boolean"},"notesVersion":{"enum":[0,1,2],"type":"integer","description":"Represents versions used in the notes system within the application.","format":"int32","x-enum-varnames":["Version1","Version2","Custom"],"x-enum-descriptions":["The first notes version which uses random joined words by a dash","The second notes version which introduces enhanced features over the first version.","The custom notes version which uses user-defined note lists."],"isRequired":true,"uniqueKey":"data.cashAppOptions.notesVersion","typeLabel":"enum\u003cinteger>"},"restrictionReason":{"oneOf":[{"maxLength":2048,"type":"string","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.cashAppOptions.restrictionReason.oneOf.0","typeLabel":"string"},{"maxLength":2048,"type":"null","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.cashAppOptions.restrictionReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.cashAppOptions.restrictionReason","typeLabel":"string | null"},"email":{"oneOf":[{"maxLength":256,"type":"string","description":"The automatically generated email address to forward Cash App emails to","uniqueKey":"data.cashAppOptions.email.oneOf.0","typeLabel":"string"},{"maxLength":256,"type":"null","description":"The automatically generated email address to forward Cash App emails to","uniqueKey":"data.cashAppOptions.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.cashAppOptions.email","typeLabel":"string | null"},"tag":{"oneOf":[{"maxLength":32,"type":"string","description":"The users Cash Tag to show the user where to send the funds","uniqueKey":"data.cashAppOptions.tag.oneOf.0","typeLabel":"string"},{"maxLength":32,"type":"null","description":"The users Cash Tag to show the user where to send the funds","uniqueKey":"data.cashAppOptions.tag.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.cashAppOptions.tag","typeLabel":"string | null"},"customNoteListId":{"oneOf":[{"type":"string","description":"The optional custom note list to use when NotesVersion is Custom.","format":"uuid","uniqueKey":"data.cashAppOptions.customNoteListId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"The optional custom note list to use when NotesVersion is Custom.","format":"uuid","uniqueKey":"data.cashAppOptions.customNoteListId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.cashAppOptions.customNoteListId","typeLabel":"string\u003cuuid> | null"}},"additionalProperties":false,"description":"Represents configuration and options related to Cash App integration within the application.","uniqueKey":"data.cashAppOptions","typeLabel":"object"},"payPalOptions":{"required":["id","isAcceptingHeldPayments","isAcceptingRequests","isEnabled","isFriendsAndFamilyEnabled","isRestricted","isRiskLocked","isUsingLegacyEmails","notesVersion","requireBillingInformation","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.payPalOptions.id","typeLabel":"string\u003cuuid>"},"isEnabled":{"type":"boolean","description":"Whether the integration is enabled or not","isRequired":true,"uniqueKey":"data.payPalOptions.isEnabled","typeLabel":"boolean"},"isRestricted":{"type":"boolean","description":"Whether the payment method is restricted from being used by the PSP","isRequired":true,"uniqueKey":"data.payPalOptions.isRestricted","typeLabel":"boolean"},"isRiskLocked":{"type":"boolean","description":"Whether the payment method is restricted for setup by the user due to risk concerns","isRequired":true,"uniqueKey":"data.payPalOptions.isRiskLocked","typeLabel":"boolean"},"userId":{"maxLength":36,"type":"string","description":"The user ID the integration options are for","isRequired":true,"uniqueKey":"data.payPalOptions.userId","typeLabel":"string"},"requireBillingInformation":{"type":"boolean","description":"Whether to prompt and ask the customer for billing information, reduces conversion and increases anti-fraud\neffectiveness","isRequired":true,"uniqueKey":"data.payPalOptions.requireBillingInformation","typeLabel":"boolean"},"isUsingLegacyEmails":{"type":"boolean","description":"Whether the Friends and Family integration is using legacy email forwarding not IPN","isRequired":true,"uniqueKey":"data.payPalOptions.isUsingLegacyEmails","typeLabel":"boolean"},"isFriendsAndFamilyEnabled":{"type":"boolean","description":"Whether the PayPal friends and family integration is enabled","isRequired":true,"uniqueKey":"data.payPalOptions.isFriendsAndFamilyEnabled","typeLabel":"boolean"},"isAcceptingRequests":{"type":"boolean","description":"Whether to accept PayPal friends and family requests as a delivery receipt, this can be dangerous as users can\ncharge back easily at this stage","isRequired":true,"uniqueKey":"data.payPalOptions.isAcceptingRequests","typeLabel":"boolean"},"isAcceptingHeldPayments":{"type":"boolean","description":"Whether to accept payments that are on-hold automatically, this is potentially dangerous as the payment can fail at\nthis stage and cause lost funds","isRequired":true,"uniqueKey":"data.payPalOptions.isAcceptingHeldPayments","typeLabel":"boolean"},"notesVersion":{"enum":[0,1,2],"type":"integer","description":"Represents versions used in the notes system within the application.","format":"int32","x-enum-varnames":["Version1","Version2","Custom"],"x-enum-descriptions":["The first notes version which uses random joined words by a dash","The second notes version which introduces enhanced features over the first version.","The custom notes version which uses user-defined note lists."],"isRequired":true,"uniqueKey":"data.payPalOptions.notesVersion","typeLabel":"enum\u003cinteger>"},"restrictionReason":{"oneOf":[{"maxLength":2048,"type":"string","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.payPalOptions.restrictionReason.oneOf.0","typeLabel":"string"},{"maxLength":2048,"type":"null","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.payPalOptions.restrictionReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.payPalOptions.restrictionReason","typeLabel":"string | null"},"email":{"oneOf":[{"maxLength":512,"type":"string","description":"The automatically generated email address to forward PayPal emails to","uniqueKey":"data.payPalOptions.email.oneOf.0","typeLabel":"string"},{"maxLength":512,"type":"null","description":"The automatically generated email address to forward PayPal emails to","uniqueKey":"data.payPalOptions.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.payPalOptions.email","typeLabel":"string | null"},"payPalEmail":{"oneOf":[{"maxLength":512,"type":"string","description":"The actual email address associated with their PayPal account","uniqueKey":"data.payPalOptions.payPalEmail.oneOf.0","typeLabel":"string"},{"maxLength":512,"type":"null","description":"The actual email address associated with their PayPal account","uniqueKey":"data.payPalOptions.payPalEmail.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.payPalOptions.payPalEmail","typeLabel":"string | null"},"customNoteListId":{"oneOf":[{"type":"string","description":"The optional custom note list to use when NotesVersion is Custom.","format":"uuid","uniqueKey":"data.payPalOptions.customNoteListId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"The optional custom note list to use when NotesVersion is Custom.","format":"uuid","uniqueKey":"data.payPalOptions.customNoteListId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.payPalOptions.customNoteListId","typeLabel":"string\u003cuuid> | null"}},"additionalProperties":false,"description":"The options to configure PayPal with","uniqueKey":"data.payPalOptions","typeLabel":"object"},"storrikOptions":{"required":["id","isEnabled","isRestricted","isRiskLocked","requireBillingInformation","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.storrikOptions.id","typeLabel":"string\u003cuuid>"},"isEnabled":{"type":"boolean","description":"Whether the integration is enabled or not","isRequired":true,"uniqueKey":"data.storrikOptions.isEnabled","typeLabel":"boolean"},"isRestricted":{"type":"boolean","description":"Whether the payment method is restricted from being used by the PSP","isRequired":true,"uniqueKey":"data.storrikOptions.isRestricted","typeLabel":"boolean"},"isRiskLocked":{"type":"boolean","description":"Whether the payment method is restricted for setup by the user due to risk concerns","isRequired":true,"uniqueKey":"data.storrikOptions.isRiskLocked","typeLabel":"boolean"},"userId":{"maxLength":36,"type":"string","description":"The user ID the integration options are for","isRequired":true,"uniqueKey":"data.storrikOptions.userId","typeLabel":"string"},"requireBillingInformation":{"type":"boolean","description":"Whether to prompt and ask the customer for billing information, reduces conversion and increases anti-fraud\neffectiveness","isRequired":true,"uniqueKey":"data.storrikOptions.requireBillingInformation","typeLabel":"boolean"},"restrictionReason":{"oneOf":[{"maxLength":2048,"type":"string","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.storrikOptions.restrictionReason.oneOf.0","typeLabel":"string"},{"maxLength":2048,"type":"null","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.storrikOptions.restrictionReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storrikOptions.restrictionReason","typeLabel":"string | null"}},"additionalProperties":false,"description":"Represents configuration options for Storrik integration.","uniqueKey":"data.storrikOptions","typeLabel":"object"},"payPalBusinessOptions":{"required":["forceCardOnly","id","isEnabled","isRestricted","isRiskLocked","isUsingLegacyIntegration","requireBillingInformation","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.payPalBusinessOptions.id","typeLabel":"string\u003cuuid>"},"isEnabled":{"type":"boolean","description":"Whether the integration is enabled or not","isRequired":true,"uniqueKey":"data.payPalBusinessOptions.isEnabled","typeLabel":"boolean"},"isRestricted":{"type":"boolean","description":"Whether the payment method is restricted from being used by the PSP","isRequired":true,"uniqueKey":"data.payPalBusinessOptions.isRestricted","typeLabel":"boolean"},"isRiskLocked":{"type":"boolean","description":"Whether the payment method is restricted for setup by the user due to risk concerns","isRequired":true,"uniqueKey":"data.payPalBusinessOptions.isRiskLocked","typeLabel":"boolean"},"userId":{"maxLength":36,"type":"string","description":"The user ID the integration options are for","isRequired":true,"uniqueKey":"data.payPalBusinessOptions.userId","typeLabel":"string"},"requireBillingInformation":{"type":"boolean","description":"Whether to prompt and ask the customer for billing information, reduces conversion and increases anti-fraud\neffectiveness","isRequired":true,"uniqueKey":"data.payPalBusinessOptions.requireBillingInformation","typeLabel":"boolean"},"isUsingLegacyIntegration":{"type":"boolean","description":"Whether the system is using the legacy PayPal Business integration method, which uses links and \"not smart\" buttons","isRequired":true,"uniqueKey":"data.payPalBusinessOptions.isUsingLegacyIntegration","typeLabel":"boolean"},"forceCardOnly":{"type":"boolean","description":"When true, the checkout UI should only show the credit/debit card option, not PayPal wallet.","isRequired":true,"uniqueKey":"data.payPalBusinessOptions.forceCardOnly","typeLabel":"boolean"},"restrictionReason":{"oneOf":[{"maxLength":2048,"type":"string","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.payPalBusinessOptions.restrictionReason.oneOf.0","typeLabel":"string"},{"maxLength":2048,"type":"null","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.payPalBusinessOptions.restrictionReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.payPalBusinessOptions.restrictionReason","typeLabel":"string | null"},"oAuthClientId":{"oneOf":[{"maxLength":512,"type":"string","description":"The OAuth client identifier used for authentication with PayPal.","uniqueKey":"data.payPalBusinessOptions.oAuthClientId.oneOf.0","typeLabel":"string"},{"maxLength":512,"type":"null","description":"The OAuth client identifier used for authentication with PayPal.","uniqueKey":"data.payPalBusinessOptions.oAuthClientId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.payPalBusinessOptions.oAuthClientId","typeLabel":"string | null"},"emailAddress":{"oneOf":[{"maxLength":256,"type":"string","description":"The email address associated with the PayPal account, used for the old system","uniqueKey":"data.payPalBusinessOptions.emailAddress.oneOf.0","typeLabel":"string"},{"maxLength":256,"type":"null","description":"The email address associated with the PayPal account, used for the old system","uniqueKey":"data.payPalBusinessOptions.emailAddress.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.payPalBusinessOptions.emailAddress","typeLabel":"string | null"}},"additionalProperties":false,"description":"Represents the configuration options specific to a PayPal Business integration.","uniqueKey":"data.payPalBusinessOptions","typeLabel":"object"},"stripeOptions":{"required":["id","isEnabled","isRestricted","isRiskLocked","requireBillingInformation","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.stripeOptions.id","typeLabel":"string\u003cuuid>"},"isEnabled":{"type":"boolean","description":"Whether the integration is enabled or not","isRequired":true,"uniqueKey":"data.stripeOptions.isEnabled","typeLabel":"boolean"},"isRestricted":{"type":"boolean","description":"Whether the payment method is restricted from being used by the PSP","isRequired":true,"uniqueKey":"data.stripeOptions.isRestricted","typeLabel":"boolean"},"isRiskLocked":{"type":"boolean","description":"Whether the payment method is restricted for setup by the user due to risk concerns","isRequired":true,"uniqueKey":"data.stripeOptions.isRiskLocked","typeLabel":"boolean"},"userId":{"maxLength":36,"type":"string","description":"The user ID the integration options are for","isRequired":true,"uniqueKey":"data.stripeOptions.userId","typeLabel":"string"},"requireBillingInformation":{"type":"boolean","description":"Whether to prompt and ask the customer for billing information, reduces conversion and increases anti-fraud\neffectiveness","isRequired":true,"uniqueKey":"data.stripeOptions.requireBillingInformation","typeLabel":"boolean"},"restrictionReason":{"oneOf":[{"maxLength":2048,"type":"string","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.stripeOptions.restrictionReason.oneOf.0","typeLabel":"string"},{"maxLength":2048,"type":"null","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.stripeOptions.restrictionReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stripeOptions.restrictionReason","typeLabel":"string | null"},"paymentMethodConfigurationId":{"oneOf":[{"maxLength":64,"type":"string","description":"The payment method configuration ID to use for the account integration","uniqueKey":"data.stripeOptions.paymentMethodConfigurationId.oneOf.0","typeLabel":"string"},{"maxLength":64,"type":"null","description":"The payment method configuration ID to use for the account integration","uniqueKey":"data.stripeOptions.paymentMethodConfigurationId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stripeOptions.paymentMethodConfigurationId","typeLabel":"string | null"},"publishableKey":{"oneOf":[{"maxLength":512,"minLength":0,"type":"string","description":"The publishable key for the Stripe integration, not encrypted","uniqueKey":"data.stripeOptions.publishableKey.oneOf.0","typeLabel":"string"},{"maxLength":512,"minLength":0,"type":"null","description":"The publishable key for the Stripe integration, not encrypted","uniqueKey":"data.stripeOptions.publishableKey.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stripeOptions.publishableKey","typeLabel":"string | null"}},"additionalProperties":false,"description":"The Stripe options for a merchants Stripe setup","uniqueKey":"data.stripeOptions","typeLabel":"object"},"squareOptions":{"required":["applicationId","id","isEnabled","isRestricted","isRiskLocked","locationId","requireBillingInformation","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.squareOptions.id","typeLabel":"string\u003cuuid>"},"isEnabled":{"type":"boolean","description":"Whether the integration is enabled or not","isRequired":true,"uniqueKey":"data.squareOptions.isEnabled","typeLabel":"boolean"},"isRestricted":{"type":"boolean","description":"Whether the payment method is restricted from being used by the PSP","isRequired":true,"uniqueKey":"data.squareOptions.isRestricted","typeLabel":"boolean"},"isRiskLocked":{"type":"boolean","description":"Whether the payment method is restricted for setup by the user due to risk concerns","isRequired":true,"uniqueKey":"data.squareOptions.isRiskLocked","typeLabel":"boolean"},"userId":{"maxLength":36,"type":"string","description":"The user ID the integration options are for","isRequired":true,"uniqueKey":"data.squareOptions.userId","typeLabel":"string"},"requireBillingInformation":{"type":"boolean","description":"Whether to prompt and ask the customer for billing information, reduces conversion and increases anti-fraud\neffectiveness","isRequired":true,"uniqueKey":"data.squareOptions.requireBillingInformation","typeLabel":"boolean"},"applicationId":{"maxLength":256,"minLength":1,"type":"string","description":"Represents the application ID required for Square payment integration.","isRequired":true,"uniqueKey":"data.squareOptions.applicationId","typeLabel":"string"},"locationId":{"maxLength":256,"minLength":1,"type":"string","description":"Represents the location ID associated with the Square integration.","isRequired":true,"uniqueKey":"data.squareOptions.locationId","typeLabel":"string"},"restrictionReason":{"oneOf":[{"maxLength":2048,"type":"string","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.squareOptions.restrictionReason.oneOf.0","typeLabel":"string"},{"maxLength":2048,"type":"null","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.squareOptions.restrictionReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.squareOptions.restrictionReason","typeLabel":"string | null"}},"additionalProperties":false,"description":"Represents configuration options specific to Square integrations.","uniqueKey":"data.squareOptions","typeLabel":"object"},"mollieOptions":{"required":["id","isEnabled","isRestricted","isRiskLocked","profileId","requireBillingInformation","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.mollieOptions.id","typeLabel":"string\u003cuuid>"},"isEnabled":{"type":"boolean","description":"Whether the integration is enabled or not","isRequired":true,"uniqueKey":"data.mollieOptions.isEnabled","typeLabel":"boolean"},"isRestricted":{"type":"boolean","description":"Whether the payment method is restricted from being used by the PSP","isRequired":true,"uniqueKey":"data.mollieOptions.isRestricted","typeLabel":"boolean"},"isRiskLocked":{"type":"boolean","description":"Whether the payment method is restricted for setup by the user due to risk concerns","isRequired":true,"uniqueKey":"data.mollieOptions.isRiskLocked","typeLabel":"boolean"},"userId":{"maxLength":36,"type":"string","description":"The user ID the integration options are for","isRequired":true,"uniqueKey":"data.mollieOptions.userId","typeLabel":"string"},"requireBillingInformation":{"type":"boolean","description":"Whether to prompt and ask the customer for billing information, reduces conversion and increases anti-fraud\neffectiveness","isRequired":true,"uniqueKey":"data.mollieOptions.requireBillingInformation","typeLabel":"boolean"},"profileId":{"maxLength":50,"minLength":1,"type":"string","description":"The ID of the profile on Mollie, for Mollie.js","isRequired":true,"uniqueKey":"data.mollieOptions.profileId","typeLabel":"string"},"restrictionReason":{"oneOf":[{"maxLength":2048,"type":"string","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.mollieOptions.restrictionReason.oneOf.0","typeLabel":"string"},{"maxLength":2048,"type":"null","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.mollieOptions.restrictionReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.mollieOptions.restrictionReason","typeLabel":"string | null"}},"additionalProperties":false,"description":"Configuration options for Mollie integration.","uniqueKey":"data.mollieOptions","typeLabel":"object"},"northbridgeOptions":{"required":["id","isEnabled","isRestricted","isRiskLocked","requireBillingInformation","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.northbridgeOptions.id","typeLabel":"string\u003cuuid>"},"isEnabled":{"type":"boolean","description":"Whether the integration is enabled or not","isRequired":true,"uniqueKey":"data.northbridgeOptions.isEnabled","typeLabel":"boolean"},"isRestricted":{"type":"boolean","description":"Whether the payment method is restricted from being used by the PSP","isRequired":true,"uniqueKey":"data.northbridgeOptions.isRestricted","typeLabel":"boolean"},"isRiskLocked":{"type":"boolean","description":"Whether the payment method is restricted for setup by the user due to risk concerns","isRequired":true,"uniqueKey":"data.northbridgeOptions.isRiskLocked","typeLabel":"boolean"},"userId":{"maxLength":36,"type":"string","description":"The user ID the integration options are for","isRequired":true,"uniqueKey":"data.northbridgeOptions.userId","typeLabel":"string"},"requireBillingInformation":{"type":"boolean","description":"Whether to prompt and ask the customer for billing information, reduces conversion and increases anti-fraud\neffectiveness","isRequired":true,"uniqueKey":"data.northbridgeOptions.requireBillingInformation","typeLabel":"boolean"},"restrictionReason":{"oneOf":[{"maxLength":2048,"type":"string","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.northbridgeOptions.restrictionReason.oneOf.0","typeLabel":"string"},{"maxLength":2048,"type":"null","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.northbridgeOptions.restrictionReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.northbridgeOptions.restrictionReason","typeLabel":"string | null"}},"additionalProperties":false,"description":"Represents the configuration options for Northbridge payment integration.","uniqueKey":"data.northbridgeOptions","typeLabel":"object"},"nmiOptions":{"required":["gatewayUrl","id","isEnabled","isRestricted","isRiskLocked","kountEnabled","publicKey","rejectAvsAddressMismatch","rejectAvsUnavailable","rejectAvsZipMismatch","rejectCvvMismatch","requireBillingInformation","threeDSecureEnabled","threeDSecureRequired","threeDSecureRequireVerified","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.nmiOptions.id","typeLabel":"string\u003cuuid>"},"isEnabled":{"type":"boolean","description":"Whether the integration is enabled or not","isRequired":true,"uniqueKey":"data.nmiOptions.isEnabled","typeLabel":"boolean"},"isRestricted":{"type":"boolean","description":"Whether the payment method is restricted from being used by the PSP","isRequired":true,"uniqueKey":"data.nmiOptions.isRestricted","typeLabel":"boolean"},"isRiskLocked":{"type":"boolean","description":"Whether the payment method is restricted for setup by the user due to risk concerns","isRequired":true,"uniqueKey":"data.nmiOptions.isRiskLocked","typeLabel":"boolean"},"userId":{"maxLength":36,"type":"string","description":"The user ID the integration options are for","isRequired":true,"uniqueKey":"data.nmiOptions.userId","typeLabel":"string"},"requireBillingInformation":{"type":"boolean","description":"Whether to prompt and ask the customer for billing information, reduces conversion and increases anti-fraud\neffectiveness","isRequired":true,"uniqueKey":"data.nmiOptions.requireBillingInformation","typeLabel":"boolean"},"gatewayUrl":{"maxLength":256,"type":"string","description":"The base URL of the NMI gateway (e.g. https://paymentcloud.transactiongateway.com)","isRequired":true,"uniqueKey":"data.nmiOptions.gatewayUrl","typeLabel":"string"},"publicKey":{"maxLength":256,"type":"string","description":"The public key for Collect.js/Gateway.js tokenization and 3DS/Kount\nThis key is used for both data-tokenization-key (Collect.js) and\nGateway.js initialization (for 3DS and Kount)","isRequired":true,"uniqueKey":"data.nmiOptions.publicKey","typeLabel":"string"},"threeDSecureEnabled":{"type":"boolean","description":"Whether 3D Secure is enabled for transactions","isRequired":true,"uniqueKey":"data.nmiOptions.threeDSecureEnabled","typeLabel":"boolean"},"threeDSecureRequired":{"type":"boolean","description":"Refuse a card sale that arrives without payer authentication, rather than merely offering 3D\nSecure to the browser.","isRequired":true,"uniqueKey":"data.nmiOptions.threeDSecureRequired","typeLabel":"boolean"},"threeDSecureRequireVerified":{"type":"boolean","description":"Whether an `attempted` authentication satisfies ThreeDSecureRequired, or\nonly a `verified` one does.","isRequired":true,"uniqueKey":"data.nmiOptions.threeDSecureRequireVerified","typeLabel":"boolean"},"rejectAvsAddressMismatch":{"type":"boolean","description":"Reject transactions where AVS street address does not match (response codes: N, A, W, Z)","isRequired":true,"uniqueKey":"data.nmiOptions.rejectAvsAddressMismatch","typeLabel":"boolean"},"rejectAvsZipMismatch":{"type":"boolean","description":"Reject transactions where AVS zip code does not match (response codes: N, A)","isRequired":true,"uniqueKey":"data.nmiOptions.rejectAvsZipMismatch","typeLabel":"boolean"},"rejectCvvMismatch":{"type":"boolean","description":"Reject transactions where CVV does not match (response codes: N)","isRequired":true,"uniqueKey":"data.nmiOptions.rejectCvvMismatch","typeLabel":"boolean"},"rejectAvsUnavailable":{"type":"boolean","description":"Reject transactions where AVS/CVV is not available or not processed (response codes: U, S, P)","isRequired":true,"uniqueKey":"data.nmiOptions.rejectAvsUnavailable","typeLabel":"boolean"},"kountEnabled":{"type":"boolean","description":"Whether Kount fraud screening is enabled","isRequired":true,"uniqueKey":"data.nmiOptions.kountEnabled","typeLabel":"boolean"},"restrictionReason":{"oneOf":[{"maxLength":2048,"type":"string","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.nmiOptions.restrictionReason.oneOf.0","typeLabel":"string"},{"maxLength":2048,"type":"null","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.nmiOptions.restrictionReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.nmiOptions.restrictionReason","typeLabel":"string | null"},"kountMerchantId":{"oneOf":[{"maxLength":64,"type":"string","description":"The Kount Merchant ID (if using Kount fraud screening)","uniqueKey":"data.nmiOptions.kountMerchantId.oneOf.0","typeLabel":"string"},{"maxLength":64,"type":"null","description":"The Kount Merchant ID (if using Kount fraud screening)","uniqueKey":"data.nmiOptions.kountMerchantId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.nmiOptions.kountMerchantId","typeLabel":"string | null"}},"additionalProperties":false,"description":"NMI (Payment Cloud) integration options for a user","uniqueKey":"data.nmiOptions","typeLabel":"object"},"paddleOptions":{"required":["id","isEnabled","isRestricted","isRiskLocked","requireBillingInformation","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.paddleOptions.id","typeLabel":"string\u003cuuid>"},"isEnabled":{"type":"boolean","description":"Whether the integration is enabled or not","isRequired":true,"uniqueKey":"data.paddleOptions.isEnabled","typeLabel":"boolean"},"isRestricted":{"type":"boolean","description":"Whether the payment method is restricted from being used by the PSP","isRequired":true,"uniqueKey":"data.paddleOptions.isRestricted","typeLabel":"boolean"},"isRiskLocked":{"type":"boolean","description":"Whether the payment method is restricted for setup by the user due to risk concerns","isRequired":true,"uniqueKey":"data.paddleOptions.isRiskLocked","typeLabel":"boolean"},"userId":{"maxLength":36,"type":"string","description":"The user ID the integration options are for","isRequired":true,"uniqueKey":"data.paddleOptions.userId","typeLabel":"string"},"requireBillingInformation":{"type":"boolean","description":"Whether to prompt and ask the customer for billing information, reduces conversion and increases anti-fraud\neffectiveness","isRequired":true,"uniqueKey":"data.paddleOptions.requireBillingInformation","typeLabel":"boolean"},"restrictionReason":{"oneOf":[{"maxLength":2048,"type":"string","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.paddleOptions.restrictionReason.oneOf.0","typeLabel":"string"},{"maxLength":2048,"type":"null","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.paddleOptions.restrictionReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.paddleOptions.restrictionReason","typeLabel":"string | null"}},"additionalProperties":false,"description":"Represents configuration options for the Paddle integration.","uniqueKey":"data.paddleOptions","typeLabel":"object"},"fastSpringOptions":{"required":["id","isEnabled","isRestricted","isRiskLocked","requireBillingInformation","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.fastSpringOptions.id","typeLabel":"string\u003cuuid>"},"isEnabled":{"type":"boolean","description":"Whether the integration is enabled or not","isRequired":true,"uniqueKey":"data.fastSpringOptions.isEnabled","typeLabel":"boolean"},"isRestricted":{"type":"boolean","description":"Whether the payment method is restricted from being used by the PSP","isRequired":true,"uniqueKey":"data.fastSpringOptions.isRestricted","typeLabel":"boolean"},"isRiskLocked":{"type":"boolean","description":"Whether the payment method is restricted for setup by the user due to risk concerns","isRequired":true,"uniqueKey":"data.fastSpringOptions.isRiskLocked","typeLabel":"boolean"},"userId":{"maxLength":36,"type":"string","description":"The user ID the integration options are for","isRequired":true,"uniqueKey":"data.fastSpringOptions.userId","typeLabel":"string"},"requireBillingInformation":{"type":"boolean","description":"Whether to prompt and ask the customer for billing information, reduces conversion and increases anti-fraud\neffectiveness","isRequired":true,"uniqueKey":"data.fastSpringOptions.requireBillingInformation","typeLabel":"boolean"},"restrictionReason":{"oneOf":[{"maxLength":2048,"type":"string","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.fastSpringOptions.restrictionReason.oneOf.0","typeLabel":"string"},{"maxLength":2048,"type":"null","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.fastSpringOptions.restrictionReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.fastSpringOptions.restrictionReason","typeLabel":"string | null"}},"additionalProperties":false,"description":"Represents configuration options for the FastSpring integration.","uniqueKey":"data.fastSpringOptions","typeLabel":"object"},"shopifyOptions":{"required":["id","isEnabled","isRestricted","isRiskLocked","requireBillingInformation","shopUrl","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.shopifyOptions.id","typeLabel":"string\u003cuuid>"},"isEnabled":{"type":"boolean","description":"Whether the integration is enabled or not","isRequired":true,"uniqueKey":"data.shopifyOptions.isEnabled","typeLabel":"boolean"},"isRestricted":{"type":"boolean","description":"Whether the payment method is restricted from being used by the PSP","isRequired":true,"uniqueKey":"data.shopifyOptions.isRestricted","typeLabel":"boolean"},"isRiskLocked":{"type":"boolean","description":"Whether the payment method is restricted for setup by the user due to risk concerns","isRequired":true,"uniqueKey":"data.shopifyOptions.isRiskLocked","typeLabel":"boolean"},"userId":{"maxLength":36,"type":"string","description":"The user ID the integration options are for","isRequired":true,"uniqueKey":"data.shopifyOptions.userId","typeLabel":"string"},"requireBillingInformation":{"type":"boolean","description":"Whether to prompt and ask the customer for billing information, reduces conversion and increases anti-fraud\neffectiveness","isRequired":true,"uniqueKey":"data.shopifyOptions.requireBillingInformation","typeLabel":"boolean"},"shopUrl":{"maxLength":256,"minLength":1,"type":"string","description":"The shop's `*.myshopify.com` domain.","isRequired":true,"uniqueKey":"data.shopifyOptions.shopUrl","typeLabel":"string"},"restrictionReason":{"oneOf":[{"maxLength":2048,"type":"string","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.shopifyOptions.restrictionReason.oneOf.0","typeLabel":"string"},{"maxLength":2048,"type":"null","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.shopifyOptions.restrictionReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.shopifyOptions.restrictionReason","typeLabel":"string | null"}},"additionalProperties":false,"description":"A store's Shopify connection.","uniqueKey":"data.shopifyOptions","typeLabel":"object"},"cryptocurrencyOptions":{"required":["disabledCryptocurrencies","id","isEnabled","isRestricted","isRiskLocked","requireBillingInformation","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.cryptocurrencyOptions.id","typeLabel":"string\u003cuuid>"},"isEnabled":{"type":"boolean","description":"Whether the integration is enabled or not","isRequired":true,"uniqueKey":"data.cryptocurrencyOptions.isEnabled","typeLabel":"boolean"},"isRestricted":{"type":"boolean","description":"Whether the payment method is restricted from being used by the PSP","isRequired":true,"uniqueKey":"data.cryptocurrencyOptions.isRestricted","typeLabel":"boolean"},"isRiskLocked":{"type":"boolean","description":"Whether the payment method is restricted for setup by the user due to risk concerns","isRequired":true,"uniqueKey":"data.cryptocurrencyOptions.isRiskLocked","typeLabel":"boolean"},"userId":{"maxLength":36,"type":"string","description":"The user ID the integration options are for","isRequired":true,"uniqueKey":"data.cryptocurrencyOptions.userId","typeLabel":"string"},"requireBillingInformation":{"type":"boolean","description":"Whether to prompt and ask the customer for billing information, reduces conversion and increases anti-fraud\neffectiveness","isRequired":true,"uniqueKey":"data.cryptocurrencyOptions.requireBillingInformation","typeLabel":"boolean"},"disabledCryptocurrencies":{"type":"array","items":{"type":"string","uniqueKey":"data.cryptocurrencyOptions.disabledCryptocurrencies.items.[INDEX]","typeLabel":"string"},"description":"Coins the merchant has explicitly DISABLED. Under the non-custodial model every coin a configured\nprocessor (Conduit wallet / NOWPayments-BYO) can serve is accepted by default; this opt-out set is\nthe merchant's only per-coin selection. Checkout offers `serveable − DisabledCryptocurrencies`.","isRequired":true,"uniqueKey":"data.cryptocurrencyOptions.disabledCryptocurrencies","typeLabel":"string[]"},"restrictionReason":{"oneOf":[{"maxLength":2048,"type":"string","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.cryptocurrencyOptions.restrictionReason.oneOf.0","typeLabel":"string"},{"maxLength":2048,"type":"null","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.cryptocurrencyOptions.restrictionReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.cryptocurrencyOptions.restrictionReason","typeLabel":"string | null"}},"additionalProperties":false,"description":"The cryptocurrency options for a merchant","uniqueKey":"data.cryptocurrencyOptions","typeLabel":"object"}},"additionalProperties":false,"description":"Represents a user with detailed merchant-related information.","uniqueKey":"data","typeLabel":"object"}},"additionalProperties":false,"description":"Represents a default generic response for API endpoints.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"message":"\u003cstring>","code":"\u003cstring>","data":{"id":"\u003cstring>","dateCreated":"2023-11-07T05:31:56Z","stores":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","name":"\u003cstring>","description":"\u003cstring>","url":"\n store\n ","currencyCode":"\u003cstring>","prependProductNameToReceipt":true,"isAutomaticReviewsEnabled":true,"rating":123,"domain":"\u003cstring>","isCustomerBalanceEnabled":true,"isBalanceTopUpEnabled":true,"isKomerzaPayEnabled":true,"isSplitPaymentEnabled":true,"branding":{"bannerFileName":"\u003cstring>","iconFileName":"\u003cstring>","accentColor":"\u003cstring>"},"isTicketingEnabled":true,"isDownloadCenterEnabled":true,"showPublicStats":true,"showRecentOrderToasts":true,"enableCartRecovery":true,"isInactive":true,"googleSiteVerification":"\u003cstring>","customDomain":"\u003cstring>","scopes":["\u003cstring>"],"maintenanceReason":"\u003cstring>","termsOfServiceUrl":"\u003cstring>","refundPolicyUrl":"\u003cstring>","privacyPolicyUrl":"\u003cstring>","affiliateOptions":{"isEnabled":true,"defaultReturnPercentage":50,"canConvertAffiliateBalance":true,"isPublicRegistrationEnabled":true,"isLinkEditingEnabled":true,"defaultPercentageOff":50},"externalSupportUrl":"\u003cstring>","externalSupportDescription":"\u003cstring>","lastOrderAt":"2023-11-07T05:31:56Z"}],"email":"\u003cstring>","userName":"\u003cstring>","plan":"\u003cstring>","isBuyerProtectionManager":true,"twoFactorEnabled":true,"totpEnabled":true,"passkeyEnabled":true,"riskLocked":true,"billingSuspended":true,"integrations":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","application":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","name":"\u003cstring>","permissions":["\u003cstring>"],"redirectUrls":["\u003cstring>"],"userId":"\u003cstring>","imageName":"\u003cstring>","termsOfServiceLink":"\u003cstring>","privacyPolicyLink":"\u003cstring>"}}],"apiKeys":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","label":"\u003cstring>","ipAddresses":["\u003cstring>"],"scopes":["\u003cstring>"],"userId":"\u003cstring>"}],"disabledPaymentMethods":{},"stripeEnabled":true,"nmiEnabled":true,"moneyMotionEnabled":true,"pandabaseEnabled":true,"shopifyEnabled":true,"storrikEnabled":true,"mollieEnabled":true,"northbridgeEnabled":true,"squareEnabled":true,"paypalBusinessEnabled":true,"isCryptoEnabled":true,"isSumUpEnabled":true,"paddleEnabled":true,"fastSpringEnabled":true,"venPayrEnabled":true,"ovgcEnabled":true,"isAuthorizeNetEnabled":true,"restrictedPaymentMethods":["\u003cstring>"],"riskLockedPaymentMethods":["\u003cstring>"],"integrationErrorReports":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","reason":"\u003cstring>","gateway":"\u003cstring>","reporter":"\u003cstring>","resolved":true,"type":"\u003cstring>","userId":"\u003cstring>"}],"lastPasswordUpdate":"2023-11-07T05:31:56Z","signals":{"countryCode":"\u003cstring>","id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","userId":"\u003cstring>","registrationIpAddress":"\u003cstring>","registrationFingerprint":"\u003cstring>","verificationStatus":"\u003cstring>","legalEntityType":"\u003cstring>","taxId":"\u003cstring>","fullName":"\u003cstring>","addressLine1":"\u003cstring>","addressLine2":"\u003cstring>","city":"\u003cstring>","region":"\u003cstring>","postalCode":"\u003cstring>"},"discordWebhookUrl":"\u003cstring>","subscription":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","expiryDate":"2023-12-25","autoRenew":true,"userId":"\u003cstring>","billingInterval":"\u003cstring>","failedPaymentCount":123,"lastSyncedAt":"2023-11-07T05:31:56Z","customerIds":{},"emailMarketingSent":123,"isExpired":true,"startedDate":"2023-12-25","status":"\u003cstring>","trialEndDate":"2023-12-25","planId":"\u003cstring>","lastPaymentFailureDate":"2023-11-07T05:31:56Z","nextRetryDate":"2023-12-25","cancelAt":"2023-11-07T05:31:56Z","canceledAt":"2023-11-07T05:31:56Z","scheduledPlanId":"\u003cstring>","scheduledBillingInterval":"\u003cstring>","lastExpiryReminderDate":"2023-12-25","emailMarketingQuotaResetAt":"2023-11-07T05:31:56Z"},"refreshAt":"2023-11-07T05:31:56Z","billingSuspensionDate":"2023-11-07T05:31:56Z","cashAppOptions":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","isEnabled":true,"isRestricted":true,"isRiskLocked":true,"userId":"\u003cstring>","requireBillingInformation":true,"isAcceptingRequests":true,"notesVersion":0,"restrictionReason":"\u003cstring>","email":"\u003cstring>","tag":"\u003cstring>","customNoteListId":"3c90c3cc-0d44-4b50-8888-8dd25736052a"},"payPalOptions":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","isEnabled":true,"isRestricted":true,"isRiskLocked":true,"userId":"\u003cstring>","requireBillingInformation":true,"isUsingLegacyEmails":true,"isFriendsAndFamilyEnabled":true,"isAcceptingRequests":true,"isAcceptingHeldPayments":true,"notesVersion":0,"restrictionReason":"\u003cstring>","email":"\u003cstring>","payPalEmail":"\u003cstring>","customNoteListId":"3c90c3cc-0d44-4b50-8888-8dd25736052a"},"storrikOptions":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","isEnabled":true,"isRestricted":true,"isRiskLocked":true,"userId":"\u003cstring>","requireBillingInformation":true,"restrictionReason":"\u003cstring>"},"payPalBusinessOptions":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","isEnabled":true,"isRestricted":true,"isRiskLocked":true,"userId":"\u003cstring>","requireBillingInformation":true,"isUsingLegacyIntegration":true,"forceCardOnly":true,"restrictionReason":"\u003cstring>","oAuthClientId":"\u003cstring>","emailAddress":"\u003cstring>"},"stripeOptions":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","isEnabled":true,"isRestricted":true,"isRiskLocked":true,"userId":"\u003cstring>","requireBillingInformation":true,"restrictionReason":"\u003cstring>","paymentMethodConfigurationId":"\u003cstring>","publishableKey":"\u003cstring>"},"squareOptions":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","isEnabled":true,"isRestricted":true,"isRiskLocked":true,"userId":"\u003cstring>","requireBillingInformation":true,"applicationId":"\u003cstring>","locationId":"\u003cstring>","restrictionReason":"\u003cstring>"},"mollieOptions":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","isEnabled":true,"isRestricted":true,"isRiskLocked":true,"userId":"\u003cstring>","requireBillingInformation":true,"profileId":"\u003cstring>","restrictionReason":"\u003cstring>"},"northbridgeOptions":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","isEnabled":true,"isRestricted":true,"isRiskLocked":true,"userId":"\u003cstring>","requireBillingInformation":true,"restrictionReason":"\u003cstring>"},"nmiOptions":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","isEnabled":true,"isRestricted":true,"isRiskLocked":true,"userId":"\u003cstring>","requireBillingInformation":true,"gatewayUrl":"\u003cstring>","publicKey":"\u003cstring>","threeDSecureEnabled":true,"threeDSecureRequired":true,"threeDSecureRequireVerified":true,"rejectAvsAddressMismatch":true,"rejectAvsZipMismatch":true,"rejectCvvMismatch":true,"rejectAvsUnavailable":true,"kountEnabled":true,"restrictionReason":"\u003cstring>","kountMerchantId":"\u003cstring>"},"paddleOptions":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","isEnabled":true,"isRestricted":true,"isRiskLocked":true,"userId":"\u003cstring>","requireBillingInformation":true,"restrictionReason":"\u003cstring>"},"fastSpringOptions":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","isEnabled":true,"isRestricted":true,"isRiskLocked":true,"userId":"\u003cstring>","requireBillingInformation":true,"restrictionReason":"\u003cstring>"},"shopifyOptions":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","isEnabled":true,"isRestricted":true,"isRiskLocked":true,"userId":"\u003cstring>","requireBillingInformation":true,"shopUrl":"\u003cstring>","restrictionReason":"\u003cstring>"},"cryptocurrencyOptions":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","isEnabled":true,"isRestricted":true,"isRiskLocked":true,"userId":"\u003cstring>","requireBillingInformation":true,"disabledCryptocurrencies":["\u003cstring>"],"restrictionReason":"\u003cstring>"}}}}},"exampleType":"generated"},"application/json":{"schema":{"required":["success"],"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the operation or response was successful.","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"oneOf":[{"type":"string","description":"A descriptive message providing additional context or information about the response.","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"A descriptive message providing additional context or information about the response.","uniqueKey":"message.oneOf.1","typeLabel":"null"}],"uniqueKey":"message","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","description":"The error code (if there was an error) to use when referencing the error","uniqueKey":"code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The error code (if there was an error) to use when referencing the error","uniqueKey":"code.oneOf.1","typeLabel":"null"}],"uniqueKey":"code","typeLabel":"string | null"},"data":{"required":["apiKeys","billingSuspended","dateCreated","disabledPaymentMethods","email","fastSpringEnabled","id","integrationErrorReports","integrations","isAuthorizeNetEnabled","isBuyerProtectionManager","isCryptoEnabled","isSumUpEnabled","lastPasswordUpdate","mollieEnabled","moneyMotionEnabled","nmiEnabled","northbridgeEnabled","ovgcEnabled","paddleEnabled","pandabaseEnabled","passkeyEnabled","paypalBusinessEnabled","plan","restrictedPaymentMethods","riskLocked","riskLockedPaymentMethods","shopifyEnabled","squareEnabled","stores","storrikEnabled","stripeEnabled","totpEnabled","twoFactorEnabled","userName","venPayrEnabled"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the user.","isRequired":true,"uniqueKey":"data.id","typeLabel":"string"},"dateCreated":{"type":"string","description":"The date the entity was created","format":"date-time","isRequired":true,"uniqueKey":"data.dateCreated","typeLabel":"string\u003cdate-time>"},"stores":{"type":"array","items":{"required":["branding","currencyCode","dateCreated","description","domain","enableCartRecovery","id","isAutomaticReviewsEnabled","isBalanceTopUpEnabled","isCustomerBalanceEnabled","isDownloadCenterEnabled","isInactive","isKomerzaPayEnabled","isSplitPaymentEnabled","isTicketingEnabled","name","prependProductNameToReceipt","rating","showPublicStats","showRecentOrderToasts","url"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created","format":"date-time","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].dateCreated","typeLabel":"string\u003cdate-time>"},"name":{"type":"string","description":"The name of the store","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].name","typeLabel":"string"},"description":{"type":"string","description":"The description of the store, shown on their about page and on the home of their store page","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].description","typeLabel":"string"},"url":{"type":"string","description":"The subdomain for the store, ONLY the subdomain, not the fully qualified domain","example":"\n store\n ","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].url","typeLabel":"string"},"currencyCode":{"type":"string","description":"The stores preferred currency","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].currencyCode","typeLabel":"string"},"prependProductNameToReceipt":{"type":"boolean","description":"Whether the name of the product should be prepended to the start of delivery receipts to customers","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].prependProductNameToReceipt","typeLabel":"boolean"},"isAutomaticReviewsEnabled":{"type":"boolean","description":"Whether automatic review leaving is enabled","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].isAutomaticReviewsEnabled","typeLabel":"boolean"},"rating":{"type":"number","description":"The combined average rating for all their products","format":"double","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].rating","typeLabel":"number\u003cdouble>"},"domain":{"type":"string","description":"The domain the store is associated with","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].domain","typeLabel":"string"},"isCustomerBalanceEnabled":{"type":"boolean","description":"Whether the customer balance system is enabled on the stores","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].isCustomerBalanceEnabled","typeLabel":"boolean"},"isBalanceTopUpEnabled":{"type":"boolean","description":"Whether customers can top up their store balance using any enabled payment method.","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].isBalanceTopUpEnabled","typeLabel":"boolean"},"isKomerzaPayEnabled":{"type":"boolean","description":"Whether this store accepts Komerza Pay.\n\nPer store rather than per user, unlike every other gateway: one verified legal entity may\n own several stores and switch them on individually, because enabling it makes Komerza the\n merchant of record for that store's orders.","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].isKomerzaPayEnabled","typeLabel":"boolean"},"isSplitPaymentEnabled":{"type":"boolean","description":"Whether customers can pay for an order partly with their store balance and the remainder\nwith another payment method.","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].isSplitPaymentEnabled","typeLabel":"boolean"},"branding":{"type":"object","properties":{"bannerFileName":{"oneOf":[{"maxLength":64,"type":"string","description":"Represents the file name of the banner associated with the checkout options.","uniqueKey":"data.stores.items.[INDEX].branding.bannerFileName.oneOf.0","typeLabel":"string"},{"maxLength":64,"type":"null","description":"Represents the file name of the banner associated with the checkout options.","uniqueKey":"data.stores.items.[INDEX].branding.bannerFileName.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stores.items.[INDEX].branding.bannerFileName","typeLabel":"string | null"},"iconFileName":{"oneOf":[{"maxLength":64,"type":"string","description":"The icon file name, used for favicon","uniqueKey":"data.stores.items.[INDEX].branding.iconFileName.oneOf.0","typeLabel":"string"},{"maxLength":64,"type":"null","description":"The icon file name, used for favicon","uniqueKey":"data.stores.items.[INDEX].branding.iconFileName.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stores.items.[INDEX].branding.iconFileName","typeLabel":"string | null"},"accentColor":{"oneOf":[{"maxLength":9,"type":"string","description":"Represents the accent color used in the checkout options.","uniqueKey":"data.stores.items.[INDEX].branding.accentColor.oneOf.0","typeLabel":"string"},{"maxLength":9,"type":"null","description":"Represents the accent color used in the checkout options.","uniqueKey":"data.stores.items.[INDEX].branding.accentColor.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stores.items.[INDEX].branding.accentColor","typeLabel":"string | null"}},"additionalProperties":false,"description":"Represents the configurable branding options for a store.","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].branding","typeLabel":"object"},"isTicketingEnabled":{"type":"boolean","description":"Whether the built-in support ticket system is enabled for customers","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].isTicketingEnabled","typeLabel":"boolean"},"isDownloadCenterEnabled":{"type":"boolean","description":"Whether the store offers a download centre to its customers.","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].isDownloadCenterEnabled","typeLabel":"boolean"},"showPublicStats":{"type":"boolean","description":"Whether anonymized public statistics are shown to buyers on the storefront.","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].showPublicStats","typeLabel":"boolean"},"showRecentOrderToasts":{"type":"boolean","description":"Whether recent order toast notifications are shown to visitors on the storefront.","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].showRecentOrderToasts","typeLabel":"boolean"},"enableCartRecovery":{"type":"boolean","description":"Whether abandoned cart recovery emails are enabled for this store.","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].enableCartRecovery","typeLabel":"boolean"},"isInactive":{"type":"boolean","description":"Whether the store is inactive","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].isInactive","typeLabel":"boolean"},"googleSiteVerification":{"oneOf":[{"type":"string","description":"Google Search Console site-verification token, or null. Rendered by the router as a\n\u003cmeta name=\"google-site-verification\"> tag. Public by design — it appears on\nevery rendered page — so exposing it here is not a disclosure.","uniqueKey":"data.stores.items.[INDEX].googleSiteVerification.oneOf.0","typeLabel":"string"},{"type":"null","description":"Google Search Console site-verification token, or null. Rendered by the router as a\n\u003cmeta name=\"google-site-verification\"> tag. Public by design — it appears on\nevery rendered page — so exposing it here is not a disclosure.","uniqueKey":"data.stores.items.[INDEX].googleSiteVerification.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stores.items.[INDEX].googleSiteVerification","typeLabel":"string | null"},"customDomain":{"oneOf":[{"type":"string","description":"The custom domain set for the store, will be null if not set","uniqueKey":"data.stores.items.[INDEX].customDomain.oneOf.0","typeLabel":"string"},{"type":"null","description":"The custom domain set for the store, will be null if not set","uniqueKey":"data.stores.items.[INDEX].customDomain.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stores.items.[INDEX].customDomain","typeLabel":"string | null"},"scopes":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"data.stores.items.[INDEX].scopes.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"The permission scopes that the current user can use for the store, only returned on the /user endpoint for stores\nvisible due to team permissions, will also be null on /user if the store is owned by the user and therefore has\nevery (permissions)","uniqueKey":"data.stores.items.[INDEX].scopes.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"The permission scopes that the current user can use for the store, only returned on the /user endpoint for stores\nvisible due to team permissions, will also be null on /user if the store is owned by the user and therefore has\nevery (permissions)","uniqueKey":"data.stores.items.[INDEX].scopes.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stores.items.[INDEX].scopes","typeLabel":"string[] | null"},"maintenanceReason":{"oneOf":[{"type":"string","description":"The reason the store is in maintenance, if this is null then the store is not in maintenance mode","uniqueKey":"data.stores.items.[INDEX].maintenanceReason.oneOf.0","typeLabel":"string"},{"type":"null","description":"The reason the store is in maintenance, if this is null then the store is not in maintenance mode","uniqueKey":"data.stores.items.[INDEX].maintenanceReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stores.items.[INDEX].maintenanceReason","typeLabel":"string | null"},"termsOfServiceUrl":{"oneOf":[{"type":"string","description":"The URL to the store's terms of service page","uniqueKey":"data.stores.items.[INDEX].termsOfServiceUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"The URL to the store's terms of service page","uniqueKey":"data.stores.items.[INDEX].termsOfServiceUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stores.items.[INDEX].termsOfServiceUrl","typeLabel":"string | null"},"refundPolicyUrl":{"oneOf":[{"type":"string","description":"The URL to the store's refund policy page","uniqueKey":"data.stores.items.[INDEX].refundPolicyUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"The URL to the store's refund policy page","uniqueKey":"data.stores.items.[INDEX].refundPolicyUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stores.items.[INDEX].refundPolicyUrl","typeLabel":"string | null"},"privacyPolicyUrl":{"oneOf":[{"type":"string","description":"The URL to the store's privacy policy page","uniqueKey":"data.stores.items.[INDEX].privacyPolicyUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"The URL to the store's privacy policy page","uniqueKey":"data.stores.items.[INDEX].privacyPolicyUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stores.items.[INDEX].privacyPolicyUrl","typeLabel":"string | null"},"affiliateOptions":{"required":["canConvertAffiliateBalance","defaultReturnPercentage","isEnabled","isLinkEditingEnabled","isPublicRegistrationEnabled"],"type":"object","properties":{"isEnabled":{"type":"boolean","description":"Determines if the affiliate settings are active for the store.","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].affiliateOptions.isEnabled","typeLabel":"boolean"},"defaultReturnPercentage":{"maximum":100,"minimum":0,"type":"integer","description":"Specifies the default return percentage for affiliates within a store, ranging from 0 to 100.","format":"int32","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].affiliateOptions.defaultReturnPercentage","typeLabel":"integer\u003cint32>"},"canConvertAffiliateBalance":{"type":"boolean","description":"Whether the store allows affiliate balance to be converted into customer balance to be used on the store, when\nenabled any affiliate can convert their affiliate balance into customer balance automatically","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].affiliateOptions.canConvertAffiliateBalance","typeLabel":"boolean"},"isPublicRegistrationEnabled":{"type":"boolean","description":"Determines whether public registration is enabled for affiliates within the store.","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].affiliateOptions.isPublicRegistrationEnabled","typeLabel":"boolean"},"isLinkEditingEnabled":{"type":"boolean","description":"Indicates whether link editing capabilities are enabled within the affiliate options for a store.","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].affiliateOptions.isLinkEditingEnabled","typeLabel":"boolean"},"defaultPercentageOff":{"oneOf":[{"maximum":100,"minimum":0,"type":"integer","description":"Represents the default percentage off value used in affiliate settings, where the value must be between 0 and 100.","format":"int32","uniqueKey":"data.stores.items.[INDEX].affiliateOptions.defaultPercentageOff.oneOf.0","typeLabel":"integer\u003cint32>"},{"maximum":100,"minimum":0,"type":"null","description":"Represents the default percentage off value used in affiliate settings, where the value must be between 0 and 100.","format":"int32","uniqueKey":"data.stores.items.[INDEX].affiliateOptions.defaultPercentageOff.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stores.items.[INDEX].affiliateOptions.defaultPercentageOff","typeLabel":"integer\u003cint32> | null"}},"additionalProperties":false,"description":"Represents the configuration options for affiliate settings in a store.","uniqueKey":"data.stores.items.[INDEX].affiliateOptions","typeLabel":"object"},"externalSupportUrl":{"oneOf":[{"type":"string","description":"The URL to direct customers to for external support when ticketing is disabled","uniqueKey":"data.stores.items.[INDEX].externalSupportUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"The URL to direct customers to for external support when ticketing is disabled","uniqueKey":"data.stores.items.[INDEX].externalSupportUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stores.items.[INDEX].externalSupportUrl","typeLabel":"string | null"},"externalSupportDescription":{"oneOf":[{"type":"string","description":"A description shown to customers explaining where to get support when ticketing is disabled","uniqueKey":"data.stores.items.[INDEX].externalSupportDescription.oneOf.0","typeLabel":"string"},{"type":"null","description":"A description shown to customers explaining where to get support when ticketing is disabled","uniqueKey":"data.stores.items.[INDEX].externalSupportDescription.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stores.items.[INDEX].externalSupportDescription","typeLabel":"string | null"},"lastOrderAt":{"oneOf":[{"type":"string","description":"The timestamp of the last order created for this store","format":"date-time","uniqueKey":"data.stores.items.[INDEX].lastOrderAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The timestamp of the last order created for this store","format":"date-time","uniqueKey":"data.stores.items.[INDEX].lastOrderAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stores.items.[INDEX].lastOrderAt","typeLabel":"string\u003cdate-time> | null"}},"additionalProperties":false,"description":"A reference to a store which is owned by a merchant that can be used as a front for selling products to customers","uniqueKey":"data.stores.items.[INDEX]","typeLabel":"object"},"description":"Represents the collection of store references associated with a user.","isRequired":true,"uniqueKey":"data.stores","typeLabel":"object[]"},"email":{"type":"string","description":"The user's email address.","isRequired":true,"uniqueKey":"data.email","typeLabel":"string"},"userName":{"type":"string","description":"The username of the user.","isRequired":true,"uniqueKey":"data.userName","typeLabel":"string"},"plan":{"type":"string","description":"The user's subscription plan.","isRequired":true,"uniqueKey":"data.plan","typeLabel":"string"},"isBuyerProtectionManager":{"type":"boolean","description":"Whether the user has been granted the narrowly-scoped Buyer Protection Manager staff role,\nwhich grants access to the Buyer Protection admin surface only. Independent of Plan,\nwhich by design never reflects this role (see BuyerProtectionManager).","isRequired":true,"uniqueKey":"data.isBuyerProtectionManager","typeLabel":"boolean"},"twoFactorEnabled":{"type":"boolean","description":"Indicates whether two-factor authentication is enabled for the user.","isRequired":true,"uniqueKey":"data.twoFactorEnabled","typeLabel":"boolean"},"totpEnabled":{"type":"boolean","description":"Indicates whether TOTP (authenticator app) two-factor authentication is enabled.","isRequired":true,"uniqueKey":"data.totpEnabled","typeLabel":"boolean"},"passkeyEnabled":{"type":"boolean","description":"Indicates whether passkey two-factor authentication is enabled.","isRequired":true,"uniqueKey":"data.passkeyEnabled","typeLabel":"boolean"},"riskLocked":{"type":"boolean","description":"Whether their account is locked due to being too high risk","isRequired":true,"uniqueKey":"data.riskLocked","typeLabel":"boolean"},"billingSuspended":{"type":"boolean","description":"Whether the user is suspended due to failed payments.","isRequired":true,"uniqueKey":"data.billingSuspended","typeLabel":"boolean"},"integrations":{"type":"array","items":{"required":["application","dateCreated","id"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.integrations.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created","format":"date-time","isRequired":true,"uniqueKey":"data.integrations.items.[INDEX].dateCreated","typeLabel":"string\u003cdate-time>"},"application":{"required":["dateCreated","id","name","permissions","redirectUrls","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.integrations.items.[INDEX].application.id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created","format":"date-time","isRequired":true,"uniqueKey":"data.integrations.items.[INDEX].application.dateCreated","typeLabel":"string\u003cdate-time>"},"name":{"maxLength":100,"minLength":2,"type":"string","description":"The name of the application","isRequired":true,"uniqueKey":"data.integrations.items.[INDEX].application.name","typeLabel":"string"},"permissions":{"type":"array","items":{"type":"string","uniqueKey":"data.integrations.items.[INDEX].application.permissions.items.[INDEX]","typeLabel":"string"},"description":"The list of permissions the application requires","isRequired":true,"uniqueKey":"data.integrations.items.[INDEX].application.permissions","typeLabel":"string[]"},"redirectUrls":{"type":"array","items":{"type":"string","uniqueKey":"data.integrations.items.[INDEX].application.redirectUrls.items.[INDEX]","typeLabel":"string"},"description":"The list of redirect URLs that are authorized for the application","isRequired":true,"uniqueKey":"data.integrations.items.[INDEX].application.redirectUrls","typeLabel":"string[]"},"userId":{"type":"string","description":"The ID of the user who owns the application","isRequired":true,"uniqueKey":"data.integrations.items.[INDEX].application.userId","typeLabel":"string"},"imageName":{"oneOf":[{"type":"string","description":"The name of the image to show for the application","uniqueKey":"data.integrations.items.[INDEX].application.imageName.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name of the image to show for the application","uniqueKey":"data.integrations.items.[INDEX].application.imageName.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.integrations.items.[INDEX].application.imageName","typeLabel":"string | null"},"termsOfServiceLink":{"oneOf":[{"maxLength":2000,"type":"string","description":"The link to the application's terms of service","uniqueKey":"data.integrations.items.[INDEX].application.termsOfServiceLink.oneOf.0","typeLabel":"string"},{"maxLength":2000,"type":"null","description":"The link to the application's terms of service","uniqueKey":"data.integrations.items.[INDEX].application.termsOfServiceLink.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.integrations.items.[INDEX].application.termsOfServiceLink","typeLabel":"string | null"},"privacyPolicyLink":{"oneOf":[{"maxLength":2000,"type":"string","description":"The link to the application's privacy policy","uniqueKey":"data.integrations.items.[INDEX].application.privacyPolicyLink.oneOf.0","typeLabel":"string"},{"maxLength":2000,"type":"null","description":"The link to the application's privacy policy","uniqueKey":"data.integrations.items.[INDEX].application.privacyPolicyLink.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.integrations.items.[INDEX].application.privacyPolicyLink","typeLabel":"string | null"}},"additionalProperties":false,"description":"An application to use for OAuth2","isRequired":true,"uniqueKey":"data.integrations.items.[INDEX].application","typeLabel":"object"}},"additionalProperties":false,"description":"Represents an OAuth integration for a specific OAuth2 application.\nThis class is used to expose integration information to the public in a controlled manner.","uniqueKey":"data.integrations.items.[INDEX]","typeLabel":"object"},"description":"A list of connected OAuth integrations for the user.","isRequired":true,"uniqueKey":"data.integrations","typeLabel":"object[]"},"apiKeys":{"type":"array","items":{"required":["dateCreated","id","ipAddresses","label","scopes","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.apiKeys.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created in the database","format":"date-time","isRequired":true,"uniqueKey":"data.apiKeys.items.[INDEX].dateCreated","typeLabel":"string\u003cdate-time>"},"label":{"maxLength":64,"minLength":1,"type":"string","description":"Represents a descriptive or identifiable name assigned to the API key","isRequired":true,"uniqueKey":"data.apiKeys.items.[INDEX].label","typeLabel":"string"},"ipAddresses":{"type":"array","items":{"type":"string","uniqueKey":"data.apiKeys.items.[INDEX].ipAddresses.items.[INDEX]","typeLabel":"string"},"description":"The list of IP addresses which are allowed to access the API","isRequired":true,"uniqueKey":"data.apiKeys.items.[INDEX].ipAddresses","typeLabel":"string[]"},"scopes":{"type":"array","items":{"type":"string","uniqueKey":"data.apiKeys.items.[INDEX].scopes.items.[INDEX]","typeLabel":"string"},"description":"The list of scopes the API key is allowed to access","isRequired":true,"uniqueKey":"data.apiKeys.items.[INDEX].scopes","typeLabel":"string[]"},"userId":{"maxLength":36,"minLength":1,"type":"string","description":"The identifier of the user associated with the API key","isRequired":true,"uniqueKey":"data.apiKeys.items.[INDEX].userId","typeLabel":"string"}},"additionalProperties":false,"description":"Represents an API key associated with a merchant's account, used for identifying and authenticating requests.","uniqueKey":"data.apiKeys.items.[INDEX]","typeLabel":"object"},"description":"The API keys associated with the user.","isRequired":true,"uniqueKey":"data.apiKeys","typeLabel":"object[]"},"disabledPaymentMethods":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"data.disabledPaymentMethods.additionalProperties","typeLabel":"string"},"description":"A collection of payment methods that are disabled for the user.","isRequired":true,"uniqueKey":"data.disabledPaymentMethods","typeLabel":"object"},"stripeEnabled":{"type":"boolean","description":"Indicates whether Stripe integration is enabled for the user.","isRequired":true,"uniqueKey":"data.stripeEnabled","typeLabel":"boolean"},"nmiEnabled":{"type":"boolean","description":"Indicates whether NMI is enabled for the user.","isRequired":true,"uniqueKey":"data.nmiEnabled","typeLabel":"boolean"},"moneyMotionEnabled":{"type":"boolean","description":"Indicates whether moneymotion is enabled for the user.","isRequired":true,"uniqueKey":"data.moneyMotionEnabled","typeLabel":"boolean"},"pandabaseEnabled":{"type":"boolean","description":"Indicates whether the Pandabase integration is enabled for the user.","isRequired":true,"uniqueKey":"data.pandabaseEnabled","typeLabel":"boolean"},"shopifyEnabled":{"type":"boolean","description":"Indicates whether the Shopify integration is enabled for the user.","isRequired":true,"uniqueKey":"data.shopifyEnabled","typeLabel":"boolean"},"storrikEnabled":{"type":"boolean","description":"Indicates whether Storrik integration is enabled for the user.","isRequired":true,"uniqueKey":"data.storrikEnabled","typeLabel":"boolean"},"mollieEnabled":{"type":"boolean","description":"Indicates whether Mollie integration is enabled for the user.","isRequired":true,"uniqueKey":"data.mollieEnabled","typeLabel":"boolean"},"northbridgeEnabled":{"type":"boolean","description":"Indicates whether Northbridge integration is enabled for the user.","isRequired":true,"uniqueKey":"data.northbridgeEnabled","typeLabel":"boolean"},"squareEnabled":{"type":"boolean","description":"Indicates whether Square integration is enabled for the user.","isRequired":true,"uniqueKey":"data.squareEnabled","typeLabel":"boolean"},"paypalBusinessEnabled":{"type":"boolean","description":"Indicates whether PayPal Business integration is enabled for the user.","isRequired":true,"uniqueKey":"data.paypalBusinessEnabled","typeLabel":"boolean"},"isCryptoEnabled":{"type":"boolean","description":"Indicates whether cryptocurrency integration is enabled for the user.","isRequired":true,"uniqueKey":"data.isCryptoEnabled","typeLabel":"boolean"},"isSumUpEnabled":{"type":"boolean","description":"Indicates whether the SumUp integration is enabled for the user.","isRequired":true,"uniqueKey":"data.isSumUpEnabled","typeLabel":"boolean"},"paddleEnabled":{"type":"boolean","description":"Indicates whether Paddle integration is enabled for the user.","isRequired":true,"uniqueKey":"data.paddleEnabled","typeLabel":"boolean"},"fastSpringEnabled":{"type":"boolean","description":"Indicates whether FastSpring integration is enabled for the user.","isRequired":true,"uniqueKey":"data.fastSpringEnabled","typeLabel":"boolean"},"venPayrEnabled":{"type":"boolean","description":"Whether the user has access to the VenPayr gateway.","isRequired":true,"uniqueKey":"data.venPayrEnabled","typeLabel":"boolean"},"ovgcEnabled":{"type":"boolean","description":"Indicates whether OVGC Payments integration is enabled for the user.","isRequired":true,"uniqueKey":"data.ovgcEnabled","typeLabel":"boolean"},"isAuthorizeNetEnabled":{"type":"boolean","description":"Indicates whether Authorize.Net payment integration is enabled for the user.","isRequired":true,"uniqueKey":"data.isAuthorizeNetEnabled","typeLabel":"boolean"},"restrictedPaymentMethods":{"type":"array","items":{"type":"string","uniqueKey":"data.restrictedPaymentMethods.items.[INDEX]","typeLabel":"string"},"description":"The list of payment methods which are restricted for the user.","isRequired":true,"uniqueKey":"data.restrictedPaymentMethods","typeLabel":"string[]"},"riskLockedPaymentMethods":{"type":"array","items":{"type":"string","uniqueKey":"data.riskLockedPaymentMethods.items.[INDEX]","typeLabel":"string"},"description":"The list of payment methods which are risk locked for the user.","isRequired":true,"uniqueKey":"data.riskLockedPaymentMethods","typeLabel":"string[]"},"integrationErrorReports":{"type":"array","items":{"required":["dateCreated","gateway","id","reason","reporter","resolved","type","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.integrationErrorReports.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created in the database","format":"date-time","isRequired":true,"uniqueKey":"data.integrationErrorReports.items.[INDEX].dateCreated","typeLabel":"string\u003cdate-time>"},"reason":{"maxLength":1024,"minLength":3,"type":"string","description":"The reason for the report","isRequired":true,"uniqueKey":"data.integrationErrorReports.items.[INDEX].reason","typeLabel":"string"},"gateway":{"maxLength":64,"minLength":1,"type":"string","description":"The ID of the payment gateway that has the error","isRequired":true,"uniqueKey":"data.integrationErrorReports.items.[INDEX].gateway","typeLabel":"string"},"reporter":{"maxLength":128,"minLength":1,"type":"string","description":"The hostname of the server which reported the issue","isRequired":true,"uniqueKey":"data.integrationErrorReports.items.[INDEX].reporter","typeLabel":"string"},"resolved":{"type":"boolean","description":"Whether the report has been acknowledged and resolved - therefore should not be shown","isRequired":true,"uniqueKey":"data.integrationErrorReports.items.[INDEX].resolved","typeLabel":"boolean"},"type":{"maxLength":256,"minLength":3,"type":"string","description":"The ID/type of report that specifically identifies the detected issue","isRequired":true,"uniqueKey":"data.integrationErrorReports.items.[INDEX].type","typeLabel":"string"},"userId":{"maxLength":36,"type":"string","description":"The user who the report is for (automatically done by EF core)","isRequired":true,"uniqueKey":"data.integrationErrorReports.items.[INDEX].userId","typeLabel":"string"}},"additionalProperties":false,"description":"Represents a report by an integration that defines that a misconfiguration was detected that may cause issues","uniqueKey":"data.integrationErrorReports.items.[INDEX]","typeLabel":"object"},"description":"A collection of error reports related to integrations.","isRequired":true,"uniqueKey":"data.integrationErrorReports","typeLabel":"object[]"},"lastPasswordUpdate":{"type":"string","description":"The timestamp of the user's last password update.","format":"date-time","isRequired":true,"uniqueKey":"data.lastPasswordUpdate","typeLabel":"string\u003cdate-time>"},"signals":{"required":["countryCode","dateCreated","id","registrationFingerprint","registrationIpAddress","userId","verificationStatus"],"type":"object","properties":{"countryCode":{"maxLength":2,"minLength":1,"pattern":"^[A-Z]{2}$","type":"string","description":"The ISO 3166-1 alpha-2 country code associated with the address.\nExamples: \"US\" for the United States, \"CA\" for Canada.","isRequired":true,"uniqueKey":"data.signals.countryCode","typeLabel":"string"},"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.signals.id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created in the database","format":"date-time","isRequired":true,"uniqueKey":"data.signals.dateCreated","typeLabel":"string\u003cdate-time>"},"userId":{"maxLength":36,"minLength":1,"type":"string","description":"The ID of the user the KYC info belongs to","isRequired":true,"uniqueKey":"data.signals.userId","typeLabel":"string"},"registrationIpAddress":{"maxLength":45,"type":"string","description":"Gets or sets the IP address that was used to create the merchant","isRequired":true,"uniqueKey":"data.signals.registrationIpAddress","typeLabel":"string"},"registrationFingerprint":{"maxLength":256,"type":"string","description":"The browser/device-specific fingerprint captured during user registration for identity verification.","isRequired":true,"uniqueKey":"data.signals.registrationFingerprint","typeLabel":"string"},"verificationStatus":{"maxLength":30,"minLength":1,"type":"string","description":"The current verification status of the merchant's KYC process.","isRequired":true,"uniqueKey":"data.signals.verificationStatus","typeLabel":"string"},"legalEntityType":{"oneOf":[{"maxLength":1000,"minLength":1,"type":"string","description":"The legal entity type of the merchant.","uniqueKey":"data.signals.legalEntityType.oneOf.0","typeLabel":"string"},{"maxLength":1000,"minLength":1,"type":"null","description":"The legal entity type of the merchant.","uniqueKey":"data.signals.legalEntityType.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.signals.legalEntityType","typeLabel":"string | null"},"taxId":{"oneOf":[{"maxLength":50,"type":"string","description":"Tax Identification Number or VAT number.","uniqueKey":"data.signals.taxId.oneOf.0","typeLabel":"string"},{"maxLength":50,"type":"null","description":"Tax Identification Number or VAT number.","uniqueKey":"data.signals.taxId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.signals.taxId","typeLabel":"string | null"},"fullName":{"oneOf":[{"maxLength":100,"type":"string","description":"The full name of the individual or entity associated with merchant account.","uniqueKey":"data.signals.fullName.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","description":"The full name of the individual or entity associated with merchant account.","uniqueKey":"data.signals.fullName.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.signals.fullName","typeLabel":"string | null"},"addressLine1":{"oneOf":[{"maxLength":200,"type":"string","description":"The primary address line.\nTypically, includes house number, street name, or building name.","uniqueKey":"data.signals.addressLine1.oneOf.0","typeLabel":"string"},{"maxLength":200,"type":"null","description":"The primary address line.\nTypically, includes house number, street name, or building name.","uniqueKey":"data.signals.addressLine1.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.signals.addressLine1","typeLabel":"string | null"},"addressLine2":{"oneOf":[{"maxLength":200,"type":"string","description":"The secondary address line, if applicable.\nMay include apartment, suite, unit, or floor details.\nOptional field.","uniqueKey":"data.signals.addressLine2.oneOf.0","typeLabel":"string"},{"maxLength":200,"type":"null","description":"The secondary address line, if applicable.\nMay include apartment, suite, unit, or floor details.\nOptional field.","uniqueKey":"data.signals.addressLine2.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.signals.addressLine2","typeLabel":"string | null"},"city":{"oneOf":[{"maxLength":100,"type":"string","description":"The city or locality associated with the address.","uniqueKey":"data.signals.city.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","description":"The city or locality associated with the address.","uniqueKey":"data.signals.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.signals.city","typeLabel":"string | null"},"region":{"oneOf":[{"maxLength":100,"type":"string","description":"The region associated with the address.\nRepresents state, province, or other administrative division.","uniqueKey":"data.signals.region.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","description":"The region associated with the address.\nRepresents state, province, or other administrative division.","uniqueKey":"data.signals.region.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.signals.region","typeLabel":"string | null"},"postalCode":{"oneOf":[{"maxLength":20,"type":"string","description":"The postal or ZIP code for the address.","uniqueKey":"data.signals.postalCode.oneOf.0","typeLabel":"string"},{"maxLength":20,"type":"null","description":"The postal or ZIP code for the address.","uniqueKey":"data.signals.postalCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.signals.postalCode","typeLabel":"string | null"}},"additionalProperties":false,"description":"Represents the risk signal information on a merchant","uniqueKey":"data.signals","typeLabel":"object"},"discordWebhookUrl":{"oneOf":[{"type":"string","description":"The URL for a Discord webhook associated with the user.","uniqueKey":"data.discordWebhookUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"The URL for a Discord webhook associated with the user.","uniqueKey":"data.discordWebhookUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.discordWebhookUrl","typeLabel":"string | null"},"subscription":{"required":["autoRenew","billingInterval","customerIds","dateCreated","emailMarketingSent","expiryDate","failedPaymentCount","id","isExpired","lastSyncedAt","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.subscription.id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created in the database","format":"date-time","isRequired":true,"uniqueKey":"data.subscription.dateCreated","typeLabel":"string\u003cdate-time>"},"expiryDate":{"type":"string","description":"Gets or sets the expiry date of the subscription plan.\nDefaults to DateOnly.MaxValue if the plan does not have an expiration date.","format":"date","isRequired":true,"uniqueKey":"data.subscription.expiryDate","typeLabel":"string\u003cdate>"},"autoRenew":{"type":"boolean","description":"Gets or sets a value indicating whether the subscription will automatically renew.\nDefault is true unless explicitly disabled by the user or system configuration.","isRequired":true,"uniqueKey":"data.subscription.autoRenew","typeLabel":"boolean"},"userId":{"maxLength":36,"minLength":3,"type":"string","description":"Gets or sets the unique identifier for the user associated with the subscription options.\nRequired and must be a string between 3 and 36 characters.","isRequired":true,"uniqueKey":"data.subscription.userId","typeLabel":"string"},"billingInterval":{"maxLength":20,"type":"string","description":"The billing interval for the subscription (e.g., Monthly, Yearly).","isRequired":true,"uniqueKey":"data.subscription.billingInterval","typeLabel":"string"},"failedPaymentCount":{"type":"integer","description":"The number of consecutive failed payment attempts.","format":"int32","isRequired":true,"uniqueKey":"data.subscription.failedPaymentCount","typeLabel":"integer\u003cint32>"},"lastSyncedAt":{"type":"string","description":"Gets or sets the timestamp of the last synchronization event.\nDefault is the current UTC time at instantiation.","format":"date-time","isRequired":true,"uniqueKey":"data.subscription.lastSyncedAt","typeLabel":"string\u003cdate-time>"},"customerIds":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"data.subscription.customerIds.additionalProperties","typeLabel":"string"},"description":"The IDs of the customer on respective payment gateways","isRequired":true,"uniqueKey":"data.subscription.customerIds","typeLabel":"object"},"emailMarketingSent":{"type":"integer","description":"Email marketing emails sent in the current monthly quota window, shared across ALL of the\naccount's stores. The Business plan grants a fixed 50,000/month allowance that resets (does\nnot stack) on the billing anniversary; non-Business accounts have a 0 allowance.","format":"int64","isRequired":true,"uniqueKey":"data.subscription.emailMarketingSent","typeLabel":"integer\u003cint64>"},"isExpired":{"type":"boolean","description":"Gets a value indicating whether the subscription is expired.\nA subscription is considered expired if:\n1. The status is \"trial_expired\" or \"suspended\".\n2. The ExpiryDate has passed AND we're not in a retry grace period.\n3. The TrialEndDate has passed (if applicable).\nFree plan merchants are never considered expired (they can always sell unless explicitly suspended).","readOnly":true,"isRequired":true,"uniqueKey":"data.subscription.isExpired","typeLabel":"boolean"},"startedDate":{"oneOf":[{"type":"string","description":"Gets or sets the start date of the user's subscription.\nThis represents when the subscription started or was activated.","format":"date","uniqueKey":"data.subscription.startedDate.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","description":"Gets or sets the start date of the user's subscription.\nThis represents when the subscription started or was activated.","format":"date","uniqueKey":"data.subscription.startedDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.startedDate","typeLabel":"string\u003cdate> | null"},"status":{"oneOf":[{"maxLength":50,"type":"string","description":"Gets or sets the current subscription status for a user.\nExamples include \"active\" or \"canceled\".","uniqueKey":"data.subscription.status.oneOf.0","typeLabel":"string"},{"maxLength":50,"type":"null","description":"Gets or sets the current subscription status for a user.\nExamples include \"active\" or \"canceled\".","uniqueKey":"data.subscription.status.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.status","typeLabel":"string | null"},"trialEndDate":{"oneOf":[{"type":"string","description":"Gets or sets the trial end date for the user's subscription.\nNull if no trial is assigned.","format":"date","uniqueKey":"data.subscription.trialEndDate.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","description":"Gets or sets the trial end date for the user's subscription.\nNull if no trial is assigned.","format":"date","uniqueKey":"data.subscription.trialEndDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.trialEndDate","typeLabel":"string\u003cdate> | null"},"planId":{"oneOf":[{"maxLength":128,"minLength":0,"type":"string","description":"Gets or sets the identifier for the plan associated with the subscription.","uniqueKey":"data.subscription.planId.oneOf.0","typeLabel":"string"},{"maxLength":128,"minLength":0,"type":"null","description":"Gets or sets the identifier for the plan associated with the subscription.","uniqueKey":"data.subscription.planId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.planId","typeLabel":"string | null"},"lastPaymentFailureDate":{"oneOf":[{"type":"string","description":"The date of the last failed payment attempt.","format":"date-time","uniqueKey":"data.subscription.lastPaymentFailureDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The date of the last failed payment attempt.","format":"date-time","uniqueKey":"data.subscription.lastPaymentFailureDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.lastPaymentFailureDate","typeLabel":"string\u003cdate-time> | null"},"nextRetryDate":{"oneOf":[{"type":"string","description":"The next date to retry billing after a failed payment.\nUsed for exponential backoff retry strategy.\nNull when no retry is pending (payment succeeded or account suspended).","format":"date","uniqueKey":"data.subscription.nextRetryDate.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","description":"The next date to retry billing after a failed payment.\nUsed for exponential backoff retry strategy.\nNull when no retry is pending (payment succeeded or account suspended).","format":"date","uniqueKey":"data.subscription.nextRetryDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.nextRetryDate","typeLabel":"string\u003cdate> | null"},"cancelAt":{"oneOf":[{"type":"string","description":"Gets or sets the date and time when the subscription is set to be canceled.\nNull indicates no cancellation is scheduled by default.","format":"date-time","uniqueKey":"data.subscription.cancelAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Gets or sets the date and time when the subscription is set to be canceled.\nNull indicates no cancellation is scheduled by default.","format":"date-time","uniqueKey":"data.subscription.cancelAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.cancelAt","typeLabel":"string\u003cdate-time> | null"},"canceledAt":{"oneOf":[{"type":"string","description":"Gets or sets the date and time when the subscription was canceled.\nThis property is null if the subscription has not been canceled.","format":"date-time","uniqueKey":"data.subscription.canceledAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Gets or sets the date and time when the subscription was canceled.\nThis property is null if the subscription has not been canceled.","format":"date-time","uniqueKey":"data.subscription.canceledAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.canceledAt","typeLabel":"string\u003cdate-time> | null"},"scheduledPlanId":{"oneOf":[{"maxLength":128,"minLength":0,"type":"string","description":"Gets or sets the scheduled plan ID for a pending downgrade.\nWhen set, the plan will change to this at the end of the current billing period.","uniqueKey":"data.subscription.scheduledPlanId.oneOf.0","typeLabel":"string"},{"maxLength":128,"minLength":0,"type":"null","description":"Gets or sets the scheduled plan ID for a pending downgrade.\nWhen set, the plan will change to this at the end of the current billing period.","uniqueKey":"data.subscription.scheduledPlanId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.scheduledPlanId","typeLabel":"string | null"},"scheduledBillingInterval":{"oneOf":[{"maxLength":20,"type":"string","description":"Gets or sets the scheduled billing interval for a pending downgrade.\nUsed together with ScheduledPlanId.","uniqueKey":"data.subscription.scheduledBillingInterval.oneOf.0","typeLabel":"string"},{"maxLength":20,"type":"null","description":"Gets or sets the scheduled billing interval for a pending downgrade.\nUsed together with ScheduledPlanId.","uniqueKey":"data.subscription.scheduledBillingInterval.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.scheduledBillingInterval","typeLabel":"string | null"},"lastExpiryReminderDate":{"oneOf":[{"type":"string","description":"Tracks the ExpiryDate for which the last expiry reminder was sent.\nUsed to prevent duplicate reminder emails when the Hangfire job uses a date range.\nReset implicitly when ExpiryDate advances on renewal.","format":"date","uniqueKey":"data.subscription.lastExpiryReminderDate.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","description":"Tracks the ExpiryDate for which the last expiry reminder was sent.\nUsed to prevent duplicate reminder emails when the Hangfire job uses a date range.\nReset implicitly when ExpiryDate advances on renewal.","format":"date","uniqueKey":"data.subscription.lastExpiryReminderDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.lastExpiryReminderDate","typeLabel":"string\u003cdate> | null"},"emailMarketingQuotaResetAt":{"oneOf":[{"type":"string","description":"When the email marketing monthly quota window resets EmailMarketingSent back to\nzero. Null until the account first uses email marketing as a Business plan.","format":"date-time","uniqueKey":"data.subscription.emailMarketingQuotaResetAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"When the email marketing monthly quota window resets EmailMarketingSent back to\nzero. Null until the account first uses email marketing as a Business plan.","format":"date-time","uniqueKey":"data.subscription.emailMarketingQuotaResetAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.emailMarketingQuotaResetAt","typeLabel":"string\u003cdate-time> | null"}},"additionalProperties":false,"description":"Represents the subscription configuration and details for a user.","uniqueKey":"data.subscription","typeLabel":"object"},"refreshAt":{"oneOf":[{"type":"string","description":"The timestamp indicating when the user information should be refreshed.","format":"date-time","uniqueKey":"data.refreshAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The timestamp indicating when the user information should be refreshed.","format":"date-time","uniqueKey":"data.refreshAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.refreshAt","typeLabel":"string\u003cdate-time> | null"},"billingSuspensionDate":{"oneOf":[{"type":"string","description":"The date when the billing suspension started.","format":"date-time","uniqueKey":"data.billingSuspensionDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The date when the billing suspension started.","format":"date-time","uniqueKey":"data.billingSuspensionDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.billingSuspensionDate","typeLabel":"string\u003cdate-time> | null"},"cashAppOptions":{"required":["id","isAcceptingRequests","isEnabled","isRestricted","isRiskLocked","notesVersion","requireBillingInformation","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.cashAppOptions.id","typeLabel":"string\u003cuuid>"},"isEnabled":{"type":"boolean","description":"Whether the integration is enabled or not","isRequired":true,"uniqueKey":"data.cashAppOptions.isEnabled","typeLabel":"boolean"},"isRestricted":{"type":"boolean","description":"Whether the payment method is restricted from being used by the PSP","isRequired":true,"uniqueKey":"data.cashAppOptions.isRestricted","typeLabel":"boolean"},"isRiskLocked":{"type":"boolean","description":"Whether the payment method is restricted for setup by the user due to risk concerns","isRequired":true,"uniqueKey":"data.cashAppOptions.isRiskLocked","typeLabel":"boolean"},"userId":{"maxLength":36,"type":"string","description":"The user ID the integration options are for","isRequired":true,"uniqueKey":"data.cashAppOptions.userId","typeLabel":"string"},"requireBillingInformation":{"type":"boolean","description":"Whether to prompt and ask the customer for billing information, reduces conversion and increases anti-fraud\neffectiveness","isRequired":true,"uniqueKey":"data.cashAppOptions.requireBillingInformation","typeLabel":"boolean"},"isAcceptingRequests":{"type":"boolean","description":"Whether to accept Cash App requests as a delivery receipt, this can be dangerous as users can\ncharge back easily at this stage","isRequired":true,"uniqueKey":"data.cashAppOptions.isAcceptingRequests","typeLabel":"boolean"},"notesVersion":{"enum":[0,1,2],"type":"integer","description":"Represents versions used in the notes system within the application.","format":"int32","x-enum-varnames":["Version1","Version2","Custom"],"x-enum-descriptions":["The first notes version which uses random joined words by a dash","The second notes version which introduces enhanced features over the first version.","The custom notes version which uses user-defined note lists."],"isRequired":true,"uniqueKey":"data.cashAppOptions.notesVersion","typeLabel":"enum\u003cinteger>"},"restrictionReason":{"oneOf":[{"maxLength":2048,"type":"string","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.cashAppOptions.restrictionReason.oneOf.0","typeLabel":"string"},{"maxLength":2048,"type":"null","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.cashAppOptions.restrictionReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.cashAppOptions.restrictionReason","typeLabel":"string | null"},"email":{"oneOf":[{"maxLength":256,"type":"string","description":"The automatically generated email address to forward Cash App emails to","uniqueKey":"data.cashAppOptions.email.oneOf.0","typeLabel":"string"},{"maxLength":256,"type":"null","description":"The automatically generated email address to forward Cash App emails to","uniqueKey":"data.cashAppOptions.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.cashAppOptions.email","typeLabel":"string | null"},"tag":{"oneOf":[{"maxLength":32,"type":"string","description":"The users Cash Tag to show the user where to send the funds","uniqueKey":"data.cashAppOptions.tag.oneOf.0","typeLabel":"string"},{"maxLength":32,"type":"null","description":"The users Cash Tag to show the user where to send the funds","uniqueKey":"data.cashAppOptions.tag.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.cashAppOptions.tag","typeLabel":"string | null"},"customNoteListId":{"oneOf":[{"type":"string","description":"The optional custom note list to use when NotesVersion is Custom.","format":"uuid","uniqueKey":"data.cashAppOptions.customNoteListId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"The optional custom note list to use when NotesVersion is Custom.","format":"uuid","uniqueKey":"data.cashAppOptions.customNoteListId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.cashAppOptions.customNoteListId","typeLabel":"string\u003cuuid> | null"}},"additionalProperties":false,"description":"Represents configuration and options related to Cash App integration within the application.","uniqueKey":"data.cashAppOptions","typeLabel":"object"},"payPalOptions":{"required":["id","isAcceptingHeldPayments","isAcceptingRequests","isEnabled","isFriendsAndFamilyEnabled","isRestricted","isRiskLocked","isUsingLegacyEmails","notesVersion","requireBillingInformation","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.payPalOptions.id","typeLabel":"string\u003cuuid>"},"isEnabled":{"type":"boolean","description":"Whether the integration is enabled or not","isRequired":true,"uniqueKey":"data.payPalOptions.isEnabled","typeLabel":"boolean"},"isRestricted":{"type":"boolean","description":"Whether the payment method is restricted from being used by the PSP","isRequired":true,"uniqueKey":"data.payPalOptions.isRestricted","typeLabel":"boolean"},"isRiskLocked":{"type":"boolean","description":"Whether the payment method is restricted for setup by the user due to risk concerns","isRequired":true,"uniqueKey":"data.payPalOptions.isRiskLocked","typeLabel":"boolean"},"userId":{"maxLength":36,"type":"string","description":"The user ID the integration options are for","isRequired":true,"uniqueKey":"data.payPalOptions.userId","typeLabel":"string"},"requireBillingInformation":{"type":"boolean","description":"Whether to prompt and ask the customer for billing information, reduces conversion and increases anti-fraud\neffectiveness","isRequired":true,"uniqueKey":"data.payPalOptions.requireBillingInformation","typeLabel":"boolean"},"isUsingLegacyEmails":{"type":"boolean","description":"Whether the Friends and Family integration is using legacy email forwarding not IPN","isRequired":true,"uniqueKey":"data.payPalOptions.isUsingLegacyEmails","typeLabel":"boolean"},"isFriendsAndFamilyEnabled":{"type":"boolean","description":"Whether the PayPal friends and family integration is enabled","isRequired":true,"uniqueKey":"data.payPalOptions.isFriendsAndFamilyEnabled","typeLabel":"boolean"},"isAcceptingRequests":{"type":"boolean","description":"Whether to accept PayPal friends and family requests as a delivery receipt, this can be dangerous as users can\ncharge back easily at this stage","isRequired":true,"uniqueKey":"data.payPalOptions.isAcceptingRequests","typeLabel":"boolean"},"isAcceptingHeldPayments":{"type":"boolean","description":"Whether to accept payments that are on-hold automatically, this is potentially dangerous as the payment can fail at\nthis stage and cause lost funds","isRequired":true,"uniqueKey":"data.payPalOptions.isAcceptingHeldPayments","typeLabel":"boolean"},"notesVersion":{"enum":[0,1,2],"type":"integer","description":"Represents versions used in the notes system within the application.","format":"int32","x-enum-varnames":["Version1","Version2","Custom"],"x-enum-descriptions":["The first notes version which uses random joined words by a dash","The second notes version which introduces enhanced features over the first version.","The custom notes version which uses user-defined note lists."],"isRequired":true,"uniqueKey":"data.payPalOptions.notesVersion","typeLabel":"enum\u003cinteger>"},"restrictionReason":{"oneOf":[{"maxLength":2048,"type":"string","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.payPalOptions.restrictionReason.oneOf.0","typeLabel":"string"},{"maxLength":2048,"type":"null","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.payPalOptions.restrictionReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.payPalOptions.restrictionReason","typeLabel":"string | null"},"email":{"oneOf":[{"maxLength":512,"type":"string","description":"The automatically generated email address to forward PayPal emails to","uniqueKey":"data.payPalOptions.email.oneOf.0","typeLabel":"string"},{"maxLength":512,"type":"null","description":"The automatically generated email address to forward PayPal emails to","uniqueKey":"data.payPalOptions.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.payPalOptions.email","typeLabel":"string | null"},"payPalEmail":{"oneOf":[{"maxLength":512,"type":"string","description":"The actual email address associated with their PayPal account","uniqueKey":"data.payPalOptions.payPalEmail.oneOf.0","typeLabel":"string"},{"maxLength":512,"type":"null","description":"The actual email address associated with their PayPal account","uniqueKey":"data.payPalOptions.payPalEmail.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.payPalOptions.payPalEmail","typeLabel":"string | null"},"customNoteListId":{"oneOf":[{"type":"string","description":"The optional custom note list to use when NotesVersion is Custom.","format":"uuid","uniqueKey":"data.payPalOptions.customNoteListId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"The optional custom note list to use when NotesVersion is Custom.","format":"uuid","uniqueKey":"data.payPalOptions.customNoteListId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.payPalOptions.customNoteListId","typeLabel":"string\u003cuuid> | null"}},"additionalProperties":false,"description":"The options to configure PayPal with","uniqueKey":"data.payPalOptions","typeLabel":"object"},"storrikOptions":{"required":["id","isEnabled","isRestricted","isRiskLocked","requireBillingInformation","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.storrikOptions.id","typeLabel":"string\u003cuuid>"},"isEnabled":{"type":"boolean","description":"Whether the integration is enabled or not","isRequired":true,"uniqueKey":"data.storrikOptions.isEnabled","typeLabel":"boolean"},"isRestricted":{"type":"boolean","description":"Whether the payment method is restricted from being used by the PSP","isRequired":true,"uniqueKey":"data.storrikOptions.isRestricted","typeLabel":"boolean"},"isRiskLocked":{"type":"boolean","description":"Whether the payment method is restricted for setup by the user due to risk concerns","isRequired":true,"uniqueKey":"data.storrikOptions.isRiskLocked","typeLabel":"boolean"},"userId":{"maxLength":36,"type":"string","description":"The user ID the integration options are for","isRequired":true,"uniqueKey":"data.storrikOptions.userId","typeLabel":"string"},"requireBillingInformation":{"type":"boolean","description":"Whether to prompt and ask the customer for billing information, reduces conversion and increases anti-fraud\neffectiveness","isRequired":true,"uniqueKey":"data.storrikOptions.requireBillingInformation","typeLabel":"boolean"},"restrictionReason":{"oneOf":[{"maxLength":2048,"type":"string","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.storrikOptions.restrictionReason.oneOf.0","typeLabel":"string"},{"maxLength":2048,"type":"null","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.storrikOptions.restrictionReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storrikOptions.restrictionReason","typeLabel":"string | null"}},"additionalProperties":false,"description":"Represents configuration options for Storrik integration.","uniqueKey":"data.storrikOptions","typeLabel":"object"},"payPalBusinessOptions":{"required":["forceCardOnly","id","isEnabled","isRestricted","isRiskLocked","isUsingLegacyIntegration","requireBillingInformation","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.payPalBusinessOptions.id","typeLabel":"string\u003cuuid>"},"isEnabled":{"type":"boolean","description":"Whether the integration is enabled or not","isRequired":true,"uniqueKey":"data.payPalBusinessOptions.isEnabled","typeLabel":"boolean"},"isRestricted":{"type":"boolean","description":"Whether the payment method is restricted from being used by the PSP","isRequired":true,"uniqueKey":"data.payPalBusinessOptions.isRestricted","typeLabel":"boolean"},"isRiskLocked":{"type":"boolean","description":"Whether the payment method is restricted for setup by the user due to risk concerns","isRequired":true,"uniqueKey":"data.payPalBusinessOptions.isRiskLocked","typeLabel":"boolean"},"userId":{"maxLength":36,"type":"string","description":"The user ID the integration options are for","isRequired":true,"uniqueKey":"data.payPalBusinessOptions.userId","typeLabel":"string"},"requireBillingInformation":{"type":"boolean","description":"Whether to prompt and ask the customer for billing information, reduces conversion and increases anti-fraud\neffectiveness","isRequired":true,"uniqueKey":"data.payPalBusinessOptions.requireBillingInformation","typeLabel":"boolean"},"isUsingLegacyIntegration":{"type":"boolean","description":"Whether the system is using the legacy PayPal Business integration method, which uses links and \"not smart\" buttons","isRequired":true,"uniqueKey":"data.payPalBusinessOptions.isUsingLegacyIntegration","typeLabel":"boolean"},"forceCardOnly":{"type":"boolean","description":"When true, the checkout UI should only show the credit/debit card option, not PayPal wallet.","isRequired":true,"uniqueKey":"data.payPalBusinessOptions.forceCardOnly","typeLabel":"boolean"},"restrictionReason":{"oneOf":[{"maxLength":2048,"type":"string","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.payPalBusinessOptions.restrictionReason.oneOf.0","typeLabel":"string"},{"maxLength":2048,"type":"null","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.payPalBusinessOptions.restrictionReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.payPalBusinessOptions.restrictionReason","typeLabel":"string | null"},"oAuthClientId":{"oneOf":[{"maxLength":512,"type":"string","description":"The OAuth client identifier used for authentication with PayPal.","uniqueKey":"data.payPalBusinessOptions.oAuthClientId.oneOf.0","typeLabel":"string"},{"maxLength":512,"type":"null","description":"The OAuth client identifier used for authentication with PayPal.","uniqueKey":"data.payPalBusinessOptions.oAuthClientId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.payPalBusinessOptions.oAuthClientId","typeLabel":"string | null"},"emailAddress":{"oneOf":[{"maxLength":256,"type":"string","description":"The email address associated with the PayPal account, used for the old system","uniqueKey":"data.payPalBusinessOptions.emailAddress.oneOf.0","typeLabel":"string"},{"maxLength":256,"type":"null","description":"The email address associated with the PayPal account, used for the old system","uniqueKey":"data.payPalBusinessOptions.emailAddress.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.payPalBusinessOptions.emailAddress","typeLabel":"string | null"}},"additionalProperties":false,"description":"Represents the configuration options specific to a PayPal Business integration.","uniqueKey":"data.payPalBusinessOptions","typeLabel":"object"},"stripeOptions":{"required":["id","isEnabled","isRestricted","isRiskLocked","requireBillingInformation","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.stripeOptions.id","typeLabel":"string\u003cuuid>"},"isEnabled":{"type":"boolean","description":"Whether the integration is enabled or not","isRequired":true,"uniqueKey":"data.stripeOptions.isEnabled","typeLabel":"boolean"},"isRestricted":{"type":"boolean","description":"Whether the payment method is restricted from being used by the PSP","isRequired":true,"uniqueKey":"data.stripeOptions.isRestricted","typeLabel":"boolean"},"isRiskLocked":{"type":"boolean","description":"Whether the payment method is restricted for setup by the user due to risk concerns","isRequired":true,"uniqueKey":"data.stripeOptions.isRiskLocked","typeLabel":"boolean"},"userId":{"maxLength":36,"type":"string","description":"The user ID the integration options are for","isRequired":true,"uniqueKey":"data.stripeOptions.userId","typeLabel":"string"},"requireBillingInformation":{"type":"boolean","description":"Whether to prompt and ask the customer for billing information, reduces conversion and increases anti-fraud\neffectiveness","isRequired":true,"uniqueKey":"data.stripeOptions.requireBillingInformation","typeLabel":"boolean"},"restrictionReason":{"oneOf":[{"maxLength":2048,"type":"string","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.stripeOptions.restrictionReason.oneOf.0","typeLabel":"string"},{"maxLength":2048,"type":"null","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.stripeOptions.restrictionReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stripeOptions.restrictionReason","typeLabel":"string | null"},"paymentMethodConfigurationId":{"oneOf":[{"maxLength":64,"type":"string","description":"The payment method configuration ID to use for the account integration","uniqueKey":"data.stripeOptions.paymentMethodConfigurationId.oneOf.0","typeLabel":"string"},{"maxLength":64,"type":"null","description":"The payment method configuration ID to use for the account integration","uniqueKey":"data.stripeOptions.paymentMethodConfigurationId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stripeOptions.paymentMethodConfigurationId","typeLabel":"string | null"},"publishableKey":{"oneOf":[{"maxLength":512,"minLength":0,"type":"string","description":"The publishable key for the Stripe integration, not encrypted","uniqueKey":"data.stripeOptions.publishableKey.oneOf.0","typeLabel":"string"},{"maxLength":512,"minLength":0,"type":"null","description":"The publishable key for the Stripe integration, not encrypted","uniqueKey":"data.stripeOptions.publishableKey.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stripeOptions.publishableKey","typeLabel":"string | null"}},"additionalProperties":false,"description":"The Stripe options for a merchants Stripe setup","uniqueKey":"data.stripeOptions","typeLabel":"object"},"squareOptions":{"required":["applicationId","id","isEnabled","isRestricted","isRiskLocked","locationId","requireBillingInformation","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.squareOptions.id","typeLabel":"string\u003cuuid>"},"isEnabled":{"type":"boolean","description":"Whether the integration is enabled or not","isRequired":true,"uniqueKey":"data.squareOptions.isEnabled","typeLabel":"boolean"},"isRestricted":{"type":"boolean","description":"Whether the payment method is restricted from being used by the PSP","isRequired":true,"uniqueKey":"data.squareOptions.isRestricted","typeLabel":"boolean"},"isRiskLocked":{"type":"boolean","description":"Whether the payment method is restricted for setup by the user due to risk concerns","isRequired":true,"uniqueKey":"data.squareOptions.isRiskLocked","typeLabel":"boolean"},"userId":{"maxLength":36,"type":"string","description":"The user ID the integration options are for","isRequired":true,"uniqueKey":"data.squareOptions.userId","typeLabel":"string"},"requireBillingInformation":{"type":"boolean","description":"Whether to prompt and ask the customer for billing information, reduces conversion and increases anti-fraud\neffectiveness","isRequired":true,"uniqueKey":"data.squareOptions.requireBillingInformation","typeLabel":"boolean"},"applicationId":{"maxLength":256,"minLength":1,"type":"string","description":"Represents the application ID required for Square payment integration.","isRequired":true,"uniqueKey":"data.squareOptions.applicationId","typeLabel":"string"},"locationId":{"maxLength":256,"minLength":1,"type":"string","description":"Represents the location ID associated with the Square integration.","isRequired":true,"uniqueKey":"data.squareOptions.locationId","typeLabel":"string"},"restrictionReason":{"oneOf":[{"maxLength":2048,"type":"string","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.squareOptions.restrictionReason.oneOf.0","typeLabel":"string"},{"maxLength":2048,"type":"null","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.squareOptions.restrictionReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.squareOptions.restrictionReason","typeLabel":"string | null"}},"additionalProperties":false,"description":"Represents configuration options specific to Square integrations.","uniqueKey":"data.squareOptions","typeLabel":"object"},"mollieOptions":{"required":["id","isEnabled","isRestricted","isRiskLocked","profileId","requireBillingInformation","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.mollieOptions.id","typeLabel":"string\u003cuuid>"},"isEnabled":{"type":"boolean","description":"Whether the integration is enabled or not","isRequired":true,"uniqueKey":"data.mollieOptions.isEnabled","typeLabel":"boolean"},"isRestricted":{"type":"boolean","description":"Whether the payment method is restricted from being used by the PSP","isRequired":true,"uniqueKey":"data.mollieOptions.isRestricted","typeLabel":"boolean"},"isRiskLocked":{"type":"boolean","description":"Whether the payment method is restricted for setup by the user due to risk concerns","isRequired":true,"uniqueKey":"data.mollieOptions.isRiskLocked","typeLabel":"boolean"},"userId":{"maxLength":36,"type":"string","description":"The user ID the integration options are for","isRequired":true,"uniqueKey":"data.mollieOptions.userId","typeLabel":"string"},"requireBillingInformation":{"type":"boolean","description":"Whether to prompt and ask the customer for billing information, reduces conversion and increases anti-fraud\neffectiveness","isRequired":true,"uniqueKey":"data.mollieOptions.requireBillingInformation","typeLabel":"boolean"},"profileId":{"maxLength":50,"minLength":1,"type":"string","description":"The ID of the profile on Mollie, for Mollie.js","isRequired":true,"uniqueKey":"data.mollieOptions.profileId","typeLabel":"string"},"restrictionReason":{"oneOf":[{"maxLength":2048,"type":"string","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.mollieOptions.restrictionReason.oneOf.0","typeLabel":"string"},{"maxLength":2048,"type":"null","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.mollieOptions.restrictionReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.mollieOptions.restrictionReason","typeLabel":"string | null"}},"additionalProperties":false,"description":"Configuration options for Mollie integration.","uniqueKey":"data.mollieOptions","typeLabel":"object"},"northbridgeOptions":{"required":["id","isEnabled","isRestricted","isRiskLocked","requireBillingInformation","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.northbridgeOptions.id","typeLabel":"string\u003cuuid>"},"isEnabled":{"type":"boolean","description":"Whether the integration is enabled or not","isRequired":true,"uniqueKey":"data.northbridgeOptions.isEnabled","typeLabel":"boolean"},"isRestricted":{"type":"boolean","description":"Whether the payment method is restricted from being used by the PSP","isRequired":true,"uniqueKey":"data.northbridgeOptions.isRestricted","typeLabel":"boolean"},"isRiskLocked":{"type":"boolean","description":"Whether the payment method is restricted for setup by the user due to risk concerns","isRequired":true,"uniqueKey":"data.northbridgeOptions.isRiskLocked","typeLabel":"boolean"},"userId":{"maxLength":36,"type":"string","description":"The user ID the integration options are for","isRequired":true,"uniqueKey":"data.northbridgeOptions.userId","typeLabel":"string"},"requireBillingInformation":{"type":"boolean","description":"Whether to prompt and ask the customer for billing information, reduces conversion and increases anti-fraud\neffectiveness","isRequired":true,"uniqueKey":"data.northbridgeOptions.requireBillingInformation","typeLabel":"boolean"},"restrictionReason":{"oneOf":[{"maxLength":2048,"type":"string","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.northbridgeOptions.restrictionReason.oneOf.0","typeLabel":"string"},{"maxLength":2048,"type":"null","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.northbridgeOptions.restrictionReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.northbridgeOptions.restrictionReason","typeLabel":"string | null"}},"additionalProperties":false,"description":"Represents the configuration options for Northbridge payment integration.","uniqueKey":"data.northbridgeOptions","typeLabel":"object"},"nmiOptions":{"required":["gatewayUrl","id","isEnabled","isRestricted","isRiskLocked","kountEnabled","publicKey","rejectAvsAddressMismatch","rejectAvsUnavailable","rejectAvsZipMismatch","rejectCvvMismatch","requireBillingInformation","threeDSecureEnabled","threeDSecureRequired","threeDSecureRequireVerified","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.nmiOptions.id","typeLabel":"string\u003cuuid>"},"isEnabled":{"type":"boolean","description":"Whether the integration is enabled or not","isRequired":true,"uniqueKey":"data.nmiOptions.isEnabled","typeLabel":"boolean"},"isRestricted":{"type":"boolean","description":"Whether the payment method is restricted from being used by the PSP","isRequired":true,"uniqueKey":"data.nmiOptions.isRestricted","typeLabel":"boolean"},"isRiskLocked":{"type":"boolean","description":"Whether the payment method is restricted for setup by the user due to risk concerns","isRequired":true,"uniqueKey":"data.nmiOptions.isRiskLocked","typeLabel":"boolean"},"userId":{"maxLength":36,"type":"string","description":"The user ID the integration options are for","isRequired":true,"uniqueKey":"data.nmiOptions.userId","typeLabel":"string"},"requireBillingInformation":{"type":"boolean","description":"Whether to prompt and ask the customer for billing information, reduces conversion and increases anti-fraud\neffectiveness","isRequired":true,"uniqueKey":"data.nmiOptions.requireBillingInformation","typeLabel":"boolean"},"gatewayUrl":{"maxLength":256,"type":"string","description":"The base URL of the NMI gateway (e.g. https://paymentcloud.transactiongateway.com)","isRequired":true,"uniqueKey":"data.nmiOptions.gatewayUrl","typeLabel":"string"},"publicKey":{"maxLength":256,"type":"string","description":"The public key for Collect.js/Gateway.js tokenization and 3DS/Kount\nThis key is used for both data-tokenization-key (Collect.js) and\nGateway.js initialization (for 3DS and Kount)","isRequired":true,"uniqueKey":"data.nmiOptions.publicKey","typeLabel":"string"},"threeDSecureEnabled":{"type":"boolean","description":"Whether 3D Secure is enabled for transactions","isRequired":true,"uniqueKey":"data.nmiOptions.threeDSecureEnabled","typeLabel":"boolean"},"threeDSecureRequired":{"type":"boolean","description":"Refuse a card sale that arrives without payer authentication, rather than merely offering 3D\nSecure to the browser.","isRequired":true,"uniqueKey":"data.nmiOptions.threeDSecureRequired","typeLabel":"boolean"},"threeDSecureRequireVerified":{"type":"boolean","description":"Whether an `attempted` authentication satisfies ThreeDSecureRequired, or\nonly a `verified` one does.","isRequired":true,"uniqueKey":"data.nmiOptions.threeDSecureRequireVerified","typeLabel":"boolean"},"rejectAvsAddressMismatch":{"type":"boolean","description":"Reject transactions where AVS street address does not match (response codes: N, A, W, Z)","isRequired":true,"uniqueKey":"data.nmiOptions.rejectAvsAddressMismatch","typeLabel":"boolean"},"rejectAvsZipMismatch":{"type":"boolean","description":"Reject transactions where AVS zip code does not match (response codes: N, A)","isRequired":true,"uniqueKey":"data.nmiOptions.rejectAvsZipMismatch","typeLabel":"boolean"},"rejectCvvMismatch":{"type":"boolean","description":"Reject transactions where CVV does not match (response codes: N)","isRequired":true,"uniqueKey":"data.nmiOptions.rejectCvvMismatch","typeLabel":"boolean"},"rejectAvsUnavailable":{"type":"boolean","description":"Reject transactions where AVS/CVV is not available or not processed (response codes: U, S, P)","isRequired":true,"uniqueKey":"data.nmiOptions.rejectAvsUnavailable","typeLabel":"boolean"},"kountEnabled":{"type":"boolean","description":"Whether Kount fraud screening is enabled","isRequired":true,"uniqueKey":"data.nmiOptions.kountEnabled","typeLabel":"boolean"},"restrictionReason":{"oneOf":[{"maxLength":2048,"type":"string","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.nmiOptions.restrictionReason.oneOf.0","typeLabel":"string"},{"maxLength":2048,"type":"null","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.nmiOptions.restrictionReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.nmiOptions.restrictionReason","typeLabel":"string | null"},"kountMerchantId":{"oneOf":[{"maxLength":64,"type":"string","description":"The Kount Merchant ID (if using Kount fraud screening)","uniqueKey":"data.nmiOptions.kountMerchantId.oneOf.0","typeLabel":"string"},{"maxLength":64,"type":"null","description":"The Kount Merchant ID (if using Kount fraud screening)","uniqueKey":"data.nmiOptions.kountMerchantId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.nmiOptions.kountMerchantId","typeLabel":"string | null"}},"additionalProperties":false,"description":"NMI (Payment Cloud) integration options for a user","uniqueKey":"data.nmiOptions","typeLabel":"object"},"paddleOptions":{"required":["id","isEnabled","isRestricted","isRiskLocked","requireBillingInformation","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.paddleOptions.id","typeLabel":"string\u003cuuid>"},"isEnabled":{"type":"boolean","description":"Whether the integration is enabled or not","isRequired":true,"uniqueKey":"data.paddleOptions.isEnabled","typeLabel":"boolean"},"isRestricted":{"type":"boolean","description":"Whether the payment method is restricted from being used by the PSP","isRequired":true,"uniqueKey":"data.paddleOptions.isRestricted","typeLabel":"boolean"},"isRiskLocked":{"type":"boolean","description":"Whether the payment method is restricted for setup by the user due to risk concerns","isRequired":true,"uniqueKey":"data.paddleOptions.isRiskLocked","typeLabel":"boolean"},"userId":{"maxLength":36,"type":"string","description":"The user ID the integration options are for","isRequired":true,"uniqueKey":"data.paddleOptions.userId","typeLabel":"string"},"requireBillingInformation":{"type":"boolean","description":"Whether to prompt and ask the customer for billing information, reduces conversion and increases anti-fraud\neffectiveness","isRequired":true,"uniqueKey":"data.paddleOptions.requireBillingInformation","typeLabel":"boolean"},"restrictionReason":{"oneOf":[{"maxLength":2048,"type":"string","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.paddleOptions.restrictionReason.oneOf.0","typeLabel":"string"},{"maxLength":2048,"type":"null","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.paddleOptions.restrictionReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.paddleOptions.restrictionReason","typeLabel":"string | null"}},"additionalProperties":false,"description":"Represents configuration options for the Paddle integration.","uniqueKey":"data.paddleOptions","typeLabel":"object"},"fastSpringOptions":{"required":["id","isEnabled","isRestricted","isRiskLocked","requireBillingInformation","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.fastSpringOptions.id","typeLabel":"string\u003cuuid>"},"isEnabled":{"type":"boolean","description":"Whether the integration is enabled or not","isRequired":true,"uniqueKey":"data.fastSpringOptions.isEnabled","typeLabel":"boolean"},"isRestricted":{"type":"boolean","description":"Whether the payment method is restricted from being used by the PSP","isRequired":true,"uniqueKey":"data.fastSpringOptions.isRestricted","typeLabel":"boolean"},"isRiskLocked":{"type":"boolean","description":"Whether the payment method is restricted for setup by the user due to risk concerns","isRequired":true,"uniqueKey":"data.fastSpringOptions.isRiskLocked","typeLabel":"boolean"},"userId":{"maxLength":36,"type":"string","description":"The user ID the integration options are for","isRequired":true,"uniqueKey":"data.fastSpringOptions.userId","typeLabel":"string"},"requireBillingInformation":{"type":"boolean","description":"Whether to prompt and ask the customer for billing information, reduces conversion and increases anti-fraud\neffectiveness","isRequired":true,"uniqueKey":"data.fastSpringOptions.requireBillingInformation","typeLabel":"boolean"},"restrictionReason":{"oneOf":[{"maxLength":2048,"type":"string","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.fastSpringOptions.restrictionReason.oneOf.0","typeLabel":"string"},{"maxLength":2048,"type":"null","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.fastSpringOptions.restrictionReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.fastSpringOptions.restrictionReason","typeLabel":"string | null"}},"additionalProperties":false,"description":"Represents configuration options for the FastSpring integration.","uniqueKey":"data.fastSpringOptions","typeLabel":"object"},"shopifyOptions":{"required":["id","isEnabled","isRestricted","isRiskLocked","requireBillingInformation","shopUrl","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.shopifyOptions.id","typeLabel":"string\u003cuuid>"},"isEnabled":{"type":"boolean","description":"Whether the integration is enabled or not","isRequired":true,"uniqueKey":"data.shopifyOptions.isEnabled","typeLabel":"boolean"},"isRestricted":{"type":"boolean","description":"Whether the payment method is restricted from being used by the PSP","isRequired":true,"uniqueKey":"data.shopifyOptions.isRestricted","typeLabel":"boolean"},"isRiskLocked":{"type":"boolean","description":"Whether the payment method is restricted for setup by the user due to risk concerns","isRequired":true,"uniqueKey":"data.shopifyOptions.isRiskLocked","typeLabel":"boolean"},"userId":{"maxLength":36,"type":"string","description":"The user ID the integration options are for","isRequired":true,"uniqueKey":"data.shopifyOptions.userId","typeLabel":"string"},"requireBillingInformation":{"type":"boolean","description":"Whether to prompt and ask the customer for billing information, reduces conversion and increases anti-fraud\neffectiveness","isRequired":true,"uniqueKey":"data.shopifyOptions.requireBillingInformation","typeLabel":"boolean"},"shopUrl":{"maxLength":256,"minLength":1,"type":"string","description":"The shop's `*.myshopify.com` domain.","isRequired":true,"uniqueKey":"data.shopifyOptions.shopUrl","typeLabel":"string"},"restrictionReason":{"oneOf":[{"maxLength":2048,"type":"string","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.shopifyOptions.restrictionReason.oneOf.0","typeLabel":"string"},{"maxLength":2048,"type":"null","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.shopifyOptions.restrictionReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.shopifyOptions.restrictionReason","typeLabel":"string | null"}},"additionalProperties":false,"description":"A store's Shopify connection.","uniqueKey":"data.shopifyOptions","typeLabel":"object"},"cryptocurrencyOptions":{"required":["disabledCryptocurrencies","id","isEnabled","isRestricted","isRiskLocked","requireBillingInformation","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.cryptocurrencyOptions.id","typeLabel":"string\u003cuuid>"},"isEnabled":{"type":"boolean","description":"Whether the integration is enabled or not","isRequired":true,"uniqueKey":"data.cryptocurrencyOptions.isEnabled","typeLabel":"boolean"},"isRestricted":{"type":"boolean","description":"Whether the payment method is restricted from being used by the PSP","isRequired":true,"uniqueKey":"data.cryptocurrencyOptions.isRestricted","typeLabel":"boolean"},"isRiskLocked":{"type":"boolean","description":"Whether the payment method is restricted for setup by the user due to risk concerns","isRequired":true,"uniqueKey":"data.cryptocurrencyOptions.isRiskLocked","typeLabel":"boolean"},"userId":{"maxLength":36,"type":"string","description":"The user ID the integration options are for","isRequired":true,"uniqueKey":"data.cryptocurrencyOptions.userId","typeLabel":"string"},"requireBillingInformation":{"type":"boolean","description":"Whether to prompt and ask the customer for billing information, reduces conversion and increases anti-fraud\neffectiveness","isRequired":true,"uniqueKey":"data.cryptocurrencyOptions.requireBillingInformation","typeLabel":"boolean"},"disabledCryptocurrencies":{"type":"array","items":{"type":"string","uniqueKey":"data.cryptocurrencyOptions.disabledCryptocurrencies.items.[INDEX]","typeLabel":"string"},"description":"Coins the merchant has explicitly DISABLED. Under the non-custodial model every coin a configured\nprocessor (Conduit wallet / NOWPayments-BYO) can serve is accepted by default; this opt-out set is\nthe merchant's only per-coin selection. Checkout offers `serveable − DisabledCryptocurrencies`.","isRequired":true,"uniqueKey":"data.cryptocurrencyOptions.disabledCryptocurrencies","typeLabel":"string[]"},"restrictionReason":{"oneOf":[{"maxLength":2048,"type":"string","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.cryptocurrencyOptions.restrictionReason.oneOf.0","typeLabel":"string"},{"maxLength":2048,"type":"null","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.cryptocurrencyOptions.restrictionReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.cryptocurrencyOptions.restrictionReason","typeLabel":"string | null"}},"additionalProperties":false,"description":"The cryptocurrency options for a merchant","uniqueKey":"data.cryptocurrencyOptions","typeLabel":"object"}},"additionalProperties":false,"description":"Represents a user with detailed merchant-related information.","uniqueKey":"data","typeLabel":"object"}},"additionalProperties":false,"description":"Represents a default generic response for API endpoints.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"message":"\u003cstring>","code":"\u003cstring>","data":{"id":"\u003cstring>","dateCreated":"2023-11-07T05:31:56Z","stores":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","name":"\u003cstring>","description":"\u003cstring>","url":"\n store\n ","currencyCode":"\u003cstring>","prependProductNameToReceipt":true,"isAutomaticReviewsEnabled":true,"rating":123,"domain":"\u003cstring>","isCustomerBalanceEnabled":true,"isBalanceTopUpEnabled":true,"isKomerzaPayEnabled":true,"isSplitPaymentEnabled":true,"branding":{"bannerFileName":"\u003cstring>","iconFileName":"\u003cstring>","accentColor":"\u003cstring>"},"isTicketingEnabled":true,"isDownloadCenterEnabled":true,"showPublicStats":true,"showRecentOrderToasts":true,"enableCartRecovery":true,"isInactive":true,"googleSiteVerification":"\u003cstring>","customDomain":"\u003cstring>","scopes":["\u003cstring>"],"maintenanceReason":"\u003cstring>","termsOfServiceUrl":"\u003cstring>","refundPolicyUrl":"\u003cstring>","privacyPolicyUrl":"\u003cstring>","affiliateOptions":{"isEnabled":true,"defaultReturnPercentage":50,"canConvertAffiliateBalance":true,"isPublicRegistrationEnabled":true,"isLinkEditingEnabled":true,"defaultPercentageOff":50},"externalSupportUrl":"\u003cstring>","externalSupportDescription":"\u003cstring>","lastOrderAt":"2023-11-07T05:31:56Z"}],"email":"\u003cstring>","userName":"\u003cstring>","plan":"\u003cstring>","isBuyerProtectionManager":true,"twoFactorEnabled":true,"totpEnabled":true,"passkeyEnabled":true,"riskLocked":true,"billingSuspended":true,"integrations":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","application":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","name":"\u003cstring>","permissions":["\u003cstring>"],"redirectUrls":["\u003cstring>"],"userId":"\u003cstring>","imageName":"\u003cstring>","termsOfServiceLink":"\u003cstring>","privacyPolicyLink":"\u003cstring>"}}],"apiKeys":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","label":"\u003cstring>","ipAddresses":["\u003cstring>"],"scopes":["\u003cstring>"],"userId":"\u003cstring>"}],"disabledPaymentMethods":{},"stripeEnabled":true,"nmiEnabled":true,"moneyMotionEnabled":true,"pandabaseEnabled":true,"shopifyEnabled":true,"storrikEnabled":true,"mollieEnabled":true,"northbridgeEnabled":true,"squareEnabled":true,"paypalBusinessEnabled":true,"isCryptoEnabled":true,"isSumUpEnabled":true,"paddleEnabled":true,"fastSpringEnabled":true,"venPayrEnabled":true,"ovgcEnabled":true,"isAuthorizeNetEnabled":true,"restrictedPaymentMethods":["\u003cstring>"],"riskLockedPaymentMethods":["\u003cstring>"],"integrationErrorReports":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","reason":"\u003cstring>","gateway":"\u003cstring>","reporter":"\u003cstring>","resolved":true,"type":"\u003cstring>","userId":"\u003cstring>"}],"lastPasswordUpdate":"2023-11-07T05:31:56Z","signals":{"countryCode":"\u003cstring>","id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","userId":"\u003cstring>","registrationIpAddress":"\u003cstring>","registrationFingerprint":"\u003cstring>","verificationStatus":"\u003cstring>","legalEntityType":"\u003cstring>","taxId":"\u003cstring>","fullName":"\u003cstring>","addressLine1":"\u003cstring>","addressLine2":"\u003cstring>","city":"\u003cstring>","region":"\u003cstring>","postalCode":"\u003cstring>"},"discordWebhookUrl":"\u003cstring>","subscription":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","expiryDate":"2023-12-25","autoRenew":true,"userId":"\u003cstring>","billingInterval":"\u003cstring>","failedPaymentCount":123,"lastSyncedAt":"2023-11-07T05:31:56Z","customerIds":{},"emailMarketingSent":123,"isExpired":true,"startedDate":"2023-12-25","status":"\u003cstring>","trialEndDate":"2023-12-25","planId":"\u003cstring>","lastPaymentFailureDate":"2023-11-07T05:31:56Z","nextRetryDate":"2023-12-25","cancelAt":"2023-11-07T05:31:56Z","canceledAt":"2023-11-07T05:31:56Z","scheduledPlanId":"\u003cstring>","scheduledBillingInterval":"\u003cstring>","lastExpiryReminderDate":"2023-12-25","emailMarketingQuotaResetAt":"2023-11-07T05:31:56Z"},"refreshAt":"2023-11-07T05:31:56Z","billingSuspensionDate":"2023-11-07T05:31:56Z","cashAppOptions":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","isEnabled":true,"isRestricted":true,"isRiskLocked":true,"userId":"\u003cstring>","requireBillingInformation":true,"isAcceptingRequests":true,"notesVersion":0,"restrictionReason":"\u003cstring>","email":"\u003cstring>","tag":"\u003cstring>","customNoteListId":"3c90c3cc-0d44-4b50-8888-8dd25736052a"},"payPalOptions":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","isEnabled":true,"isRestricted":true,"isRiskLocked":true,"userId":"\u003cstring>","requireBillingInformation":true,"isUsingLegacyEmails":true,"isFriendsAndFamilyEnabled":true,"isAcceptingRequests":true,"isAcceptingHeldPayments":true,"notesVersion":0,"restrictionReason":"\u003cstring>","email":"\u003cstring>","payPalEmail":"\u003cstring>","customNoteListId":"3c90c3cc-0d44-4b50-8888-8dd25736052a"},"storrikOptions":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","isEnabled":true,"isRestricted":true,"isRiskLocked":true,"userId":"\u003cstring>","requireBillingInformation":true,"restrictionReason":"\u003cstring>"},"payPalBusinessOptions":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","isEnabled":true,"isRestricted":true,"isRiskLocked":true,"userId":"\u003cstring>","requireBillingInformation":true,"isUsingLegacyIntegration":true,"forceCardOnly":true,"restrictionReason":"\u003cstring>","oAuthClientId":"\u003cstring>","emailAddress":"\u003cstring>"},"stripeOptions":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","isEnabled":true,"isRestricted":true,"isRiskLocked":true,"userId":"\u003cstring>","requireBillingInformation":true,"restrictionReason":"\u003cstring>","paymentMethodConfigurationId":"\u003cstring>","publishableKey":"\u003cstring>"},"squareOptions":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","isEnabled":true,"isRestricted":true,"isRiskLocked":true,"userId":"\u003cstring>","requireBillingInformation":true,"applicationId":"\u003cstring>","locationId":"\u003cstring>","restrictionReason":"\u003cstring>"},"mollieOptions":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","isEnabled":true,"isRestricted":true,"isRiskLocked":true,"userId":"\u003cstring>","requireBillingInformation":true,"profileId":"\u003cstring>","restrictionReason":"\u003cstring>"},"northbridgeOptions":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","isEnabled":true,"isRestricted":true,"isRiskLocked":true,"userId":"\u003cstring>","requireBillingInformation":true,"restrictionReason":"\u003cstring>"},"nmiOptions":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","isEnabled":true,"isRestricted":true,"isRiskLocked":true,"userId":"\u003cstring>","requireBillingInformation":true,"gatewayUrl":"\u003cstring>","publicKey":"\u003cstring>","threeDSecureEnabled":true,"threeDSecureRequired":true,"threeDSecureRequireVerified":true,"rejectAvsAddressMismatch":true,"rejectAvsZipMismatch":true,"rejectCvvMismatch":true,"rejectAvsUnavailable":true,"kountEnabled":true,"restrictionReason":"\u003cstring>","kountMerchantId":"\u003cstring>"},"paddleOptions":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","isEnabled":true,"isRestricted":true,"isRiskLocked":true,"userId":"\u003cstring>","requireBillingInformation":true,"restrictionReason":"\u003cstring>"},"fastSpringOptions":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","isEnabled":true,"isRestricted":true,"isRiskLocked":true,"userId":"\u003cstring>","requireBillingInformation":true,"restrictionReason":"\u003cstring>"},"shopifyOptions":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","isEnabled":true,"isRestricted":true,"isRiskLocked":true,"userId":"\u003cstring>","requireBillingInformation":true,"shopUrl":"\u003cstring>","restrictionReason":"\u003cstring>"},"cryptocurrencyOptions":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","isEnabled":true,"isRestricted":true,"isRiskLocked":true,"userId":"\u003cstring>","requireBillingInformation":true,"disabledCryptocurrencies":["\u003cstring>"],"restrictionReason":"\u003cstring>"}}}}},"exampleType":"generated"},"text/json":{"schema":{"required":["success"],"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the operation or response was successful.","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"oneOf":[{"type":"string","description":"A descriptive message providing additional context or information about the response.","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"A descriptive message providing additional context or information about the response.","uniqueKey":"message.oneOf.1","typeLabel":"null"}],"uniqueKey":"message","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","description":"The error code (if there was an error) to use when referencing the error","uniqueKey":"code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The error code (if there was an error) to use when referencing the error","uniqueKey":"code.oneOf.1","typeLabel":"null"}],"uniqueKey":"code","typeLabel":"string | null"},"data":{"required":["apiKeys","billingSuspended","dateCreated","disabledPaymentMethods","email","fastSpringEnabled","id","integrationErrorReports","integrations","isAuthorizeNetEnabled","isBuyerProtectionManager","isCryptoEnabled","isSumUpEnabled","lastPasswordUpdate","mollieEnabled","moneyMotionEnabled","nmiEnabled","northbridgeEnabled","ovgcEnabled","paddleEnabled","pandabaseEnabled","passkeyEnabled","paypalBusinessEnabled","plan","restrictedPaymentMethods","riskLocked","riskLockedPaymentMethods","shopifyEnabled","squareEnabled","stores","storrikEnabled","stripeEnabled","totpEnabled","twoFactorEnabled","userName","venPayrEnabled"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the user.","isRequired":true,"uniqueKey":"data.id","typeLabel":"string"},"dateCreated":{"type":"string","description":"The date the entity was created","format":"date-time","isRequired":true,"uniqueKey":"data.dateCreated","typeLabel":"string\u003cdate-time>"},"stores":{"type":"array","items":{"required":["branding","currencyCode","dateCreated","description","domain","enableCartRecovery","id","isAutomaticReviewsEnabled","isBalanceTopUpEnabled","isCustomerBalanceEnabled","isDownloadCenterEnabled","isInactive","isKomerzaPayEnabled","isSplitPaymentEnabled","isTicketingEnabled","name","prependProductNameToReceipt","rating","showPublicStats","showRecentOrderToasts","url"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created","format":"date-time","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].dateCreated","typeLabel":"string\u003cdate-time>"},"name":{"type":"string","description":"The name of the store","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].name","typeLabel":"string"},"description":{"type":"string","description":"The description of the store, shown on their about page and on the home of their store page","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].description","typeLabel":"string"},"url":{"type":"string","description":"The subdomain for the store, ONLY the subdomain, not the fully qualified domain","example":"\n store\n ","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].url","typeLabel":"string"},"currencyCode":{"type":"string","description":"The stores preferred currency","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].currencyCode","typeLabel":"string"},"prependProductNameToReceipt":{"type":"boolean","description":"Whether the name of the product should be prepended to the start of delivery receipts to customers","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].prependProductNameToReceipt","typeLabel":"boolean"},"isAutomaticReviewsEnabled":{"type":"boolean","description":"Whether automatic review leaving is enabled","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].isAutomaticReviewsEnabled","typeLabel":"boolean"},"rating":{"type":"number","description":"The combined average rating for all their products","format":"double","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].rating","typeLabel":"number\u003cdouble>"},"domain":{"type":"string","description":"The domain the store is associated with","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].domain","typeLabel":"string"},"isCustomerBalanceEnabled":{"type":"boolean","description":"Whether the customer balance system is enabled on the stores","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].isCustomerBalanceEnabled","typeLabel":"boolean"},"isBalanceTopUpEnabled":{"type":"boolean","description":"Whether customers can top up their store balance using any enabled payment method.","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].isBalanceTopUpEnabled","typeLabel":"boolean"},"isKomerzaPayEnabled":{"type":"boolean","description":"Whether this store accepts Komerza Pay.\n\nPer store rather than per user, unlike every other gateway: one verified legal entity may\n own several stores and switch them on individually, because enabling it makes Komerza the\n merchant of record for that store's orders.","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].isKomerzaPayEnabled","typeLabel":"boolean"},"isSplitPaymentEnabled":{"type":"boolean","description":"Whether customers can pay for an order partly with their store balance and the remainder\nwith another payment method.","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].isSplitPaymentEnabled","typeLabel":"boolean"},"branding":{"type":"object","properties":{"bannerFileName":{"oneOf":[{"maxLength":64,"type":"string","description":"Represents the file name of the banner associated with the checkout options.","uniqueKey":"data.stores.items.[INDEX].branding.bannerFileName.oneOf.0","typeLabel":"string"},{"maxLength":64,"type":"null","description":"Represents the file name of the banner associated with the checkout options.","uniqueKey":"data.stores.items.[INDEX].branding.bannerFileName.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stores.items.[INDEX].branding.bannerFileName","typeLabel":"string | null"},"iconFileName":{"oneOf":[{"maxLength":64,"type":"string","description":"The icon file name, used for favicon","uniqueKey":"data.stores.items.[INDEX].branding.iconFileName.oneOf.0","typeLabel":"string"},{"maxLength":64,"type":"null","description":"The icon file name, used for favicon","uniqueKey":"data.stores.items.[INDEX].branding.iconFileName.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stores.items.[INDEX].branding.iconFileName","typeLabel":"string | null"},"accentColor":{"oneOf":[{"maxLength":9,"type":"string","description":"Represents the accent color used in the checkout options.","uniqueKey":"data.stores.items.[INDEX].branding.accentColor.oneOf.0","typeLabel":"string"},{"maxLength":9,"type":"null","description":"Represents the accent color used in the checkout options.","uniqueKey":"data.stores.items.[INDEX].branding.accentColor.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stores.items.[INDEX].branding.accentColor","typeLabel":"string | null"}},"additionalProperties":false,"description":"Represents the configurable branding options for a store.","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].branding","typeLabel":"object"},"isTicketingEnabled":{"type":"boolean","description":"Whether the built-in support ticket system is enabled for customers","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].isTicketingEnabled","typeLabel":"boolean"},"isDownloadCenterEnabled":{"type":"boolean","description":"Whether the store offers a download centre to its customers.","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].isDownloadCenterEnabled","typeLabel":"boolean"},"showPublicStats":{"type":"boolean","description":"Whether anonymized public statistics are shown to buyers on the storefront.","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].showPublicStats","typeLabel":"boolean"},"showRecentOrderToasts":{"type":"boolean","description":"Whether recent order toast notifications are shown to visitors on the storefront.","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].showRecentOrderToasts","typeLabel":"boolean"},"enableCartRecovery":{"type":"boolean","description":"Whether abandoned cart recovery emails are enabled for this store.","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].enableCartRecovery","typeLabel":"boolean"},"isInactive":{"type":"boolean","description":"Whether the store is inactive","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].isInactive","typeLabel":"boolean"},"googleSiteVerification":{"oneOf":[{"type":"string","description":"Google Search Console site-verification token, or null. Rendered by the router as a\n\u003cmeta name=\"google-site-verification\"> tag. Public by design — it appears on\nevery rendered page — so exposing it here is not a disclosure.","uniqueKey":"data.stores.items.[INDEX].googleSiteVerification.oneOf.0","typeLabel":"string"},{"type":"null","description":"Google Search Console site-verification token, or null. Rendered by the router as a\n\u003cmeta name=\"google-site-verification\"> tag. Public by design — it appears on\nevery rendered page — so exposing it here is not a disclosure.","uniqueKey":"data.stores.items.[INDEX].googleSiteVerification.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stores.items.[INDEX].googleSiteVerification","typeLabel":"string | null"},"customDomain":{"oneOf":[{"type":"string","description":"The custom domain set for the store, will be null if not set","uniqueKey":"data.stores.items.[INDEX].customDomain.oneOf.0","typeLabel":"string"},{"type":"null","description":"The custom domain set for the store, will be null if not set","uniqueKey":"data.stores.items.[INDEX].customDomain.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stores.items.[INDEX].customDomain","typeLabel":"string | null"},"scopes":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"data.stores.items.[INDEX].scopes.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"The permission scopes that the current user can use for the store, only returned on the /user endpoint for stores\nvisible due to team permissions, will also be null on /user if the store is owned by the user and therefore has\nevery (permissions)","uniqueKey":"data.stores.items.[INDEX].scopes.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"The permission scopes that the current user can use for the store, only returned on the /user endpoint for stores\nvisible due to team permissions, will also be null on /user if the store is owned by the user and therefore has\nevery (permissions)","uniqueKey":"data.stores.items.[INDEX].scopes.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stores.items.[INDEX].scopes","typeLabel":"string[] | null"},"maintenanceReason":{"oneOf":[{"type":"string","description":"The reason the store is in maintenance, if this is null then the store is not in maintenance mode","uniqueKey":"data.stores.items.[INDEX].maintenanceReason.oneOf.0","typeLabel":"string"},{"type":"null","description":"The reason the store is in maintenance, if this is null then the store is not in maintenance mode","uniqueKey":"data.stores.items.[INDEX].maintenanceReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stores.items.[INDEX].maintenanceReason","typeLabel":"string | null"},"termsOfServiceUrl":{"oneOf":[{"type":"string","description":"The URL to the store's terms of service page","uniqueKey":"data.stores.items.[INDEX].termsOfServiceUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"The URL to the store's terms of service page","uniqueKey":"data.stores.items.[INDEX].termsOfServiceUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stores.items.[INDEX].termsOfServiceUrl","typeLabel":"string | null"},"refundPolicyUrl":{"oneOf":[{"type":"string","description":"The URL to the store's refund policy page","uniqueKey":"data.stores.items.[INDEX].refundPolicyUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"The URL to the store's refund policy page","uniqueKey":"data.stores.items.[INDEX].refundPolicyUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stores.items.[INDEX].refundPolicyUrl","typeLabel":"string | null"},"privacyPolicyUrl":{"oneOf":[{"type":"string","description":"The URL to the store's privacy policy page","uniqueKey":"data.stores.items.[INDEX].privacyPolicyUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"The URL to the store's privacy policy page","uniqueKey":"data.stores.items.[INDEX].privacyPolicyUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stores.items.[INDEX].privacyPolicyUrl","typeLabel":"string | null"},"affiliateOptions":{"required":["canConvertAffiliateBalance","defaultReturnPercentage","isEnabled","isLinkEditingEnabled","isPublicRegistrationEnabled"],"type":"object","properties":{"isEnabled":{"type":"boolean","description":"Determines if the affiliate settings are active for the store.","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].affiliateOptions.isEnabled","typeLabel":"boolean"},"defaultReturnPercentage":{"maximum":100,"minimum":0,"type":"integer","description":"Specifies the default return percentage for affiliates within a store, ranging from 0 to 100.","format":"int32","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].affiliateOptions.defaultReturnPercentage","typeLabel":"integer\u003cint32>"},"canConvertAffiliateBalance":{"type":"boolean","description":"Whether the store allows affiliate balance to be converted into customer balance to be used on the store, when\nenabled any affiliate can convert their affiliate balance into customer balance automatically","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].affiliateOptions.canConvertAffiliateBalance","typeLabel":"boolean"},"isPublicRegistrationEnabled":{"type":"boolean","description":"Determines whether public registration is enabled for affiliates within the store.","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].affiliateOptions.isPublicRegistrationEnabled","typeLabel":"boolean"},"isLinkEditingEnabled":{"type":"boolean","description":"Indicates whether link editing capabilities are enabled within the affiliate options for a store.","isRequired":true,"uniqueKey":"data.stores.items.[INDEX].affiliateOptions.isLinkEditingEnabled","typeLabel":"boolean"},"defaultPercentageOff":{"oneOf":[{"maximum":100,"minimum":0,"type":"integer","description":"Represents the default percentage off value used in affiliate settings, where the value must be between 0 and 100.","format":"int32","uniqueKey":"data.stores.items.[INDEX].affiliateOptions.defaultPercentageOff.oneOf.0","typeLabel":"integer\u003cint32>"},{"maximum":100,"minimum":0,"type":"null","description":"Represents the default percentage off value used in affiliate settings, where the value must be between 0 and 100.","format":"int32","uniqueKey":"data.stores.items.[INDEX].affiliateOptions.defaultPercentageOff.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stores.items.[INDEX].affiliateOptions.defaultPercentageOff","typeLabel":"integer\u003cint32> | null"}},"additionalProperties":false,"description":"Represents the configuration options for affiliate settings in a store.","uniqueKey":"data.stores.items.[INDEX].affiliateOptions","typeLabel":"object"},"externalSupportUrl":{"oneOf":[{"type":"string","description":"The URL to direct customers to for external support when ticketing is disabled","uniqueKey":"data.stores.items.[INDEX].externalSupportUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"The URL to direct customers to for external support when ticketing is disabled","uniqueKey":"data.stores.items.[INDEX].externalSupportUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stores.items.[INDEX].externalSupportUrl","typeLabel":"string | null"},"externalSupportDescription":{"oneOf":[{"type":"string","description":"A description shown to customers explaining where to get support when ticketing is disabled","uniqueKey":"data.stores.items.[INDEX].externalSupportDescription.oneOf.0","typeLabel":"string"},{"type":"null","description":"A description shown to customers explaining where to get support when ticketing is disabled","uniqueKey":"data.stores.items.[INDEX].externalSupportDescription.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stores.items.[INDEX].externalSupportDescription","typeLabel":"string | null"},"lastOrderAt":{"oneOf":[{"type":"string","description":"The timestamp of the last order created for this store","format":"date-time","uniqueKey":"data.stores.items.[INDEX].lastOrderAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The timestamp of the last order created for this store","format":"date-time","uniqueKey":"data.stores.items.[INDEX].lastOrderAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stores.items.[INDEX].lastOrderAt","typeLabel":"string\u003cdate-time> | null"}},"additionalProperties":false,"description":"A reference to a store which is owned by a merchant that can be used as a front for selling products to customers","uniqueKey":"data.stores.items.[INDEX]","typeLabel":"object"},"description":"Represents the collection of store references associated with a user.","isRequired":true,"uniqueKey":"data.stores","typeLabel":"object[]"},"email":{"type":"string","description":"The user's email address.","isRequired":true,"uniqueKey":"data.email","typeLabel":"string"},"userName":{"type":"string","description":"The username of the user.","isRequired":true,"uniqueKey":"data.userName","typeLabel":"string"},"plan":{"type":"string","description":"The user's subscription plan.","isRequired":true,"uniqueKey":"data.plan","typeLabel":"string"},"isBuyerProtectionManager":{"type":"boolean","description":"Whether the user has been granted the narrowly-scoped Buyer Protection Manager staff role,\nwhich grants access to the Buyer Protection admin surface only. Independent of Plan,\nwhich by design never reflects this role (see BuyerProtectionManager).","isRequired":true,"uniqueKey":"data.isBuyerProtectionManager","typeLabel":"boolean"},"twoFactorEnabled":{"type":"boolean","description":"Indicates whether two-factor authentication is enabled for the user.","isRequired":true,"uniqueKey":"data.twoFactorEnabled","typeLabel":"boolean"},"totpEnabled":{"type":"boolean","description":"Indicates whether TOTP (authenticator app) two-factor authentication is enabled.","isRequired":true,"uniqueKey":"data.totpEnabled","typeLabel":"boolean"},"passkeyEnabled":{"type":"boolean","description":"Indicates whether passkey two-factor authentication is enabled.","isRequired":true,"uniqueKey":"data.passkeyEnabled","typeLabel":"boolean"},"riskLocked":{"type":"boolean","description":"Whether their account is locked due to being too high risk","isRequired":true,"uniqueKey":"data.riskLocked","typeLabel":"boolean"},"billingSuspended":{"type":"boolean","description":"Whether the user is suspended due to failed payments.","isRequired":true,"uniqueKey":"data.billingSuspended","typeLabel":"boolean"},"integrations":{"type":"array","items":{"required":["application","dateCreated","id"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.integrations.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created","format":"date-time","isRequired":true,"uniqueKey":"data.integrations.items.[INDEX].dateCreated","typeLabel":"string\u003cdate-time>"},"application":{"required":["dateCreated","id","name","permissions","redirectUrls","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.integrations.items.[INDEX].application.id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created","format":"date-time","isRequired":true,"uniqueKey":"data.integrations.items.[INDEX].application.dateCreated","typeLabel":"string\u003cdate-time>"},"name":{"maxLength":100,"minLength":2,"type":"string","description":"The name of the application","isRequired":true,"uniqueKey":"data.integrations.items.[INDEX].application.name","typeLabel":"string"},"permissions":{"type":"array","items":{"type":"string","uniqueKey":"data.integrations.items.[INDEX].application.permissions.items.[INDEX]","typeLabel":"string"},"description":"The list of permissions the application requires","isRequired":true,"uniqueKey":"data.integrations.items.[INDEX].application.permissions","typeLabel":"string[]"},"redirectUrls":{"type":"array","items":{"type":"string","uniqueKey":"data.integrations.items.[INDEX].application.redirectUrls.items.[INDEX]","typeLabel":"string"},"description":"The list of redirect URLs that are authorized for the application","isRequired":true,"uniqueKey":"data.integrations.items.[INDEX].application.redirectUrls","typeLabel":"string[]"},"userId":{"type":"string","description":"The ID of the user who owns the application","isRequired":true,"uniqueKey":"data.integrations.items.[INDEX].application.userId","typeLabel":"string"},"imageName":{"oneOf":[{"type":"string","description":"The name of the image to show for the application","uniqueKey":"data.integrations.items.[INDEX].application.imageName.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name of the image to show for the application","uniqueKey":"data.integrations.items.[INDEX].application.imageName.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.integrations.items.[INDEX].application.imageName","typeLabel":"string | null"},"termsOfServiceLink":{"oneOf":[{"maxLength":2000,"type":"string","description":"The link to the application's terms of service","uniqueKey":"data.integrations.items.[INDEX].application.termsOfServiceLink.oneOf.0","typeLabel":"string"},{"maxLength":2000,"type":"null","description":"The link to the application's terms of service","uniqueKey":"data.integrations.items.[INDEX].application.termsOfServiceLink.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.integrations.items.[INDEX].application.termsOfServiceLink","typeLabel":"string | null"},"privacyPolicyLink":{"oneOf":[{"maxLength":2000,"type":"string","description":"The link to the application's privacy policy","uniqueKey":"data.integrations.items.[INDEX].application.privacyPolicyLink.oneOf.0","typeLabel":"string"},{"maxLength":2000,"type":"null","description":"The link to the application's privacy policy","uniqueKey":"data.integrations.items.[INDEX].application.privacyPolicyLink.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.integrations.items.[INDEX].application.privacyPolicyLink","typeLabel":"string | null"}},"additionalProperties":false,"description":"An application to use for OAuth2","isRequired":true,"uniqueKey":"data.integrations.items.[INDEX].application","typeLabel":"object"}},"additionalProperties":false,"description":"Represents an OAuth integration for a specific OAuth2 application.\nThis class is used to expose integration information to the public in a controlled manner.","uniqueKey":"data.integrations.items.[INDEX]","typeLabel":"object"},"description":"A list of connected OAuth integrations for the user.","isRequired":true,"uniqueKey":"data.integrations","typeLabel":"object[]"},"apiKeys":{"type":"array","items":{"required":["dateCreated","id","ipAddresses","label","scopes","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.apiKeys.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created in the database","format":"date-time","isRequired":true,"uniqueKey":"data.apiKeys.items.[INDEX].dateCreated","typeLabel":"string\u003cdate-time>"},"label":{"maxLength":64,"minLength":1,"type":"string","description":"Represents a descriptive or identifiable name assigned to the API key","isRequired":true,"uniqueKey":"data.apiKeys.items.[INDEX].label","typeLabel":"string"},"ipAddresses":{"type":"array","items":{"type":"string","uniqueKey":"data.apiKeys.items.[INDEX].ipAddresses.items.[INDEX]","typeLabel":"string"},"description":"The list of IP addresses which are allowed to access the API","isRequired":true,"uniqueKey":"data.apiKeys.items.[INDEX].ipAddresses","typeLabel":"string[]"},"scopes":{"type":"array","items":{"type":"string","uniqueKey":"data.apiKeys.items.[INDEX].scopes.items.[INDEX]","typeLabel":"string"},"description":"The list of scopes the API key is allowed to access","isRequired":true,"uniqueKey":"data.apiKeys.items.[INDEX].scopes","typeLabel":"string[]"},"userId":{"maxLength":36,"minLength":1,"type":"string","description":"The identifier of the user associated with the API key","isRequired":true,"uniqueKey":"data.apiKeys.items.[INDEX].userId","typeLabel":"string"}},"additionalProperties":false,"description":"Represents an API key associated with a merchant's account, used for identifying and authenticating requests.","uniqueKey":"data.apiKeys.items.[INDEX]","typeLabel":"object"},"description":"The API keys associated with the user.","isRequired":true,"uniqueKey":"data.apiKeys","typeLabel":"object[]"},"disabledPaymentMethods":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"data.disabledPaymentMethods.additionalProperties","typeLabel":"string"},"description":"A collection of payment methods that are disabled for the user.","isRequired":true,"uniqueKey":"data.disabledPaymentMethods","typeLabel":"object"},"stripeEnabled":{"type":"boolean","description":"Indicates whether Stripe integration is enabled for the user.","isRequired":true,"uniqueKey":"data.stripeEnabled","typeLabel":"boolean"},"nmiEnabled":{"type":"boolean","description":"Indicates whether NMI is enabled for the user.","isRequired":true,"uniqueKey":"data.nmiEnabled","typeLabel":"boolean"},"moneyMotionEnabled":{"type":"boolean","description":"Indicates whether moneymotion is enabled for the user.","isRequired":true,"uniqueKey":"data.moneyMotionEnabled","typeLabel":"boolean"},"pandabaseEnabled":{"type":"boolean","description":"Indicates whether the Pandabase integration is enabled for the user.","isRequired":true,"uniqueKey":"data.pandabaseEnabled","typeLabel":"boolean"},"shopifyEnabled":{"type":"boolean","description":"Indicates whether the Shopify integration is enabled for the user.","isRequired":true,"uniqueKey":"data.shopifyEnabled","typeLabel":"boolean"},"storrikEnabled":{"type":"boolean","description":"Indicates whether Storrik integration is enabled for the user.","isRequired":true,"uniqueKey":"data.storrikEnabled","typeLabel":"boolean"},"mollieEnabled":{"type":"boolean","description":"Indicates whether Mollie integration is enabled for the user.","isRequired":true,"uniqueKey":"data.mollieEnabled","typeLabel":"boolean"},"northbridgeEnabled":{"type":"boolean","description":"Indicates whether Northbridge integration is enabled for the user.","isRequired":true,"uniqueKey":"data.northbridgeEnabled","typeLabel":"boolean"},"squareEnabled":{"type":"boolean","description":"Indicates whether Square integration is enabled for the user.","isRequired":true,"uniqueKey":"data.squareEnabled","typeLabel":"boolean"},"paypalBusinessEnabled":{"type":"boolean","description":"Indicates whether PayPal Business integration is enabled for the user.","isRequired":true,"uniqueKey":"data.paypalBusinessEnabled","typeLabel":"boolean"},"isCryptoEnabled":{"type":"boolean","description":"Indicates whether cryptocurrency integration is enabled for the user.","isRequired":true,"uniqueKey":"data.isCryptoEnabled","typeLabel":"boolean"},"isSumUpEnabled":{"type":"boolean","description":"Indicates whether the SumUp integration is enabled for the user.","isRequired":true,"uniqueKey":"data.isSumUpEnabled","typeLabel":"boolean"},"paddleEnabled":{"type":"boolean","description":"Indicates whether Paddle integration is enabled for the user.","isRequired":true,"uniqueKey":"data.paddleEnabled","typeLabel":"boolean"},"fastSpringEnabled":{"type":"boolean","description":"Indicates whether FastSpring integration is enabled for the user.","isRequired":true,"uniqueKey":"data.fastSpringEnabled","typeLabel":"boolean"},"venPayrEnabled":{"type":"boolean","description":"Whether the user has access to the VenPayr gateway.","isRequired":true,"uniqueKey":"data.venPayrEnabled","typeLabel":"boolean"},"ovgcEnabled":{"type":"boolean","description":"Indicates whether OVGC Payments integration is enabled for the user.","isRequired":true,"uniqueKey":"data.ovgcEnabled","typeLabel":"boolean"},"isAuthorizeNetEnabled":{"type":"boolean","description":"Indicates whether Authorize.Net payment integration is enabled for the user.","isRequired":true,"uniqueKey":"data.isAuthorizeNetEnabled","typeLabel":"boolean"},"restrictedPaymentMethods":{"type":"array","items":{"type":"string","uniqueKey":"data.restrictedPaymentMethods.items.[INDEX]","typeLabel":"string"},"description":"The list of payment methods which are restricted for the user.","isRequired":true,"uniqueKey":"data.restrictedPaymentMethods","typeLabel":"string[]"},"riskLockedPaymentMethods":{"type":"array","items":{"type":"string","uniqueKey":"data.riskLockedPaymentMethods.items.[INDEX]","typeLabel":"string"},"description":"The list of payment methods which are risk locked for the user.","isRequired":true,"uniqueKey":"data.riskLockedPaymentMethods","typeLabel":"string[]"},"integrationErrorReports":{"type":"array","items":{"required":["dateCreated","gateway","id","reason","reporter","resolved","type","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.integrationErrorReports.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created in the database","format":"date-time","isRequired":true,"uniqueKey":"data.integrationErrorReports.items.[INDEX].dateCreated","typeLabel":"string\u003cdate-time>"},"reason":{"maxLength":1024,"minLength":3,"type":"string","description":"The reason for the report","isRequired":true,"uniqueKey":"data.integrationErrorReports.items.[INDEX].reason","typeLabel":"string"},"gateway":{"maxLength":64,"minLength":1,"type":"string","description":"The ID of the payment gateway that has the error","isRequired":true,"uniqueKey":"data.integrationErrorReports.items.[INDEX].gateway","typeLabel":"string"},"reporter":{"maxLength":128,"minLength":1,"type":"string","description":"The hostname of the server which reported the issue","isRequired":true,"uniqueKey":"data.integrationErrorReports.items.[INDEX].reporter","typeLabel":"string"},"resolved":{"type":"boolean","description":"Whether the report has been acknowledged and resolved - therefore should not be shown","isRequired":true,"uniqueKey":"data.integrationErrorReports.items.[INDEX].resolved","typeLabel":"boolean"},"type":{"maxLength":256,"minLength":3,"type":"string","description":"The ID/type of report that specifically identifies the detected issue","isRequired":true,"uniqueKey":"data.integrationErrorReports.items.[INDEX].type","typeLabel":"string"},"userId":{"maxLength":36,"type":"string","description":"The user who the report is for (automatically done by EF core)","isRequired":true,"uniqueKey":"data.integrationErrorReports.items.[INDEX].userId","typeLabel":"string"}},"additionalProperties":false,"description":"Represents a report by an integration that defines that a misconfiguration was detected that may cause issues","uniqueKey":"data.integrationErrorReports.items.[INDEX]","typeLabel":"object"},"description":"A collection of error reports related to integrations.","isRequired":true,"uniqueKey":"data.integrationErrorReports","typeLabel":"object[]"},"lastPasswordUpdate":{"type":"string","description":"The timestamp of the user's last password update.","format":"date-time","isRequired":true,"uniqueKey":"data.lastPasswordUpdate","typeLabel":"string\u003cdate-time>"},"signals":{"required":["countryCode","dateCreated","id","registrationFingerprint","registrationIpAddress","userId","verificationStatus"],"type":"object","properties":{"countryCode":{"maxLength":2,"minLength":1,"pattern":"^[A-Z]{2}$","type":"string","description":"The ISO 3166-1 alpha-2 country code associated with the address.\nExamples: \"US\" for the United States, \"CA\" for Canada.","isRequired":true,"uniqueKey":"data.signals.countryCode","typeLabel":"string"},"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.signals.id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created in the database","format":"date-time","isRequired":true,"uniqueKey":"data.signals.dateCreated","typeLabel":"string\u003cdate-time>"},"userId":{"maxLength":36,"minLength":1,"type":"string","description":"The ID of the user the KYC info belongs to","isRequired":true,"uniqueKey":"data.signals.userId","typeLabel":"string"},"registrationIpAddress":{"maxLength":45,"type":"string","description":"Gets or sets the IP address that was used to create the merchant","isRequired":true,"uniqueKey":"data.signals.registrationIpAddress","typeLabel":"string"},"registrationFingerprint":{"maxLength":256,"type":"string","description":"The browser/device-specific fingerprint captured during user registration for identity verification.","isRequired":true,"uniqueKey":"data.signals.registrationFingerprint","typeLabel":"string"},"verificationStatus":{"maxLength":30,"minLength":1,"type":"string","description":"The current verification status of the merchant's KYC process.","isRequired":true,"uniqueKey":"data.signals.verificationStatus","typeLabel":"string"},"legalEntityType":{"oneOf":[{"maxLength":1000,"minLength":1,"type":"string","description":"The legal entity type of the merchant.","uniqueKey":"data.signals.legalEntityType.oneOf.0","typeLabel":"string"},{"maxLength":1000,"minLength":1,"type":"null","description":"The legal entity type of the merchant.","uniqueKey":"data.signals.legalEntityType.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.signals.legalEntityType","typeLabel":"string | null"},"taxId":{"oneOf":[{"maxLength":50,"type":"string","description":"Tax Identification Number or VAT number.","uniqueKey":"data.signals.taxId.oneOf.0","typeLabel":"string"},{"maxLength":50,"type":"null","description":"Tax Identification Number or VAT number.","uniqueKey":"data.signals.taxId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.signals.taxId","typeLabel":"string | null"},"fullName":{"oneOf":[{"maxLength":100,"type":"string","description":"The full name of the individual or entity associated with merchant account.","uniqueKey":"data.signals.fullName.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","description":"The full name of the individual or entity associated with merchant account.","uniqueKey":"data.signals.fullName.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.signals.fullName","typeLabel":"string | null"},"addressLine1":{"oneOf":[{"maxLength":200,"type":"string","description":"The primary address line.\nTypically, includes house number, street name, or building name.","uniqueKey":"data.signals.addressLine1.oneOf.0","typeLabel":"string"},{"maxLength":200,"type":"null","description":"The primary address line.\nTypically, includes house number, street name, or building name.","uniqueKey":"data.signals.addressLine1.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.signals.addressLine1","typeLabel":"string | null"},"addressLine2":{"oneOf":[{"maxLength":200,"type":"string","description":"The secondary address line, if applicable.\nMay include apartment, suite, unit, or floor details.\nOptional field.","uniqueKey":"data.signals.addressLine2.oneOf.0","typeLabel":"string"},{"maxLength":200,"type":"null","description":"The secondary address line, if applicable.\nMay include apartment, suite, unit, or floor details.\nOptional field.","uniqueKey":"data.signals.addressLine2.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.signals.addressLine2","typeLabel":"string | null"},"city":{"oneOf":[{"maxLength":100,"type":"string","description":"The city or locality associated with the address.","uniqueKey":"data.signals.city.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","description":"The city or locality associated with the address.","uniqueKey":"data.signals.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.signals.city","typeLabel":"string | null"},"region":{"oneOf":[{"maxLength":100,"type":"string","description":"The region associated with the address.\nRepresents state, province, or other administrative division.","uniqueKey":"data.signals.region.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","description":"The region associated with the address.\nRepresents state, province, or other administrative division.","uniqueKey":"data.signals.region.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.signals.region","typeLabel":"string | null"},"postalCode":{"oneOf":[{"maxLength":20,"type":"string","description":"The postal or ZIP code for the address.","uniqueKey":"data.signals.postalCode.oneOf.0","typeLabel":"string"},{"maxLength":20,"type":"null","description":"The postal or ZIP code for the address.","uniqueKey":"data.signals.postalCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.signals.postalCode","typeLabel":"string | null"}},"additionalProperties":false,"description":"Represents the risk signal information on a merchant","uniqueKey":"data.signals","typeLabel":"object"},"discordWebhookUrl":{"oneOf":[{"type":"string","description":"The URL for a Discord webhook associated with the user.","uniqueKey":"data.discordWebhookUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"The URL for a Discord webhook associated with the user.","uniqueKey":"data.discordWebhookUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.discordWebhookUrl","typeLabel":"string | null"},"subscription":{"required":["autoRenew","billingInterval","customerIds","dateCreated","emailMarketingSent","expiryDate","failedPaymentCount","id","isExpired","lastSyncedAt","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.subscription.id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created in the database","format":"date-time","isRequired":true,"uniqueKey":"data.subscription.dateCreated","typeLabel":"string\u003cdate-time>"},"expiryDate":{"type":"string","description":"Gets or sets the expiry date of the subscription plan.\nDefaults to DateOnly.MaxValue if the plan does not have an expiration date.","format":"date","isRequired":true,"uniqueKey":"data.subscription.expiryDate","typeLabel":"string\u003cdate>"},"autoRenew":{"type":"boolean","description":"Gets or sets a value indicating whether the subscription will automatically renew.\nDefault is true unless explicitly disabled by the user or system configuration.","isRequired":true,"uniqueKey":"data.subscription.autoRenew","typeLabel":"boolean"},"userId":{"maxLength":36,"minLength":3,"type":"string","description":"Gets or sets the unique identifier for the user associated with the subscription options.\nRequired and must be a string between 3 and 36 characters.","isRequired":true,"uniqueKey":"data.subscription.userId","typeLabel":"string"},"billingInterval":{"maxLength":20,"type":"string","description":"The billing interval for the subscription (e.g., Monthly, Yearly).","isRequired":true,"uniqueKey":"data.subscription.billingInterval","typeLabel":"string"},"failedPaymentCount":{"type":"integer","description":"The number of consecutive failed payment attempts.","format":"int32","isRequired":true,"uniqueKey":"data.subscription.failedPaymentCount","typeLabel":"integer\u003cint32>"},"lastSyncedAt":{"type":"string","description":"Gets or sets the timestamp of the last synchronization event.\nDefault is the current UTC time at instantiation.","format":"date-time","isRequired":true,"uniqueKey":"data.subscription.lastSyncedAt","typeLabel":"string\u003cdate-time>"},"customerIds":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"data.subscription.customerIds.additionalProperties","typeLabel":"string"},"description":"The IDs of the customer on respective payment gateways","isRequired":true,"uniqueKey":"data.subscription.customerIds","typeLabel":"object"},"emailMarketingSent":{"type":"integer","description":"Email marketing emails sent in the current monthly quota window, shared across ALL of the\naccount's stores. The Business plan grants a fixed 50,000/month allowance that resets (does\nnot stack) on the billing anniversary; non-Business accounts have a 0 allowance.","format":"int64","isRequired":true,"uniqueKey":"data.subscription.emailMarketingSent","typeLabel":"integer\u003cint64>"},"isExpired":{"type":"boolean","description":"Gets a value indicating whether the subscription is expired.\nA subscription is considered expired if:\n1. The status is \"trial_expired\" or \"suspended\".\n2. The ExpiryDate has passed AND we're not in a retry grace period.\n3. The TrialEndDate has passed (if applicable).\nFree plan merchants are never considered expired (they can always sell unless explicitly suspended).","readOnly":true,"isRequired":true,"uniqueKey":"data.subscription.isExpired","typeLabel":"boolean"},"startedDate":{"oneOf":[{"type":"string","description":"Gets or sets the start date of the user's subscription.\nThis represents when the subscription started or was activated.","format":"date","uniqueKey":"data.subscription.startedDate.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","description":"Gets or sets the start date of the user's subscription.\nThis represents when the subscription started or was activated.","format":"date","uniqueKey":"data.subscription.startedDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.startedDate","typeLabel":"string\u003cdate> | null"},"status":{"oneOf":[{"maxLength":50,"type":"string","description":"Gets or sets the current subscription status for a user.\nExamples include \"active\" or \"canceled\".","uniqueKey":"data.subscription.status.oneOf.0","typeLabel":"string"},{"maxLength":50,"type":"null","description":"Gets or sets the current subscription status for a user.\nExamples include \"active\" or \"canceled\".","uniqueKey":"data.subscription.status.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.status","typeLabel":"string | null"},"trialEndDate":{"oneOf":[{"type":"string","description":"Gets or sets the trial end date for the user's subscription.\nNull if no trial is assigned.","format":"date","uniqueKey":"data.subscription.trialEndDate.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","description":"Gets or sets the trial end date for the user's subscription.\nNull if no trial is assigned.","format":"date","uniqueKey":"data.subscription.trialEndDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.trialEndDate","typeLabel":"string\u003cdate> | null"},"planId":{"oneOf":[{"maxLength":128,"minLength":0,"type":"string","description":"Gets or sets the identifier for the plan associated with the subscription.","uniqueKey":"data.subscription.planId.oneOf.0","typeLabel":"string"},{"maxLength":128,"minLength":0,"type":"null","description":"Gets or sets the identifier for the plan associated with the subscription.","uniqueKey":"data.subscription.planId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.planId","typeLabel":"string | null"},"lastPaymentFailureDate":{"oneOf":[{"type":"string","description":"The date of the last failed payment attempt.","format":"date-time","uniqueKey":"data.subscription.lastPaymentFailureDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The date of the last failed payment attempt.","format":"date-time","uniqueKey":"data.subscription.lastPaymentFailureDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.lastPaymentFailureDate","typeLabel":"string\u003cdate-time> | null"},"nextRetryDate":{"oneOf":[{"type":"string","description":"The next date to retry billing after a failed payment.\nUsed for exponential backoff retry strategy.\nNull when no retry is pending (payment succeeded or account suspended).","format":"date","uniqueKey":"data.subscription.nextRetryDate.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","description":"The next date to retry billing after a failed payment.\nUsed for exponential backoff retry strategy.\nNull when no retry is pending (payment succeeded or account suspended).","format":"date","uniqueKey":"data.subscription.nextRetryDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.nextRetryDate","typeLabel":"string\u003cdate> | null"},"cancelAt":{"oneOf":[{"type":"string","description":"Gets or sets the date and time when the subscription is set to be canceled.\nNull indicates no cancellation is scheduled by default.","format":"date-time","uniqueKey":"data.subscription.cancelAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Gets or sets the date and time when the subscription is set to be canceled.\nNull indicates no cancellation is scheduled by default.","format":"date-time","uniqueKey":"data.subscription.cancelAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.cancelAt","typeLabel":"string\u003cdate-time> | null"},"canceledAt":{"oneOf":[{"type":"string","description":"Gets or sets the date and time when the subscription was canceled.\nThis property is null if the subscription has not been canceled.","format":"date-time","uniqueKey":"data.subscription.canceledAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Gets or sets the date and time when the subscription was canceled.\nThis property is null if the subscription has not been canceled.","format":"date-time","uniqueKey":"data.subscription.canceledAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.canceledAt","typeLabel":"string\u003cdate-time> | null"},"scheduledPlanId":{"oneOf":[{"maxLength":128,"minLength":0,"type":"string","description":"Gets or sets the scheduled plan ID for a pending downgrade.\nWhen set, the plan will change to this at the end of the current billing period.","uniqueKey":"data.subscription.scheduledPlanId.oneOf.0","typeLabel":"string"},{"maxLength":128,"minLength":0,"type":"null","description":"Gets or sets the scheduled plan ID for a pending downgrade.\nWhen set, the plan will change to this at the end of the current billing period.","uniqueKey":"data.subscription.scheduledPlanId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.scheduledPlanId","typeLabel":"string | null"},"scheduledBillingInterval":{"oneOf":[{"maxLength":20,"type":"string","description":"Gets or sets the scheduled billing interval for a pending downgrade.\nUsed together with ScheduledPlanId.","uniqueKey":"data.subscription.scheduledBillingInterval.oneOf.0","typeLabel":"string"},{"maxLength":20,"type":"null","description":"Gets or sets the scheduled billing interval for a pending downgrade.\nUsed together with ScheduledPlanId.","uniqueKey":"data.subscription.scheduledBillingInterval.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.scheduledBillingInterval","typeLabel":"string | null"},"lastExpiryReminderDate":{"oneOf":[{"type":"string","description":"Tracks the ExpiryDate for which the last expiry reminder was sent.\nUsed to prevent duplicate reminder emails when the Hangfire job uses a date range.\nReset implicitly when ExpiryDate advances on renewal.","format":"date","uniqueKey":"data.subscription.lastExpiryReminderDate.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","description":"Tracks the ExpiryDate for which the last expiry reminder was sent.\nUsed to prevent duplicate reminder emails when the Hangfire job uses a date range.\nReset implicitly when ExpiryDate advances on renewal.","format":"date","uniqueKey":"data.subscription.lastExpiryReminderDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.lastExpiryReminderDate","typeLabel":"string\u003cdate> | null"},"emailMarketingQuotaResetAt":{"oneOf":[{"type":"string","description":"When the email marketing monthly quota window resets EmailMarketingSent back to\nzero. Null until the account first uses email marketing as a Business plan.","format":"date-time","uniqueKey":"data.subscription.emailMarketingQuotaResetAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"When the email marketing monthly quota window resets EmailMarketingSent back to\nzero. Null until the account first uses email marketing as a Business plan.","format":"date-time","uniqueKey":"data.subscription.emailMarketingQuotaResetAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.emailMarketingQuotaResetAt","typeLabel":"string\u003cdate-time> | null"}},"additionalProperties":false,"description":"Represents the subscription configuration and details for a user.","uniqueKey":"data.subscription","typeLabel":"object"},"refreshAt":{"oneOf":[{"type":"string","description":"The timestamp indicating when the user information should be refreshed.","format":"date-time","uniqueKey":"data.refreshAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The timestamp indicating when the user information should be refreshed.","format":"date-time","uniqueKey":"data.refreshAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.refreshAt","typeLabel":"string\u003cdate-time> | null"},"billingSuspensionDate":{"oneOf":[{"type":"string","description":"The date when the billing suspension started.","format":"date-time","uniqueKey":"data.billingSuspensionDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The date when the billing suspension started.","format":"date-time","uniqueKey":"data.billingSuspensionDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.billingSuspensionDate","typeLabel":"string\u003cdate-time> | null"},"cashAppOptions":{"required":["id","isAcceptingRequests","isEnabled","isRestricted","isRiskLocked","notesVersion","requireBillingInformation","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.cashAppOptions.id","typeLabel":"string\u003cuuid>"},"isEnabled":{"type":"boolean","description":"Whether the integration is enabled or not","isRequired":true,"uniqueKey":"data.cashAppOptions.isEnabled","typeLabel":"boolean"},"isRestricted":{"type":"boolean","description":"Whether the payment method is restricted from being used by the PSP","isRequired":true,"uniqueKey":"data.cashAppOptions.isRestricted","typeLabel":"boolean"},"isRiskLocked":{"type":"boolean","description":"Whether the payment method is restricted for setup by the user due to risk concerns","isRequired":true,"uniqueKey":"data.cashAppOptions.isRiskLocked","typeLabel":"boolean"},"userId":{"maxLength":36,"type":"string","description":"The user ID the integration options are for","isRequired":true,"uniqueKey":"data.cashAppOptions.userId","typeLabel":"string"},"requireBillingInformation":{"type":"boolean","description":"Whether to prompt and ask the customer for billing information, reduces conversion and increases anti-fraud\neffectiveness","isRequired":true,"uniqueKey":"data.cashAppOptions.requireBillingInformation","typeLabel":"boolean"},"isAcceptingRequests":{"type":"boolean","description":"Whether to accept Cash App requests as a delivery receipt, this can be dangerous as users can\ncharge back easily at this stage","isRequired":true,"uniqueKey":"data.cashAppOptions.isAcceptingRequests","typeLabel":"boolean"},"notesVersion":{"enum":[0,1,2],"type":"integer","description":"Represents versions used in the notes system within the application.","format":"int32","x-enum-varnames":["Version1","Version2","Custom"],"x-enum-descriptions":["The first notes version which uses random joined words by a dash","The second notes version which introduces enhanced features over the first version.","The custom notes version which uses user-defined note lists."],"isRequired":true,"uniqueKey":"data.cashAppOptions.notesVersion","typeLabel":"enum\u003cinteger>"},"restrictionReason":{"oneOf":[{"maxLength":2048,"type":"string","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.cashAppOptions.restrictionReason.oneOf.0","typeLabel":"string"},{"maxLength":2048,"type":"null","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.cashAppOptions.restrictionReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.cashAppOptions.restrictionReason","typeLabel":"string | null"},"email":{"oneOf":[{"maxLength":256,"type":"string","description":"The automatically generated email address to forward Cash App emails to","uniqueKey":"data.cashAppOptions.email.oneOf.0","typeLabel":"string"},{"maxLength":256,"type":"null","description":"The automatically generated email address to forward Cash App emails to","uniqueKey":"data.cashAppOptions.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.cashAppOptions.email","typeLabel":"string | null"},"tag":{"oneOf":[{"maxLength":32,"type":"string","description":"The users Cash Tag to show the user where to send the funds","uniqueKey":"data.cashAppOptions.tag.oneOf.0","typeLabel":"string"},{"maxLength":32,"type":"null","description":"The users Cash Tag to show the user where to send the funds","uniqueKey":"data.cashAppOptions.tag.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.cashAppOptions.tag","typeLabel":"string | null"},"customNoteListId":{"oneOf":[{"type":"string","description":"The optional custom note list to use when NotesVersion is Custom.","format":"uuid","uniqueKey":"data.cashAppOptions.customNoteListId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"The optional custom note list to use when NotesVersion is Custom.","format":"uuid","uniqueKey":"data.cashAppOptions.customNoteListId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.cashAppOptions.customNoteListId","typeLabel":"string\u003cuuid> | null"}},"additionalProperties":false,"description":"Represents configuration and options related to Cash App integration within the application.","uniqueKey":"data.cashAppOptions","typeLabel":"object"},"payPalOptions":{"required":["id","isAcceptingHeldPayments","isAcceptingRequests","isEnabled","isFriendsAndFamilyEnabled","isRestricted","isRiskLocked","isUsingLegacyEmails","notesVersion","requireBillingInformation","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.payPalOptions.id","typeLabel":"string\u003cuuid>"},"isEnabled":{"type":"boolean","description":"Whether the integration is enabled or not","isRequired":true,"uniqueKey":"data.payPalOptions.isEnabled","typeLabel":"boolean"},"isRestricted":{"type":"boolean","description":"Whether the payment method is restricted from being used by the PSP","isRequired":true,"uniqueKey":"data.payPalOptions.isRestricted","typeLabel":"boolean"},"isRiskLocked":{"type":"boolean","description":"Whether the payment method is restricted for setup by the user due to risk concerns","isRequired":true,"uniqueKey":"data.payPalOptions.isRiskLocked","typeLabel":"boolean"},"userId":{"maxLength":36,"type":"string","description":"The user ID the integration options are for","isRequired":true,"uniqueKey":"data.payPalOptions.userId","typeLabel":"string"},"requireBillingInformation":{"type":"boolean","description":"Whether to prompt and ask the customer for billing information, reduces conversion and increases anti-fraud\neffectiveness","isRequired":true,"uniqueKey":"data.payPalOptions.requireBillingInformation","typeLabel":"boolean"},"isUsingLegacyEmails":{"type":"boolean","description":"Whether the Friends and Family integration is using legacy email forwarding not IPN","isRequired":true,"uniqueKey":"data.payPalOptions.isUsingLegacyEmails","typeLabel":"boolean"},"isFriendsAndFamilyEnabled":{"type":"boolean","description":"Whether the PayPal friends and family integration is enabled","isRequired":true,"uniqueKey":"data.payPalOptions.isFriendsAndFamilyEnabled","typeLabel":"boolean"},"isAcceptingRequests":{"type":"boolean","description":"Whether to accept PayPal friends and family requests as a delivery receipt, this can be dangerous as users can\ncharge back easily at this stage","isRequired":true,"uniqueKey":"data.payPalOptions.isAcceptingRequests","typeLabel":"boolean"},"isAcceptingHeldPayments":{"type":"boolean","description":"Whether to accept payments that are on-hold automatically, this is potentially dangerous as the payment can fail at\nthis stage and cause lost funds","isRequired":true,"uniqueKey":"data.payPalOptions.isAcceptingHeldPayments","typeLabel":"boolean"},"notesVersion":{"enum":[0,1,2],"type":"integer","description":"Represents versions used in the notes system within the application.","format":"int32","x-enum-varnames":["Version1","Version2","Custom"],"x-enum-descriptions":["The first notes version which uses random joined words by a dash","The second notes version which introduces enhanced features over the first version.","The custom notes version which uses user-defined note lists."],"isRequired":true,"uniqueKey":"data.payPalOptions.notesVersion","typeLabel":"enum\u003cinteger>"},"restrictionReason":{"oneOf":[{"maxLength":2048,"type":"string","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.payPalOptions.restrictionReason.oneOf.0","typeLabel":"string"},{"maxLength":2048,"type":"null","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.payPalOptions.restrictionReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.payPalOptions.restrictionReason","typeLabel":"string | null"},"email":{"oneOf":[{"maxLength":512,"type":"string","description":"The automatically generated email address to forward PayPal emails to","uniqueKey":"data.payPalOptions.email.oneOf.0","typeLabel":"string"},{"maxLength":512,"type":"null","description":"The automatically generated email address to forward PayPal emails to","uniqueKey":"data.payPalOptions.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.payPalOptions.email","typeLabel":"string | null"},"payPalEmail":{"oneOf":[{"maxLength":512,"type":"string","description":"The actual email address associated with their PayPal account","uniqueKey":"data.payPalOptions.payPalEmail.oneOf.0","typeLabel":"string"},{"maxLength":512,"type":"null","description":"The actual email address associated with their PayPal account","uniqueKey":"data.payPalOptions.payPalEmail.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.payPalOptions.payPalEmail","typeLabel":"string | null"},"customNoteListId":{"oneOf":[{"type":"string","description":"The optional custom note list to use when NotesVersion is Custom.","format":"uuid","uniqueKey":"data.payPalOptions.customNoteListId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"The optional custom note list to use when NotesVersion is Custom.","format":"uuid","uniqueKey":"data.payPalOptions.customNoteListId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.payPalOptions.customNoteListId","typeLabel":"string\u003cuuid> | null"}},"additionalProperties":false,"description":"The options to configure PayPal with","uniqueKey":"data.payPalOptions","typeLabel":"object"},"storrikOptions":{"required":["id","isEnabled","isRestricted","isRiskLocked","requireBillingInformation","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.storrikOptions.id","typeLabel":"string\u003cuuid>"},"isEnabled":{"type":"boolean","description":"Whether the integration is enabled or not","isRequired":true,"uniqueKey":"data.storrikOptions.isEnabled","typeLabel":"boolean"},"isRestricted":{"type":"boolean","description":"Whether the payment method is restricted from being used by the PSP","isRequired":true,"uniqueKey":"data.storrikOptions.isRestricted","typeLabel":"boolean"},"isRiskLocked":{"type":"boolean","description":"Whether the payment method is restricted for setup by the user due to risk concerns","isRequired":true,"uniqueKey":"data.storrikOptions.isRiskLocked","typeLabel":"boolean"},"userId":{"maxLength":36,"type":"string","description":"The user ID the integration options are for","isRequired":true,"uniqueKey":"data.storrikOptions.userId","typeLabel":"string"},"requireBillingInformation":{"type":"boolean","description":"Whether to prompt and ask the customer for billing information, reduces conversion and increases anti-fraud\neffectiveness","isRequired":true,"uniqueKey":"data.storrikOptions.requireBillingInformation","typeLabel":"boolean"},"restrictionReason":{"oneOf":[{"maxLength":2048,"type":"string","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.storrikOptions.restrictionReason.oneOf.0","typeLabel":"string"},{"maxLength":2048,"type":"null","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.storrikOptions.restrictionReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storrikOptions.restrictionReason","typeLabel":"string | null"}},"additionalProperties":false,"description":"Represents configuration options for Storrik integration.","uniqueKey":"data.storrikOptions","typeLabel":"object"},"payPalBusinessOptions":{"required":["forceCardOnly","id","isEnabled","isRestricted","isRiskLocked","isUsingLegacyIntegration","requireBillingInformation","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.payPalBusinessOptions.id","typeLabel":"string\u003cuuid>"},"isEnabled":{"type":"boolean","description":"Whether the integration is enabled or not","isRequired":true,"uniqueKey":"data.payPalBusinessOptions.isEnabled","typeLabel":"boolean"},"isRestricted":{"type":"boolean","description":"Whether the payment method is restricted from being used by the PSP","isRequired":true,"uniqueKey":"data.payPalBusinessOptions.isRestricted","typeLabel":"boolean"},"isRiskLocked":{"type":"boolean","description":"Whether the payment method is restricted for setup by the user due to risk concerns","isRequired":true,"uniqueKey":"data.payPalBusinessOptions.isRiskLocked","typeLabel":"boolean"},"userId":{"maxLength":36,"type":"string","description":"The user ID the integration options are for","isRequired":true,"uniqueKey":"data.payPalBusinessOptions.userId","typeLabel":"string"},"requireBillingInformation":{"type":"boolean","description":"Whether to prompt and ask the customer for billing information, reduces conversion and increases anti-fraud\neffectiveness","isRequired":true,"uniqueKey":"data.payPalBusinessOptions.requireBillingInformation","typeLabel":"boolean"},"isUsingLegacyIntegration":{"type":"boolean","description":"Whether the system is using the legacy PayPal Business integration method, which uses links and \"not smart\" buttons","isRequired":true,"uniqueKey":"data.payPalBusinessOptions.isUsingLegacyIntegration","typeLabel":"boolean"},"forceCardOnly":{"type":"boolean","description":"When true, the checkout UI should only show the credit/debit card option, not PayPal wallet.","isRequired":true,"uniqueKey":"data.payPalBusinessOptions.forceCardOnly","typeLabel":"boolean"},"restrictionReason":{"oneOf":[{"maxLength":2048,"type":"string","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.payPalBusinessOptions.restrictionReason.oneOf.0","typeLabel":"string"},{"maxLength":2048,"type":"null","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.payPalBusinessOptions.restrictionReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.payPalBusinessOptions.restrictionReason","typeLabel":"string | null"},"oAuthClientId":{"oneOf":[{"maxLength":512,"type":"string","description":"The OAuth client identifier used for authentication with PayPal.","uniqueKey":"data.payPalBusinessOptions.oAuthClientId.oneOf.0","typeLabel":"string"},{"maxLength":512,"type":"null","description":"The OAuth client identifier used for authentication with PayPal.","uniqueKey":"data.payPalBusinessOptions.oAuthClientId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.payPalBusinessOptions.oAuthClientId","typeLabel":"string | null"},"emailAddress":{"oneOf":[{"maxLength":256,"type":"string","description":"The email address associated with the PayPal account, used for the old system","uniqueKey":"data.payPalBusinessOptions.emailAddress.oneOf.0","typeLabel":"string"},{"maxLength":256,"type":"null","description":"The email address associated with the PayPal account, used for the old system","uniqueKey":"data.payPalBusinessOptions.emailAddress.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.payPalBusinessOptions.emailAddress","typeLabel":"string | null"}},"additionalProperties":false,"description":"Represents the configuration options specific to a PayPal Business integration.","uniqueKey":"data.payPalBusinessOptions","typeLabel":"object"},"stripeOptions":{"required":["id","isEnabled","isRestricted","isRiskLocked","requireBillingInformation","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.stripeOptions.id","typeLabel":"string\u003cuuid>"},"isEnabled":{"type":"boolean","description":"Whether the integration is enabled or not","isRequired":true,"uniqueKey":"data.stripeOptions.isEnabled","typeLabel":"boolean"},"isRestricted":{"type":"boolean","description":"Whether the payment method is restricted from being used by the PSP","isRequired":true,"uniqueKey":"data.stripeOptions.isRestricted","typeLabel":"boolean"},"isRiskLocked":{"type":"boolean","description":"Whether the payment method is restricted for setup by the user due to risk concerns","isRequired":true,"uniqueKey":"data.stripeOptions.isRiskLocked","typeLabel":"boolean"},"userId":{"maxLength":36,"type":"string","description":"The user ID the integration options are for","isRequired":true,"uniqueKey":"data.stripeOptions.userId","typeLabel":"string"},"requireBillingInformation":{"type":"boolean","description":"Whether to prompt and ask the customer for billing information, reduces conversion and increases anti-fraud\neffectiveness","isRequired":true,"uniqueKey":"data.stripeOptions.requireBillingInformation","typeLabel":"boolean"},"restrictionReason":{"oneOf":[{"maxLength":2048,"type":"string","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.stripeOptions.restrictionReason.oneOf.0","typeLabel":"string"},{"maxLength":2048,"type":"null","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.stripeOptions.restrictionReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stripeOptions.restrictionReason","typeLabel":"string | null"},"paymentMethodConfigurationId":{"oneOf":[{"maxLength":64,"type":"string","description":"The payment method configuration ID to use for the account integration","uniqueKey":"data.stripeOptions.paymentMethodConfigurationId.oneOf.0","typeLabel":"string"},{"maxLength":64,"type":"null","description":"The payment method configuration ID to use for the account integration","uniqueKey":"data.stripeOptions.paymentMethodConfigurationId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stripeOptions.paymentMethodConfigurationId","typeLabel":"string | null"},"publishableKey":{"oneOf":[{"maxLength":512,"minLength":0,"type":"string","description":"The publishable key for the Stripe integration, not encrypted","uniqueKey":"data.stripeOptions.publishableKey.oneOf.0","typeLabel":"string"},{"maxLength":512,"minLength":0,"type":"null","description":"The publishable key for the Stripe integration, not encrypted","uniqueKey":"data.stripeOptions.publishableKey.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.stripeOptions.publishableKey","typeLabel":"string | null"}},"additionalProperties":false,"description":"The Stripe options for a merchants Stripe setup","uniqueKey":"data.stripeOptions","typeLabel":"object"},"squareOptions":{"required":["applicationId","id","isEnabled","isRestricted","isRiskLocked","locationId","requireBillingInformation","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.squareOptions.id","typeLabel":"string\u003cuuid>"},"isEnabled":{"type":"boolean","description":"Whether the integration is enabled or not","isRequired":true,"uniqueKey":"data.squareOptions.isEnabled","typeLabel":"boolean"},"isRestricted":{"type":"boolean","description":"Whether the payment method is restricted from being used by the PSP","isRequired":true,"uniqueKey":"data.squareOptions.isRestricted","typeLabel":"boolean"},"isRiskLocked":{"type":"boolean","description":"Whether the payment method is restricted for setup by the user due to risk concerns","isRequired":true,"uniqueKey":"data.squareOptions.isRiskLocked","typeLabel":"boolean"},"userId":{"maxLength":36,"type":"string","description":"The user ID the integration options are for","isRequired":true,"uniqueKey":"data.squareOptions.userId","typeLabel":"string"},"requireBillingInformation":{"type":"boolean","description":"Whether to prompt and ask the customer for billing information, reduces conversion and increases anti-fraud\neffectiveness","isRequired":true,"uniqueKey":"data.squareOptions.requireBillingInformation","typeLabel":"boolean"},"applicationId":{"maxLength":256,"minLength":1,"type":"string","description":"Represents the application ID required for Square payment integration.","isRequired":true,"uniqueKey":"data.squareOptions.applicationId","typeLabel":"string"},"locationId":{"maxLength":256,"minLength":1,"type":"string","description":"Represents the location ID associated with the Square integration.","isRequired":true,"uniqueKey":"data.squareOptions.locationId","typeLabel":"string"},"restrictionReason":{"oneOf":[{"maxLength":2048,"type":"string","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.squareOptions.restrictionReason.oneOf.0","typeLabel":"string"},{"maxLength":2048,"type":"null","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.squareOptions.restrictionReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.squareOptions.restrictionReason","typeLabel":"string | null"}},"additionalProperties":false,"description":"Represents configuration options specific to Square integrations.","uniqueKey":"data.squareOptions","typeLabel":"object"},"mollieOptions":{"required":["id","isEnabled","isRestricted","isRiskLocked","profileId","requireBillingInformation","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.mollieOptions.id","typeLabel":"string\u003cuuid>"},"isEnabled":{"type":"boolean","description":"Whether the integration is enabled or not","isRequired":true,"uniqueKey":"data.mollieOptions.isEnabled","typeLabel":"boolean"},"isRestricted":{"type":"boolean","description":"Whether the payment method is restricted from being used by the PSP","isRequired":true,"uniqueKey":"data.mollieOptions.isRestricted","typeLabel":"boolean"},"isRiskLocked":{"type":"boolean","description":"Whether the payment method is restricted for setup by the user due to risk concerns","isRequired":true,"uniqueKey":"data.mollieOptions.isRiskLocked","typeLabel":"boolean"},"userId":{"maxLength":36,"type":"string","description":"The user ID the integration options are for","isRequired":true,"uniqueKey":"data.mollieOptions.userId","typeLabel":"string"},"requireBillingInformation":{"type":"boolean","description":"Whether to prompt and ask the customer for billing information, reduces conversion and increases anti-fraud\neffectiveness","isRequired":true,"uniqueKey":"data.mollieOptions.requireBillingInformation","typeLabel":"boolean"},"profileId":{"maxLength":50,"minLength":1,"type":"string","description":"The ID of the profile on Mollie, for Mollie.js","isRequired":true,"uniqueKey":"data.mollieOptions.profileId","typeLabel":"string"},"restrictionReason":{"oneOf":[{"maxLength":2048,"type":"string","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.mollieOptions.restrictionReason.oneOf.0","typeLabel":"string"},{"maxLength":2048,"type":"null","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.mollieOptions.restrictionReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.mollieOptions.restrictionReason","typeLabel":"string | null"}},"additionalProperties":false,"description":"Configuration options for Mollie integration.","uniqueKey":"data.mollieOptions","typeLabel":"object"},"northbridgeOptions":{"required":["id","isEnabled","isRestricted","isRiskLocked","requireBillingInformation","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.northbridgeOptions.id","typeLabel":"string\u003cuuid>"},"isEnabled":{"type":"boolean","description":"Whether the integration is enabled or not","isRequired":true,"uniqueKey":"data.northbridgeOptions.isEnabled","typeLabel":"boolean"},"isRestricted":{"type":"boolean","description":"Whether the payment method is restricted from being used by the PSP","isRequired":true,"uniqueKey":"data.northbridgeOptions.isRestricted","typeLabel":"boolean"},"isRiskLocked":{"type":"boolean","description":"Whether the payment method is restricted for setup by the user due to risk concerns","isRequired":true,"uniqueKey":"data.northbridgeOptions.isRiskLocked","typeLabel":"boolean"},"userId":{"maxLength":36,"type":"string","description":"The user ID the integration options are for","isRequired":true,"uniqueKey":"data.northbridgeOptions.userId","typeLabel":"string"},"requireBillingInformation":{"type":"boolean","description":"Whether to prompt and ask the customer for billing information, reduces conversion and increases anti-fraud\neffectiveness","isRequired":true,"uniqueKey":"data.northbridgeOptions.requireBillingInformation","typeLabel":"boolean"},"restrictionReason":{"oneOf":[{"maxLength":2048,"type":"string","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.northbridgeOptions.restrictionReason.oneOf.0","typeLabel":"string"},{"maxLength":2048,"type":"null","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.northbridgeOptions.restrictionReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.northbridgeOptions.restrictionReason","typeLabel":"string | null"}},"additionalProperties":false,"description":"Represents the configuration options for Northbridge payment integration.","uniqueKey":"data.northbridgeOptions","typeLabel":"object"},"nmiOptions":{"required":["gatewayUrl","id","isEnabled","isRestricted","isRiskLocked","kountEnabled","publicKey","rejectAvsAddressMismatch","rejectAvsUnavailable","rejectAvsZipMismatch","rejectCvvMismatch","requireBillingInformation","threeDSecureEnabled","threeDSecureRequired","threeDSecureRequireVerified","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.nmiOptions.id","typeLabel":"string\u003cuuid>"},"isEnabled":{"type":"boolean","description":"Whether the integration is enabled or not","isRequired":true,"uniqueKey":"data.nmiOptions.isEnabled","typeLabel":"boolean"},"isRestricted":{"type":"boolean","description":"Whether the payment method is restricted from being used by the PSP","isRequired":true,"uniqueKey":"data.nmiOptions.isRestricted","typeLabel":"boolean"},"isRiskLocked":{"type":"boolean","description":"Whether the payment method is restricted for setup by the user due to risk concerns","isRequired":true,"uniqueKey":"data.nmiOptions.isRiskLocked","typeLabel":"boolean"},"userId":{"maxLength":36,"type":"string","description":"The user ID the integration options are for","isRequired":true,"uniqueKey":"data.nmiOptions.userId","typeLabel":"string"},"requireBillingInformation":{"type":"boolean","description":"Whether to prompt and ask the customer for billing information, reduces conversion and increases anti-fraud\neffectiveness","isRequired":true,"uniqueKey":"data.nmiOptions.requireBillingInformation","typeLabel":"boolean"},"gatewayUrl":{"maxLength":256,"type":"string","description":"The base URL of the NMI gateway (e.g. https://paymentcloud.transactiongateway.com)","isRequired":true,"uniqueKey":"data.nmiOptions.gatewayUrl","typeLabel":"string"},"publicKey":{"maxLength":256,"type":"string","description":"The public key for Collect.js/Gateway.js tokenization and 3DS/Kount\nThis key is used for both data-tokenization-key (Collect.js) and\nGateway.js initialization (for 3DS and Kount)","isRequired":true,"uniqueKey":"data.nmiOptions.publicKey","typeLabel":"string"},"threeDSecureEnabled":{"type":"boolean","description":"Whether 3D Secure is enabled for transactions","isRequired":true,"uniqueKey":"data.nmiOptions.threeDSecureEnabled","typeLabel":"boolean"},"threeDSecureRequired":{"type":"boolean","description":"Refuse a card sale that arrives without payer authentication, rather than merely offering 3D\nSecure to the browser.","isRequired":true,"uniqueKey":"data.nmiOptions.threeDSecureRequired","typeLabel":"boolean"},"threeDSecureRequireVerified":{"type":"boolean","description":"Whether an `attempted` authentication satisfies ThreeDSecureRequired, or\nonly a `verified` one does.","isRequired":true,"uniqueKey":"data.nmiOptions.threeDSecureRequireVerified","typeLabel":"boolean"},"rejectAvsAddressMismatch":{"type":"boolean","description":"Reject transactions where AVS street address does not match (response codes: N, A, W, Z)","isRequired":true,"uniqueKey":"data.nmiOptions.rejectAvsAddressMismatch","typeLabel":"boolean"},"rejectAvsZipMismatch":{"type":"boolean","description":"Reject transactions where AVS zip code does not match (response codes: N, A)","isRequired":true,"uniqueKey":"data.nmiOptions.rejectAvsZipMismatch","typeLabel":"boolean"},"rejectCvvMismatch":{"type":"boolean","description":"Reject transactions where CVV does not match (response codes: N)","isRequired":true,"uniqueKey":"data.nmiOptions.rejectCvvMismatch","typeLabel":"boolean"},"rejectAvsUnavailable":{"type":"boolean","description":"Reject transactions where AVS/CVV is not available or not processed (response codes: U, S, P)","isRequired":true,"uniqueKey":"data.nmiOptions.rejectAvsUnavailable","typeLabel":"boolean"},"kountEnabled":{"type":"boolean","description":"Whether Kount fraud screening is enabled","isRequired":true,"uniqueKey":"data.nmiOptions.kountEnabled","typeLabel":"boolean"},"restrictionReason":{"oneOf":[{"maxLength":2048,"type":"string","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.nmiOptions.restrictionReason.oneOf.0","typeLabel":"string"},{"maxLength":2048,"type":"null","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.nmiOptions.restrictionReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.nmiOptions.restrictionReason","typeLabel":"string | null"},"kountMerchantId":{"oneOf":[{"maxLength":64,"type":"string","description":"The Kount Merchant ID (if using Kount fraud screening)","uniqueKey":"data.nmiOptions.kountMerchantId.oneOf.0","typeLabel":"string"},{"maxLength":64,"type":"null","description":"The Kount Merchant ID (if using Kount fraud screening)","uniqueKey":"data.nmiOptions.kountMerchantId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.nmiOptions.kountMerchantId","typeLabel":"string | null"}},"additionalProperties":false,"description":"NMI (Payment Cloud) integration options for a user","uniqueKey":"data.nmiOptions","typeLabel":"object"},"paddleOptions":{"required":["id","isEnabled","isRestricted","isRiskLocked","requireBillingInformation","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.paddleOptions.id","typeLabel":"string\u003cuuid>"},"isEnabled":{"type":"boolean","description":"Whether the integration is enabled or not","isRequired":true,"uniqueKey":"data.paddleOptions.isEnabled","typeLabel":"boolean"},"isRestricted":{"type":"boolean","description":"Whether the payment method is restricted from being used by the PSP","isRequired":true,"uniqueKey":"data.paddleOptions.isRestricted","typeLabel":"boolean"},"isRiskLocked":{"type":"boolean","description":"Whether the payment method is restricted for setup by the user due to risk concerns","isRequired":true,"uniqueKey":"data.paddleOptions.isRiskLocked","typeLabel":"boolean"},"userId":{"maxLength":36,"type":"string","description":"The user ID the integration options are for","isRequired":true,"uniqueKey":"data.paddleOptions.userId","typeLabel":"string"},"requireBillingInformation":{"type":"boolean","description":"Whether to prompt and ask the customer for billing information, reduces conversion and increases anti-fraud\neffectiveness","isRequired":true,"uniqueKey":"data.paddleOptions.requireBillingInformation","typeLabel":"boolean"},"restrictionReason":{"oneOf":[{"maxLength":2048,"type":"string","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.paddleOptions.restrictionReason.oneOf.0","typeLabel":"string"},{"maxLength":2048,"type":"null","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.paddleOptions.restrictionReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.paddleOptions.restrictionReason","typeLabel":"string | null"}},"additionalProperties":false,"description":"Represents configuration options for the Paddle integration.","uniqueKey":"data.paddleOptions","typeLabel":"object"},"fastSpringOptions":{"required":["id","isEnabled","isRestricted","isRiskLocked","requireBillingInformation","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.fastSpringOptions.id","typeLabel":"string\u003cuuid>"},"isEnabled":{"type":"boolean","description":"Whether the integration is enabled or not","isRequired":true,"uniqueKey":"data.fastSpringOptions.isEnabled","typeLabel":"boolean"},"isRestricted":{"type":"boolean","description":"Whether the payment method is restricted from being used by the PSP","isRequired":true,"uniqueKey":"data.fastSpringOptions.isRestricted","typeLabel":"boolean"},"isRiskLocked":{"type":"boolean","description":"Whether the payment method is restricted for setup by the user due to risk concerns","isRequired":true,"uniqueKey":"data.fastSpringOptions.isRiskLocked","typeLabel":"boolean"},"userId":{"maxLength":36,"type":"string","description":"The user ID the integration options are for","isRequired":true,"uniqueKey":"data.fastSpringOptions.userId","typeLabel":"string"},"requireBillingInformation":{"type":"boolean","description":"Whether to prompt and ask the customer for billing information, reduces conversion and increases anti-fraud\neffectiveness","isRequired":true,"uniqueKey":"data.fastSpringOptions.requireBillingInformation","typeLabel":"boolean"},"restrictionReason":{"oneOf":[{"maxLength":2048,"type":"string","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.fastSpringOptions.restrictionReason.oneOf.0","typeLabel":"string"},{"maxLength":2048,"type":"null","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.fastSpringOptions.restrictionReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.fastSpringOptions.restrictionReason","typeLabel":"string | null"}},"additionalProperties":false,"description":"Represents configuration options for the FastSpring integration.","uniqueKey":"data.fastSpringOptions","typeLabel":"object"},"shopifyOptions":{"required":["id","isEnabled","isRestricted","isRiskLocked","requireBillingInformation","shopUrl","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.shopifyOptions.id","typeLabel":"string\u003cuuid>"},"isEnabled":{"type":"boolean","description":"Whether the integration is enabled or not","isRequired":true,"uniqueKey":"data.shopifyOptions.isEnabled","typeLabel":"boolean"},"isRestricted":{"type":"boolean","description":"Whether the payment method is restricted from being used by the PSP","isRequired":true,"uniqueKey":"data.shopifyOptions.isRestricted","typeLabel":"boolean"},"isRiskLocked":{"type":"boolean","description":"Whether the payment method is restricted for setup by the user due to risk concerns","isRequired":true,"uniqueKey":"data.shopifyOptions.isRiskLocked","typeLabel":"boolean"},"userId":{"maxLength":36,"type":"string","description":"The user ID the integration options are for","isRequired":true,"uniqueKey":"data.shopifyOptions.userId","typeLabel":"string"},"requireBillingInformation":{"type":"boolean","description":"Whether to prompt and ask the customer for billing information, reduces conversion and increases anti-fraud\neffectiveness","isRequired":true,"uniqueKey":"data.shopifyOptions.requireBillingInformation","typeLabel":"boolean"},"shopUrl":{"maxLength":256,"minLength":1,"type":"string","description":"The shop's `*.myshopify.com` domain.","isRequired":true,"uniqueKey":"data.shopifyOptions.shopUrl","typeLabel":"string"},"restrictionReason":{"oneOf":[{"maxLength":2048,"type":"string","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.shopifyOptions.restrictionReason.oneOf.0","typeLabel":"string"},{"maxLength":2048,"type":"null","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.shopifyOptions.restrictionReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.shopifyOptions.restrictionReason","typeLabel":"string | null"}},"additionalProperties":false,"description":"A store's Shopify connection.","uniqueKey":"data.shopifyOptions","typeLabel":"object"},"cryptocurrencyOptions":{"required":["disabledCryptocurrencies","id","isEnabled","isRestricted","isRiskLocked","requireBillingInformation","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.cryptocurrencyOptions.id","typeLabel":"string\u003cuuid>"},"isEnabled":{"type":"boolean","description":"Whether the integration is enabled or not","isRequired":true,"uniqueKey":"data.cryptocurrencyOptions.isEnabled","typeLabel":"boolean"},"isRestricted":{"type":"boolean","description":"Whether the payment method is restricted from being used by the PSP","isRequired":true,"uniqueKey":"data.cryptocurrencyOptions.isRestricted","typeLabel":"boolean"},"isRiskLocked":{"type":"boolean","description":"Whether the payment method is restricted for setup by the user due to risk concerns","isRequired":true,"uniqueKey":"data.cryptocurrencyOptions.isRiskLocked","typeLabel":"boolean"},"userId":{"maxLength":36,"type":"string","description":"The user ID the integration options are for","isRequired":true,"uniqueKey":"data.cryptocurrencyOptions.userId","typeLabel":"string"},"requireBillingInformation":{"type":"boolean","description":"Whether to prompt and ask the customer for billing information, reduces conversion and increases anti-fraud\neffectiveness","isRequired":true,"uniqueKey":"data.cryptocurrencyOptions.requireBillingInformation","typeLabel":"boolean"},"disabledCryptocurrencies":{"type":"array","items":{"type":"string","uniqueKey":"data.cryptocurrencyOptions.disabledCryptocurrencies.items.[INDEX]","typeLabel":"string"},"description":"Coins the merchant has explicitly DISABLED. Under the non-custodial model every coin a configured\nprocessor (Conduit wallet / NOWPayments-BYO) can serve is accepted by default; this opt-out set is\nthe merchant's only per-coin selection. Checkout offers `serveable − DisabledCryptocurrencies`.","isRequired":true,"uniqueKey":"data.cryptocurrencyOptions.disabledCryptocurrencies","typeLabel":"string[]"},"restrictionReason":{"oneOf":[{"maxLength":2048,"type":"string","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.cryptocurrencyOptions.restrictionReason.oneOf.0","typeLabel":"string"},{"maxLength":2048,"type":"null","description":"The reason the restriction is in place, if there is one","uniqueKey":"data.cryptocurrencyOptions.restrictionReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.cryptocurrencyOptions.restrictionReason","typeLabel":"string | null"}},"additionalProperties":false,"description":"The cryptocurrency options for a merchant","uniqueKey":"data.cryptocurrencyOptions","typeLabel":"object"}},"additionalProperties":false,"description":"Represents a user with detailed merchant-related information.","uniqueKey":"data","typeLabel":"object"}},"additionalProperties":false,"description":"Represents a default generic response for API endpoints.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"message":"\u003cstring>","code":"\u003cstring>","data":{"id":"\u003cstring>","dateCreated":"2023-11-07T05:31:56Z","stores":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","name":"\u003cstring>","description":"\u003cstring>","url":"\n store\n ","currencyCode":"\u003cstring>","prependProductNameToReceipt":true,"isAutomaticReviewsEnabled":true,"rating":123,"domain":"\u003cstring>","isCustomerBalanceEnabled":true,"isBalanceTopUpEnabled":true,"isKomerzaPayEnabled":true,"isSplitPaymentEnabled":true,"branding":{"bannerFileName":"\u003cstring>","iconFileName":"\u003cstring>","accentColor":"\u003cstring>"},"isTicketingEnabled":true,"isDownloadCenterEnabled":true,"showPublicStats":true,"showRecentOrderToasts":true,"enableCartRecovery":true,"isInactive":true,"googleSiteVerification":"\u003cstring>","customDomain":"\u003cstring>","scopes":["\u003cstring>"],"maintenanceReason":"\u003cstring>","termsOfServiceUrl":"\u003cstring>","refundPolicyUrl":"\u003cstring>","privacyPolicyUrl":"\u003cstring>","affiliateOptions":{"isEnabled":true,"defaultReturnPercentage":50,"canConvertAffiliateBalance":true,"isPublicRegistrationEnabled":true,"isLinkEditingEnabled":true,"defaultPercentageOff":50},"externalSupportUrl":"\u003cstring>","externalSupportDescription":"\u003cstring>","lastOrderAt":"2023-11-07T05:31:56Z"}],"email":"\u003cstring>","userName":"\u003cstring>","plan":"\u003cstring>","isBuyerProtectionManager":true,"twoFactorEnabled":true,"totpEnabled":true,"passkeyEnabled":true,"riskLocked":true,"billingSuspended":true,"integrations":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","application":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","name":"\u003cstring>","permissions":["\u003cstring>"],"redirectUrls":["\u003cstring>"],"userId":"\u003cstring>","imageName":"\u003cstring>","termsOfServiceLink":"\u003cstring>","privacyPolicyLink":"\u003cstring>"}}],"apiKeys":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","label":"\u003cstring>","ipAddresses":["\u003cstring>"],"scopes":["\u003cstring>"],"userId":"\u003cstring>"}],"disabledPaymentMethods":{},"stripeEnabled":true,"nmiEnabled":true,"moneyMotionEnabled":true,"pandabaseEnabled":true,"shopifyEnabled":true,"storrikEnabled":true,"mollieEnabled":true,"northbridgeEnabled":true,"squareEnabled":true,"paypalBusinessEnabled":true,"isCryptoEnabled":true,"isSumUpEnabled":true,"paddleEnabled":true,"fastSpringEnabled":true,"venPayrEnabled":true,"ovgcEnabled":true,"isAuthorizeNetEnabled":true,"restrictedPaymentMethods":["\u003cstring>"],"riskLockedPaymentMethods":["\u003cstring>"],"integrationErrorReports":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","reason":"\u003cstring>","gateway":"\u003cstring>","reporter":"\u003cstring>","resolved":true,"type":"\u003cstring>","userId":"\u003cstring>"}],"lastPasswordUpdate":"2023-11-07T05:31:56Z","signals":{"countryCode":"\u003cstring>","id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","userId":"\u003cstring>","registrationIpAddress":"\u003cstring>","registrationFingerprint":"\u003cstring>","verificationStatus":"\u003cstring>","legalEntityType":"\u003cstring>","taxId":"\u003cstring>","fullName":"\u003cstring>","addressLine1":"\u003cstring>","addressLine2":"\u003cstring>","city":"\u003cstring>","region":"\u003cstring>","postalCode":"\u003cstring>"},"discordWebhookUrl":"\u003cstring>","subscription":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","expiryDate":"2023-12-25","autoRenew":true,"userId":"\u003cstring>","billingInterval":"\u003cstring>","failedPaymentCount":123,"lastSyncedAt":"2023-11-07T05:31:56Z","customerIds":{},"emailMarketingSent":123,"isExpired":true,"startedDate":"2023-12-25","status":"\u003cstring>","trialEndDate":"2023-12-25","planId":"\u003cstring>","lastPaymentFailureDate":"2023-11-07T05:31:56Z","nextRetryDate":"2023-12-25","cancelAt":"2023-11-07T05:31:56Z","canceledAt":"2023-11-07T05:31:56Z","scheduledPlanId":"\u003cstring>","scheduledBillingInterval":"\u003cstring>","lastExpiryReminderDate":"2023-12-25","emailMarketingQuotaResetAt":"2023-11-07T05:31:56Z"},"refreshAt":"2023-11-07T05:31:56Z","billingSuspensionDate":"2023-11-07T05:31:56Z","cashAppOptions":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","isEnabled":true,"isRestricted":true,"isRiskLocked":true,"userId":"\u003cstring>","requireBillingInformation":true,"isAcceptingRequests":true,"notesVersion":0,"restrictionReason":"\u003cstring>","email":"\u003cstring>","tag":"\u003cstring>","customNoteListId":"3c90c3cc-0d44-4b50-8888-8dd25736052a"},"payPalOptions":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","isEnabled":true,"isRestricted":true,"isRiskLocked":true,"userId":"\u003cstring>","requireBillingInformation":true,"isUsingLegacyEmails":true,"isFriendsAndFamilyEnabled":true,"isAcceptingRequests":true,"isAcceptingHeldPayments":true,"notesVersion":0,"restrictionReason":"\u003cstring>","email":"\u003cstring>","payPalEmail":"\u003cstring>","customNoteListId":"3c90c3cc-0d44-4b50-8888-8dd25736052a"},"storrikOptions":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","isEnabled":true,"isRestricted":true,"isRiskLocked":true,"userId":"\u003cstring>","requireBillingInformation":true,"restrictionReason":"\u003cstring>"},"payPalBusinessOptions":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","isEnabled":true,"isRestricted":true,"isRiskLocked":true,"userId":"\u003cstring>","requireBillingInformation":true,"isUsingLegacyIntegration":true,"forceCardOnly":true,"restrictionReason":"\u003cstring>","oAuthClientId":"\u003cstring>","emailAddress":"\u003cstring>"},"stripeOptions":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","isEnabled":true,"isRestricted":true,"isRiskLocked":true,"userId":"\u003cstring>","requireBillingInformation":true,"restrictionReason":"\u003cstring>","paymentMethodConfigurationId":"\u003cstring>","publishableKey":"\u003cstring>"},"squareOptions":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","isEnabled":true,"isRestricted":true,"isRiskLocked":true,"userId":"\u003cstring>","requireBillingInformation":true,"applicationId":"\u003cstring>","locationId":"\u003cstring>","restrictionReason":"\u003cstring>"},"mollieOptions":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","isEnabled":true,"isRestricted":true,"isRiskLocked":true,"userId":"\u003cstring>","requireBillingInformation":true,"profileId":"\u003cstring>","restrictionReason":"\u003cstring>"},"northbridgeOptions":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","isEnabled":true,"isRestricted":true,"isRiskLocked":true,"userId":"\u003cstring>","requireBillingInformation":true,"restrictionReason":"\u003cstring>"},"nmiOptions":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","isEnabled":true,"isRestricted":true,"isRiskLocked":true,"userId":"\u003cstring>","requireBillingInformation":true,"gatewayUrl":"\u003cstring>","publicKey":"\u003cstring>","threeDSecureEnabled":true,"threeDSecureRequired":true,"threeDSecureRequireVerified":true,"rejectAvsAddressMismatch":true,"rejectAvsZipMismatch":true,"rejectCvvMismatch":true,"rejectAvsUnavailable":true,"kountEnabled":true,"restrictionReason":"\u003cstring>","kountMerchantId":"\u003cstring>"},"paddleOptions":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","isEnabled":true,"isRestricted":true,"isRiskLocked":true,"userId":"\u003cstring>","requireBillingInformation":true,"restrictionReason":"\u003cstring>"},"fastSpringOptions":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","isEnabled":true,"isRestricted":true,"isRiskLocked":true,"userId":"\u003cstring>","requireBillingInformation":true,"restrictionReason":"\u003cstring>"},"shopifyOptions":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","isEnabled":true,"isRestricted":true,"isRiskLocked":true,"userId":"\u003cstring>","requireBillingInformation":true,"shopUrl":"\u003cstring>","restrictionReason":"\u003cstring>"},"cryptocurrencyOptions":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","isEnabled":true,"isRestricted":true,"isRiskLocked":true,"userId":"\u003cstring>","requireBillingInformation":true,"disabledCryptocurrencies":["\u003cstring>"],"restrictionReason":"\u003cstring>"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"21083965-dc25-4836-b122-8ce07dd284c2":{"description":"You are not authorized, check your API key and try again.","content":{"text/plain":{"schema":{"required":["success"],"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the operation or response was successful.","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"oneOf":[{"type":"string","description":"A descriptive message providing additional context or information about the response.","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"A descriptive message providing additional context or information about the response.","uniqueKey":"message.oneOf.1","typeLabel":"null"}],"uniqueKey":"message","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","description":"The error code (if there was an error) to use when referencing the error","uniqueKey":"code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The error code (if there was an error) to use when referencing the error","uniqueKey":"code.oneOf.1","typeLabel":"null"}],"uniqueKey":"code","typeLabel":"string | null"},"data":{"oneOf":[{"description":"Represents the data associated with a response.","uniqueKey":"data.oneOf.0","typeLabel":"any"},{"description":"Represents the data associated with a response.","type":"null","uniqueKey":"data.oneOf.1","typeLabel":"null"}],"uniqueKey":"data","typeLabel":"any | null"}},"additionalProperties":false,"description":"Represents a default generic response for API endpoints.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"message":"\u003cstring>","code":"\u003cstring>","data":"\u003cunknown>"}}},"exampleType":"generated"},"application/json":{"schema":{"required":["success"],"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the operation or response was successful.","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"oneOf":[{"type":"string","description":"A descriptive message providing additional context or information about the response.","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"A descriptive message providing additional context or information about the response.","uniqueKey":"message.oneOf.1","typeLabel":"null"}],"uniqueKey":"message","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","description":"The error code (if there was an error) to use when referencing the error","uniqueKey":"code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The error code (if there was an error) to use when referencing the error","uniqueKey":"code.oneOf.1","typeLabel":"null"}],"uniqueKey":"code","typeLabel":"string | null"},"data":{"oneOf":[{"description":"Represents the data associated with a response.","uniqueKey":"data.oneOf.0","typeLabel":"any"},{"description":"Represents the data associated with a response.","type":"null","uniqueKey":"data.oneOf.1","typeLabel":"null"}],"uniqueKey":"data","typeLabel":"any | null"}},"additionalProperties":false,"description":"Represents a default generic response for API endpoints.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"message":"\u003cstring>","code":"\u003cstring>","data":"\u003cunknown>"}}},"exampleType":"generated"},"text/json":{"schema":{"required":["success"],"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the operation or response was successful.","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"oneOf":[{"type":"string","description":"A descriptive message providing additional context or information about the response.","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"A descriptive message providing additional context or information about the response.","uniqueKey":"message.oneOf.1","typeLabel":"null"}],"uniqueKey":"message","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","description":"The error code (if there was an error) to use when referencing the error","uniqueKey":"code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The error code (if there was an error) to use when referencing the error","uniqueKey":"code.oneOf.1","typeLabel":"null"}],"uniqueKey":"code","typeLabel":"string | null"},"data":{"oneOf":[{"description":"Represents the data associated with a response.","uniqueKey":"data.oneOf.0","typeLabel":"any"},{"description":"Represents the data associated with a response.","type":"null","uniqueKey":"data.oneOf.1","typeLabel":"null"}],"uniqueKey":"data","typeLabel":"any | null"}},"additionalProperties":false,"description":"Represents a default generic response for API endpoints.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"message":"\u003cstring>","code":"\u003cstring>","data":"\u003cunknown>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"aa17cceb-4c1e-42f0-8e8d-e9efcfdf2797":{"bearer":{"type":"http","description":"Your API key goes here","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearer"}}},"servers":{"c163b8df-bb70-462c-8f9f-8d6477f309a9":{"url":"https://api.komerza.com","description":"The production Komerza API"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","description":"Your API key goes here","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Your API key goes here","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearer","name":"Authorization"}],"title":"bearer"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"komerza","siteName":"Komerza Documentation","title":"Get User - Komerza Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/endpoint/users/get","matchLevel":0},"fr":{"href":"/api-reference/endpoint/users/get","matchLevel":0},"de":{"href":"/api-reference/endpoint/users/get","matchLevel":0},"pl":{"href":"/api-reference/endpoint/users/get","matchLevel":0},"es":{"href":"/api-reference/endpoint/users/get","matchLevel":0}}},"lastModified":"2026-08-22T15:05:35.144Z","gitLastModified":"2025-12-01T14:51:44.000Z","originalFileLocation":"api-reference/endpoint/users/get.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns the currently authenticated user’s profile data. Requires the user.view permission.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Komerza Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/komerza/iqYRnvBA9e16yiP0/_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/komerza/iqYRnvBA9e16yiP0/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/komerza/iqYRnvBA9e16yiP0/_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/komerza/iqYRnvBA9e16yiP0/_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/komerza/iqYRnvBA9e16yiP0/_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/komerza/iqYRnvBA9e16yiP0/_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/komerza/iqYRnvBA9e16yiP0/_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/komerza/iqYRnvBA9e16yiP0/_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/komerza/iqYRnvBA9e16yiP0/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get User - Komerza Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns the currently authenticated user’s profile data. Requires the user.view permission.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Komerza Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.komerza.com/api-reference/endpoint/users/get\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://komerza.mintlify.app/_mintlify/api/og/v2?division=User\u0026amp;title=Get+User\u0026amp;description=Returns+the+currently+authenticated+user%E2%80%99s+profile+data.%0ARequires+the+%60user.view%60+permission.\u0026amp;theme=ddc75211e622c8b9003b058b\u0026amp;signature=fa2be8f102fec10e389f53cd05afbbcedec4bec0d9c5e8effa5f406115269f7d\">\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 User - Komerza Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns the currently authenticated user’s profile data. Requires the user.view permission.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://komerza.mintlify.app/_mintlify/api/og/v2?division=User\u0026amp;title=Get+User\u0026amp;description=Returns+the+currently+authenticated+user%E2%80%99s+profile+data.%0ARequires+the+%60user.view%60+permission.\u0026amp;theme=ddc75211e622c8b9003b058b\u0026amp;signature=fa2be8f102fec10e389f53cd05afbbcedec4bec0d9c5e8effa5f406115269f7d\">\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/komerza/iqYRnvBA9e16yiP0/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Komerza Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3b82f6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.komerza.com/api-reference/endpoint/users/get\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/users/get.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.komerza.com/#organization\",\"name\":\"Komerza Documentation\",\"url\":\"https://docs.komerza.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/komerza/b8Ru_h-4KK1SQzzO/logo/light.svg?fit=max\u0026auto=format\u0026n=b8Ru_h-4KK1SQzzO\u0026q=85\u0026s=0f9ba8d2c97d0b7886be5ab88b8a1521\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.komerza.com#website\",\"name\":\"Komerza Documentation\",\"url\":\"https://docs.komerza.com\",\"publisher\":{\"@id\":\"https://docs.komerza.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.komerza.com/api-reference/endpoint/users/get#webpage\",\"url\":\"https://docs.komerza.com/api-reference/endpoint/users/get\",\"name\":\"Get User\",\"description\":\"Returns the currently authenticated user’s profile data. Requires the user.view permission.\",\"dateModified\":\"2025-12-01T14:51:44.000Z\",\"isPartOf\":{\"@id\":\"https://docs.komerza.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.komerza.com/api-reference/endpoint/users/get#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.komerza.com/api-reference/endpoint/users/get#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Komerza Documentation\",\"item\":\"https://docs.komerza.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get User\",\"item\":\"https://docs.komerza.com/api-reference/endpoint/users/get\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.komerza.com/api-reference/endpoint/users/get#apireference\",\"headline\":\"Get User\",\"name\":\"Get User\",\"description\":\"Returns the currently authenticated user’s profile data. Requires the user.view permission.\",\"url\":\"https://docs.komerza.com/api-reference/endpoint/users/get\",\"mainEntityOfPage\":{\"@id\":\"https://docs.komerza.com/api-reference/endpoint/users/get#webpage\"},\"dateModified\":\"2025-12-01T14:51:44.000Z\",\"publisher\":{\"@id\":\"https://docs.komerza.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.komerza.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Komerza Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Komerza Documentation","nav":{"global":{"anchors":[{"anchor":"System Status","icon":"wave-pulse","href":"https://status.komerza.com"},{"anchor":"Telegram","icon":"telegram","href":"https://t.me/komerzaecom"},{"anchor":"Discord","icon":"discord","href":"https://discord.gg/komerza"}]},"languages":[{"language":"en","tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Quick Start","href":"/api-reference/quickstart"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Scopes","href":"/api-reference/scopes"},{"title":"SDKs","href":"/api-reference/sdks"}]},{"group":"Reference","pages":[{"title":"Conventions","href":"/api-reference/conventions"},{"title":"Responses \u0026 Errors","href":"/api-reference/responses"},{"title":"Filtering \u0026 Sorting","href":"/api-reference/filtering"},{"title":"Enums \u0026 Constants","href":"/api-reference/enums"},{"title":"Error Codes","href":"/api-reference/error-codes"},{"title":"Payment Methods","href":"/api-reference/payment-methods"},{"title":"Order Status","href":"/api-reference/payment-status"}]},{"group":"OAuth2","pages":[{"title":"OAuth2 Integration","href":"/api-reference/oauth2/introduction"},{"title":"Exchange Code","openapi":"GET /oauth2/{appId}/exchange/{code}","description":null,"href":"/api-reference/oauth2/exchange"}]},{"group":"User","pages":[{"title":"Get User","openapi":"GET /user","href":"/api-reference/endpoint/users/get"}]},{"group":"Stores","pages":[{"title":"Get Store","openapi":"GET /stores/{storeId}","description":"Retrieves the specified store's reference information.\nRequires the `stores.view` permission.","href":"/api-reference/endpoint/stores/get"},{"title":"Create Store","openapi":"POST /stores","href":"/api-reference/endpoint/stores/create"},{"title":"Update Store","openapi":"PUT /stores/{storeId}","href":"/api-reference/endpoint/stores/update"},{"title":"Maintenance Mode","openapi":"PUT /stores/{storeId}/maintenance","href":"/api-reference/endpoint/stores/update-maintenance"}]},{"group":"Products","pages":[{"title":"Get Product","openapi":"GET /stores/{storeId}/products/{productId}","href":"/api-reference/endpoint/products/get"},{"title":"Search Products","openapi":"GET /stores/{storeId}/products/search/{query}","href":"/api-reference/endpoint/products/search"},{"title":"Get Product by Slug","openapi":"GET /stores/{storeId}/products/slug/{slug}","href":"/api-reference/endpoint/products/get-slug"},{"title":"Get All Products","openapi":"GET /stores/{storeId}/products/all","href":"/api-reference/endpoint/products/get-all"},{"title":"Get Products","openapi":"GET /stores/{storeId}/products","href":"/api-reference/endpoint/products/get-list"},{"title":"Create Product","openapi":"POST /stores/{storeId}/products","href":"/api-reference/endpoint/products/create"},{"title":"Delete Product","openapi":"DELETE /stores/{storeId}/products/{productId}","href":"/api-reference/endpoint/products/delete"},{"title":"Update Product","openapi":"PUT /stores/{storeId}/products/{productId}","href":"/api-reference/endpoint/products/update"},{"title":"Update Payment Settings","openapi":"PUT /stores/{storeId}/products/{productId}/payment","href":"/api-reference/endpoint/products/update-payment"},{"title":"Bulk Update Products","openapi":"PUT /stores/{storeId}/products","href":"/api-reference/endpoint/products/update-bulk"},{"title":"Order Products","openapi":"PATCH /stores/{storeId}/products/order","href":"/api-reference/endpoint/products/order"},{"title":"Order Product Images","openapi":"PATCH /stores/{storeId}/products/{productId}/images/order","href":"/api-reference/endpoint/products/order-images"},{"title":"Duplicate Product","openapi":"POST /stores/{storeId}/products/{productId}/duplicate","href":"/api-reference/endpoint/products/duplicate"},{"title":"Update Affiliate Discount","openapi":"PUT /stores/{storeId}/products/{productId}/affiliateDiscount","href":"/api-reference/endpoint/products/update-affiliate-discount"},{"title":"Update Product Badges","openapi":"PUT /stores/{storeId}/products/{productId}/badges","href":"/api-reference/endpoint/products/update-badges"},{"title":"Update Product Security","openapi":"PUT /stores/{storeId}/products/{productId}/security","href":"/api-reference/endpoint/products/update-security"},{"title":"Bulk Delete Products","openapi":"DELETE /stores/{storeId}/products","href":"/api-reference/endpoint/products/delete-bulk"}]},{"group":"Categories","pages":[{"title":"Get Category","openapi":"GET /stores/{storeId}/categories/{categoryId}","href":"/api-reference/endpoint/categories/get"},{"title":"Get Categories","openapi":"GET /stores/{storeId}/categories","href":"/api-reference/endpoint/categories/get-list"},{"title":"Get All Categories","openapi":"GET /stores/{storeId}/categories/all","href":"/api-reference/endpoint/categories/get-all"},{"title":"Create Category","openapi":"POST /stores/{storeId}/categories","href":"/api-reference/endpoint/categories/create"},{"title":"Update Category","openapi":"PUT /stores/{storeId}/categories/{categoryId}","href":"/api-reference/endpoint/categories/update"},{"title":"Delete Category","openapi":"DELETE /stores/{storeId}/categories/{categoryId}","href":"/api-reference/endpoint/categories/delete"},{"title":"Order Categories","openapi":"PATCH /stores/{storeId}/categories/order","href":"/api-reference/endpoint/categories/order"},{"title":"Order Products in Category","openapi":"PATCH /stores/{storeId}/categories/{categoryId}/products/order","href":"/api-reference/endpoint/categories/order-products"}]},{"group":"Variants","pages":[{"title":"Get Variant","openapi":"GET /stores/{storeId}/products/{productId}/variants/{variantId}","href":"/api-reference/endpoint/variants/get"},{"title":"Get License Keys","openapi":"GET /stores/{storeId}/products/{productId}/variants/{variantId}/items/{page}","href":"/api-reference/endpoint/variants/get-items"},{"title":"Create Variant","openapi":"POST /stores/{storeId}/products/{productId}/variants","href":"/api-reference/endpoint/variants/create"},{"title":"Create Field","openapi":"POST /stores/{storeId}/products/{productId}/variants/{variantId}/fields","href":"/api-reference/endpoint/variants/fields/create"},{"title":"Create Field Option","openapi":"POST /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}/options","href":"/api-reference/endpoint/variants/fields/options/create"},{"title":"Add License Keys","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/items","href":"/api-reference/endpoint/variants/add-items"},{"title":"Update Variant","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}","href":"/api-reference/endpoint/variants/update"},{"title":"Update Delivery Settings","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/delivery","href":"/api-reference/endpoint/variants/update-delivery"},{"title":"Update Field","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}","href":"/api-reference/endpoint/variants/fields/update"},{"title":"Update Field Option","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}/options/{optionId}","href":"/api-reference/endpoint/variants/fields/options/update"},{"title":"Order Variant Images","openapi":"PATCH /stores/{storeId}/products/{productId}/variants/{variantId}/images/order","href":"/api-reference/endpoint/variants/order-images"},{"title":"Delete License Keys","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/items","href":"/api-reference/endpoint/variants/delete-items"},{"title":"Clear License Keys","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/items/clear","href":"/api-reference/endpoint/variants/clear-items"},{"title":"Delete Variant","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}","href":"/api-reference/endpoint/variants/delete"},{"title":"Delete Field","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}","href":"/api-reference/endpoint/variants/fields/delete"},{"title":"Delete Field Option","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}/options/{optionId}","href":"/api-reference/endpoint/variants/fields/options/delete"},{"title":"Order Variants","openapi":"PATCH /stores/{storeId}/products/{productId}/variants/order","href":"/api-reference/endpoint/variants/order"},{"title":"Duplicate Variant","openapi":"POST /stores/{storeId}/products/{productId}/variants/{variantId}/duplicate","href":"/api-reference/endpoint/variants/duplicate"},{"title":"Search License Keys","openapi":"GET /stores/{storeId}/products/{productId}/variants/{variantId}/items/search/{query}","href":"/api-reference/endpoint/variants/search-items"},{"title":"Remove File from Variant","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/file/{fileId}","href":"/api-reference/endpoint/variants/delete-file"},{"title":"Get Volume Discounts","openapi":"GET /stores/{storeId}/products/{productId}/variants/{variantId}/discounts","href":"/api-reference/endpoint/variants/discounts/get"},{"title":"Create Volume Discount","openapi":"POST /stores/{storeId}/products/{productId}/variants/{variantId}/discounts","href":"/api-reference/endpoint/variants/discounts/create"},{"title":"Replace Volume Discounts","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/discounts","href":"/api-reference/endpoint/variants/discounts/replace"},{"title":"Update Volume Discount","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/discounts/{discountId}","href":"/api-reference/endpoint/variants/discounts/update"},{"title":"Delete Volume Discount","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/discounts/{discountId}","href":"/api-reference/endpoint/variants/discounts/delete"}]},{"group":"Coupons","pages":[{"title":"Get Coupon","openapi":"GET /stores/{storeId}/coupons/{couponId}","href":"/api-reference/endpoint/coupons/get"},{"title":"Get Coupons","openapi":"GET /stores/{storeId}/coupons","href":"/api-reference/endpoint/coupons/get-list"},{"title":"Get All Coupons","openapi":"GET /stores/{storeId}/coupons/all","href":"/api-reference/endpoint/coupons/get-all"},{"title":"Search Coupons","openapi":"GET /stores/{storeId}/coupons/search/{query}","href":"/api-reference/endpoint/coupons/search"},{"title":"Create Coupon","openapi":"POST /stores/{storeId}/coupons","href":"/api-reference/endpoint/coupons/create"},{"title":"Update Coupon","openapi":"PUT /stores/{storeId}/coupons/{couponId}","href":"/api-reference/endpoint/coupons/update"},{"title":"Delete Coupon","openapi":"DELETE /stores/{storeId}/coupons/{couponId}","href":"/api-reference/endpoint/coupons/delete"}]},{"group":"Tickets","pages":[{"title":"Get Ticket","openapi":"GET /stores/{storeId}/tickets/{ticketId}","href":"/api-reference/endpoint/tickets/get"},{"title":"Get Tickets","openapi":"GET /stores/{storeId}/tickets","href":"/api-reference/endpoint/tickets/get-list"},{"title":"Add Ticket Response","openapi":"PUT /stores/{storeId}/tickets/{ticketId}","href":"/api-reference/endpoint/tickets/add"},{"title":"Close Ticket","openapi":"DELETE /stores/{storeId}/tickets/{ticketId}","href":"/api-reference/endpoint/tickets/delete"}]},{"group":"Customers","pages":[{"title":"Get Customer","openapi":"GET /stores/{storeId}/customers/{customerId}","href":"/api-reference/endpoint/customers/get"},{"title":"Get Customers","openapi":"GET /stores/{storeId}/customers","href":"/api-reference/endpoint/customers/get-list"},{"title":"Search Customers","openapi":"GET /stores/{storeId}/customers/search/{query}","href":"/api-reference/endpoint/customers/search"},{"title":"Create Customer","openapi":"POST /stores/{storeId}/customers","href":"/api-reference/endpoint/customers/create"},{"title":"Update Customer Balance","openapi":"PATCH /stores/{storeId}/customers/{customerId}/balance","href":"/api-reference/endpoint/customers/update-balance"},{"title":"Get Customer by Email","openapi":"GET /stores/{storeId}/customers/{customerEmail}/email","href":"/api-reference/endpoint/customers/get-by-email"}]},{"group":"Orders","pages":[{"title":"Get Order","openapi":"GET /stores/{storeId}/orders/{orderId}","href":"/api-reference/endpoint/orders/get"},{"title":"Get Orders","openapi":"GET /stores/{storeId}/orders","href":"/api-reference/endpoint/orders/get-list"},{"title":"Search Orders","openapi":"GET /stores/{storeId}/orders/search/{query}","href":"/api-reference/endpoint/orders/search"},{"title":"Create Order","openapi":"POST /stores/{storeId}/orders","href":"/api-reference/endpoint/orders/create"},{"title":"Deliver Order","openapi":"PUT /stores/{storeId}/orders/{orderId}/deliver","href":"/api-reference/endpoint/orders/deliver"},{"title":"Refund Order","openapi":"DELETE /stores/{storeId}/orders/{orderId}/refund","href":"/api-reference/endpoint/orders/refund"},{"title":"Re-deliver Order","openapi":"PUT /stores/{storeId}/orders/{orderId}/redeliver","href":"/api-reference/endpoint/orders/redeliver"},{"title":"Get Proof of Payment","openapi":"GET /stores/{storeId}/paymentMethods/custom/orders/{orderId}/proof","href":"/api-reference/endpoint/orders/get-payment-proof"}]},{"group":"Reviews","pages":[{"title":"Get Reviews","openapi":"GET /stores/{storeId}/reviews","href":"/api-reference/endpoint/reviews/get-list"},{"title":"Reply to Review","openapi":"PUT /stores/{storeId}/reviews/{reviewId}/reply","href":"/api-reference/endpoint/reviews/reply"},{"title":"Get Review Analytics","openapi":"GET /stores/{storeId}/reviews/analytics","href":"/api-reference/endpoint/reviews/analytics"}]},{"group":"Affiliates","pages":[{"title":"Get Affiliates","openapi":"GET /stores/{storeId}/affiliates","href":"/api-reference/endpoint/affiliates/get-list"},{"title":"Search Affiliates","openapi":"GET /stores/{storeId}/affiliates/search","href":"/api-reference/endpoint/affiliates/search"},{"title":"Get Affiliate Statistics","openapi":"GET /stores/{storeId}/affiliates/stats","href":"/api-reference/endpoint/affiliates/stats"},{"title":"Create Affiliate","openapi":"POST /stores/{storeId}/affiliates/{customerId}","href":"/api-reference/endpoint/affiliates/create"},{"title":"Update Affiliate","openapi":"PUT /stores/{storeId}/affiliates/{customerId}","href":"/api-reference/endpoint/affiliates/update"},{"title":"Delete Affiliate","openapi":"DELETE /stores/{storeId}/affiliates/{customerId}","href":"/api-reference/endpoint/affiliates/delete"},{"title":"Invite Affiliate","openapi":"POST /stores/{storeId}/affiliates/invite","href":"/api-reference/endpoint/affiliates/invite"},{"title":"Blacklist Affiliate","openapi":"POST /stores/{storeId}/affiliates/{customerId}/blacklist","href":"/api-reference/endpoint/affiliates/blacklist"},{"title":"Configure Affiliate Program","openapi":"PUT /stores/{storeId}/affiliates/configure","href":"/api-reference/endpoint/affiliates/configure"},{"title":"List Affiliate Orders","openapi":"GET /stores/{storeId}/affiliates/{customerId}/orders/{page}","href":"/api-reference/endpoint/affiliates/get-orders"},{"title":"List Affiliate Payouts","openapi":"GET /stores/{storeId}/affiliates/{customerId}/payouts/{page}","href":"/api-reference/endpoint/affiliates/get-payouts"},{"title":"Record Affiliate Payout","openapi":"POST /stores/{storeId}/affiliates/{customerId}/payouts","href":"/api-reference/endpoint/affiliates/record-payout"},{"title":"Void Affiliate Payout","openapi":"PATCH /stores/{storeId}/affiliates/{customerId}/payouts/{payoutId}","href":"/api-reference/endpoint/affiliates/void-payout"}]},{"group":"Affiliate API","pages":[{"title":"Affiliate API","href":"/api-reference/affiliate-api"},{"title":"Get Affiliate Account","openapi":"GET /affiliate","href":"/api-reference/endpoint/affiliate/get-account"},{"title":"List Affiliate Discounts","openapi":"GET /affiliate/discounts","href":"/api-reference/endpoint/affiliate/get-discounts"},{"title":"List Referred Orders","openapi":"GET /affiliate/orders","href":"/api-reference/endpoint/affiliate/get-orders"},{"title":"List Received Payouts","openapi":"GET /affiliate/payouts","href":"/api-reference/endpoint/affiliate/get-payouts"},{"title":"Get Referral Statistics","openapi":"GET /affiliate/stats","href":"/api-reference/endpoint/affiliate/stats"}]},{"group":"Reseller Programme","pages":[{"title":"Get Programme","openapi":"GET /stores/{storeId}/reseller","href":"/api-reference/endpoint/reseller-programme/get"},{"title":"Configure Programme","openapi":"PUT /stores/{storeId}/reseller","href":"/api-reference/endpoint/reseller-programme/configure"},{"title":"Get Catalogue","openapi":"GET /stores/{storeId}/reseller/catalogue","href":"/api-reference/endpoint/reseller-programme/get-catalogue"},{"title":"Add to Catalogue","openapi":"PUT /stores/{storeId}/reseller/catalogue/{variantId}","href":"/api-reference/endpoint/reseller-programme/add-to-catalogue"},{"title":"Remove from Catalogue","openapi":"DELETE /stores/{storeId}/reseller/catalogue/{variantId}","href":"/api-reference/endpoint/reseller-programme/remove-from-catalogue"},{"title":"Get Variant Stats","openapi":"GET /stores/{storeId}/reseller/catalogue/{variantId}/stats","href":"/api-reference/endpoint/reseller-programme/get-variant-stats"},{"title":"Set Volume Tiers","openapi":"PUT /stores/{storeId}/reseller/catalogue/{variantId}/tiers","href":"/api-reference/endpoint/reseller-programme/set-volume-tiers"},{"title":"Get Resellers","openapi":"GET /stores/{storeId}/reseller/resellers","href":"/api-reference/endpoint/reseller-programme/get-resellers"},{"title":"Update Status","openapi":"PUT /stores/{storeId}/reseller/resellers/{resellerId}/status","href":"/api-reference/endpoint/reseller-programme/update-status"},{"title":"Grant Samples","openapi":"POST /stores/{storeId}/reseller/resellers/{resellerId}/samples","href":"/api-reference/endpoint/reseller-programme/grant-samples"},{"title":"Get Invitations","openapi":"GET /stores/{storeId}/reseller/invites","href":"/api-reference/endpoint/reseller-programme/get-invites"},{"title":"Create Invitation","openapi":"POST /stores/{storeId}/reseller/invites","href":"/api-reference/endpoint/reseller-programme/create-invite"},{"title":"Delete Invitation","openapi":"DELETE /stores/{storeId}/reseller/invites/{inviteId}","href":"/api-reference/endpoint/reseller-programme/delete-invite"},{"title":"Get Questions","openapi":"GET /stores/{storeId}/reseller/application/questions","href":"/api-reference/endpoint/reseller-programme/get-questions"},{"title":"Create Question","openapi":"POST /stores/{storeId}/reseller/application/questions","href":"/api-reference/endpoint/reseller-programme/create-question"},{"title":"Update Question","openapi":"PUT /stores/{storeId}/reseller/application/questions/{questionId}","href":"/api-reference/endpoint/reseller-programme/update-question"},{"title":"Delete Question","openapi":"DELETE /stores/{storeId}/reseller/application/questions/{questionId}","href":"/api-reference/endpoint/reseller-programme/delete-question"},{"title":"Get Applications","openapi":"GET /stores/{storeId}/reseller/application/submissions","href":"/api-reference/endpoint/reseller-programme/get-applications"},{"title":"Create Application","openapi":"POST /stores/{storeId}/reseller/applications","href":"/api-reference/endpoint/reseller-programme/create-application"},{"title":"Get Bundles","openapi":"GET /stores/{storeId}/reseller/bundles","href":"/api-reference/endpoint/reseller-programme/get-bundles"},{"title":"Create Bundle","openapi":"POST /stores/{storeId}/reseller/bundles","href":"/api-reference/endpoint/reseller-programme/create-bundle"},{"title":"Update Bundle","openapi":"PUT /stores/{storeId}/reseller/bundles/{bundleId}","href":"/api-reference/endpoint/reseller-programme/update-bundle"},{"title":"Delete Bundle","openapi":"DELETE /stores/{storeId}/reseller/bundles/{bundleId}","href":"/api-reference/endpoint/reseller-programme/delete-bundle"},{"title":"Get Basket Discounts","openapi":"GET /stores/{storeId}/reseller/basket-tiers","href":"/api-reference/endpoint/reseller-programme/get-basket-tiers"},{"title":"Create Basket Discount","openapi":"POST /stores/{storeId}/reseller/basket-tiers","href":"/api-reference/endpoint/reseller-programme/create-basket-tier"},{"title":"Update Basket Discount","openapi":"PUT /stores/{storeId}/reseller/basket-tiers/{basketTierId}","href":"/api-reference/endpoint/reseller-programme/update-basket-tier"},{"title":"Delete Basket Discount","openapi":"DELETE /stores/{storeId}/reseller/basket-tiers/{basketTierId}","href":"/api-reference/endpoint/reseller-programme/delete-basket-tier"},{"title":"Get Leaderboard","openapi":"GET /stores/{storeId}/reseller/leaderboard","href":"/api-reference/endpoint/reseller-programme/get-leaderboard"}]},{"group":"Reselling","pages":[{"title":"Get Suppliers","openapi":"GET /stores/{storeId}/reselling/suppliers","href":"/api-reference/endpoint/reselling/get-suppliers"},{"title":"Find Supplier","openapi":"GET /stores/{storeId}/reselling/suppliers/lookup","href":"/api-reference/endpoint/reselling/find-supplier"},{"title":"Apply to Supplier","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}","href":"/api-reference/endpoint/reselling/apply"},{"title":"Get Catalogue","openapi":"GET /stores/{storeId}/reselling/suppliers/{supplierStoreId}/catalogue","href":"/api-reference/endpoint/reselling/get-catalogue"},{"title":"Get Bundles","openapi":"GET /stores/{storeId}/reselling/suppliers/{supplierStoreId}/bundles","href":"/api-reference/endpoint/reselling/get-bundles"},{"title":"Buy Basket","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}/basket","href":"/api-reference/endpoint/reselling/buy-basket"},{"title":"Quote Basket","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}/basket/quote","href":"/api-reference/endpoint/reselling/quote-basket"},{"title":"Buy Stock","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}/stock","href":"/api-reference/endpoint/reselling/buy-stock"},{"title":"Get Draws","openapi":"GET /stores/{storeId}/reselling/suppliers/{supplierStoreId}/draws","href":"/api-reference/endpoint/reselling/get-draws"},{"title":"Add Funds","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}/topup","href":"/api-reference/endpoint/reselling/add-funds"},{"title":"Get Payment Methods","openapi":"GET /stores/{storeId}/reselling/suppliers/{supplierStoreId}/payment-methods","href":"/api-reference/endpoint/reselling/get-payment-methods"},{"title":"Create Listing","openapi":"PUT /stores/{storeId}/reselling/suppliers/{supplierStoreId}/listings/{sourceVariantId}","href":"/api-reference/endpoint/reselling/create-listing"},{"title":"Delete Listing","openapi":"DELETE /stores/{storeId}/reselling/suppliers/{supplierStoreId}/listings/{sourceVariantId}","href":"/api-reference/endpoint/reselling/delete-listing"},{"title":"Get Resold Products","openapi":"GET /stores/{storeId}/reselling/products","href":"/api-reference/endpoint/reselling/get-products"},{"title":"Get Linkable Accounts","openapi":"GET /stores/{storeId}/reselling/linkable","href":"/api-reference/endpoint/reselling/get-linkable"},{"title":"Link Account","openapi":"POST /stores/{storeId}/reselling/linkable/{resellerId}","href":"/api-reference/endpoint/reselling/link-account"},{"title":"Accept Invitation","openapi":"POST /stores/{storeId}/reselling/invites/accept","href":"/api-reference/endpoint/reselling/accept-invite"}]},{"group":"Webhooks","pages":[{"title":"Get Webhooks","openapi":"GET /webhooks","href":"/api-reference/endpoint/webhooks/get-list"},{"title":"Create Webhook","openapi":"POST /webhooks","href":"/api-reference/endpoint/webhooks/create"},{"title":"Get Webhook","openapi":"GET /webhooks/{webhookId}","href":"/api-reference/endpoint/webhooks/get"},{"title":"Update Webhook","openapi":"PUT /webhooks/{webhookId}","href":"/api-reference/endpoint/webhooks/update"},{"title":"Delete Webhook","openapi":"DELETE /webhooks/{webhookId}","href":"/api-reference/endpoint/webhooks/delete"},{"title":"Get Webhook Logs","openapi":"GET /webhooks/{webhookId}/logs","href":"/api-reference/endpoint/webhooks/get-logs"},{"title":"Resend Webhook","openapi":"POST /webhooks/{webhookId}/logs/{executionLogId}/resend","href":"/api-reference/endpoint/webhooks/resend"},{"title":"Search Webhook Logs","openapi":"GET /webhooks/{webhookId}/logs/search/{query}","href":"/api-reference/endpoint/webhooks/search-logs"}]}]},{"tab":"Storefront SDK","pages":[{"title":"Storefront SDK","href":"/storefront/introduction"}]}]},{"language":"fr","tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/fr"}]},{"tab":"Référence API","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Quick Start","href":"/api-reference/quickstart"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Scopes","href":"/api-reference/scopes"},{"title":"SDKs","href":"/api-reference/sdks"}]},{"group":"Reference","pages":[{"title":"Conventions","href":"/api-reference/conventions"},{"title":"Responses \u0026 Errors","href":"/api-reference/responses"},{"title":"Filtering \u0026 Sorting","href":"/api-reference/filtering"},{"title":"Enums \u0026 Constants","href":"/api-reference/enums"},{"title":"Error Codes","href":"/api-reference/error-codes"},{"title":"Payment Methods","href":"/api-reference/payment-methods"},{"title":"Order Status","href":"/api-reference/payment-status"}]},{"group":"OAuth2","pages":[{"title":"OAuth2 Integration","href":"/api-reference/oauth2/introduction"},{"title":"Exchange Code","openapi":"GET /oauth2/{appId}/exchange/{code}","description":null,"href":"/api-reference/oauth2/exchange"}]},{"group":"User","pages":[{"title":"Get User","openapi":"GET /user","href":"/api-reference/endpoint/users/get"}]},{"group":"Stores","pages":[{"title":"Get Store","openapi":"GET /stores/{storeId}","description":"Retrieves the specified store's reference information.\nRequires the `stores.view` permission.","href":"/api-reference/endpoint/stores/get"},{"title":"Create Store","openapi":"POST /stores","href":"/api-reference/endpoint/stores/create"},{"title":"Update Store","openapi":"PUT /stores/{storeId}","href":"/api-reference/endpoint/stores/update"},{"title":"Maintenance Mode","openapi":"PUT /stores/{storeId}/maintenance","href":"/api-reference/endpoint/stores/update-maintenance"}]},{"group":"Products","pages":[{"title":"Get Product","openapi":"GET /stores/{storeId}/products/{productId}","href":"/api-reference/endpoint/products/get"},{"title":"Search Products","openapi":"GET /stores/{storeId}/products/search/{query}","href":"/api-reference/endpoint/products/search"},{"title":"Get Product by Slug","openapi":"GET /stores/{storeId}/products/slug/{slug}","href":"/api-reference/endpoint/products/get-slug"},{"title":"Get All Products","openapi":"GET /stores/{storeId}/products/all","href":"/api-reference/endpoint/products/get-all"},{"title":"Get Products","openapi":"GET /stores/{storeId}/products","href":"/api-reference/endpoint/products/get-list"},{"title":"Create Product","openapi":"POST /stores/{storeId}/products","href":"/api-reference/endpoint/products/create"},{"title":"Delete Product","openapi":"DELETE /stores/{storeId}/products/{productId}","href":"/api-reference/endpoint/products/delete"},{"title":"Update Product","openapi":"PUT /stores/{storeId}/products/{productId}","href":"/api-reference/endpoint/products/update"},{"title":"Update Payment Settings","openapi":"PUT /stores/{storeId}/products/{productId}/payment","href":"/api-reference/endpoint/products/update-payment"},{"title":"Bulk Update Products","openapi":"PUT /stores/{storeId}/products","href":"/api-reference/endpoint/products/update-bulk"},{"title":"Order Products","openapi":"PATCH /stores/{storeId}/products/order","href":"/api-reference/endpoint/products/order"},{"title":"Order Product Images","openapi":"PATCH /stores/{storeId}/products/{productId}/images/order","href":"/api-reference/endpoint/products/order-images"},{"title":"Duplicate Product","openapi":"POST /stores/{storeId}/products/{productId}/duplicate","href":"/api-reference/endpoint/products/duplicate"},{"title":"Update Affiliate Discount","openapi":"PUT /stores/{storeId}/products/{productId}/affiliateDiscount","href":"/api-reference/endpoint/products/update-affiliate-discount"},{"title":"Update Product Badges","openapi":"PUT /stores/{storeId}/products/{productId}/badges","href":"/api-reference/endpoint/products/update-badges"},{"title":"Update Product Security","openapi":"PUT /stores/{storeId}/products/{productId}/security","href":"/api-reference/endpoint/products/update-security"},{"title":"Bulk Delete Products","openapi":"DELETE /stores/{storeId}/products","href":"/api-reference/endpoint/products/delete-bulk"}]},{"group":"Categories","pages":[{"title":"Get Category","openapi":"GET /stores/{storeId}/categories/{categoryId}","href":"/api-reference/endpoint/categories/get"},{"title":"Get Categories","openapi":"GET /stores/{storeId}/categories","href":"/api-reference/endpoint/categories/get-list"},{"title":"Get All Categories","openapi":"GET /stores/{storeId}/categories/all","href":"/api-reference/endpoint/categories/get-all"},{"title":"Create Category","openapi":"POST /stores/{storeId}/categories","href":"/api-reference/endpoint/categories/create"},{"title":"Update Category","openapi":"PUT /stores/{storeId}/categories/{categoryId}","href":"/api-reference/endpoint/categories/update"},{"title":"Delete Category","openapi":"DELETE /stores/{storeId}/categories/{categoryId}","href":"/api-reference/endpoint/categories/delete"},{"title":"Order Categories","openapi":"PATCH /stores/{storeId}/categories/order","href":"/api-reference/endpoint/categories/order"},{"title":"Order Products in Category","openapi":"PATCH /stores/{storeId}/categories/{categoryId}/products/order","href":"/api-reference/endpoint/categories/order-products"}]},{"group":"Variants","pages":[{"title":"Get Variant","openapi":"GET /stores/{storeId}/products/{productId}/variants/{variantId}","href":"/api-reference/endpoint/variants/get"},{"title":"Get License Keys","openapi":"GET /stores/{storeId}/products/{productId}/variants/{variantId}/items/{page}","href":"/api-reference/endpoint/variants/get-items"},{"title":"Create Variant","openapi":"POST /stores/{storeId}/products/{productId}/variants","href":"/api-reference/endpoint/variants/create"},{"title":"Create Field","openapi":"POST /stores/{storeId}/products/{productId}/variants/{variantId}/fields","href":"/api-reference/endpoint/variants/fields/create"},{"title":"Create Field Option","openapi":"POST /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}/options","href":"/api-reference/endpoint/variants/fields/options/create"},{"title":"Add License Keys","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/items","href":"/api-reference/endpoint/variants/add-items"},{"title":"Update Variant","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}","href":"/api-reference/endpoint/variants/update"},{"title":"Update Delivery Settings","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/delivery","href":"/api-reference/endpoint/variants/update-delivery"},{"title":"Update Field","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}","href":"/api-reference/endpoint/variants/fields/update"},{"title":"Update Field Option","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}/options/{optionId}","href":"/api-reference/endpoint/variants/fields/options/update"},{"title":"Order Variant Images","openapi":"PATCH /stores/{storeId}/products/{productId}/variants/{variantId}/images/order","href":"/api-reference/endpoint/variants/order-images"},{"title":"Delete License Keys","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/items","href":"/api-reference/endpoint/variants/delete-items"},{"title":"Clear License Keys","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/items/clear","href":"/api-reference/endpoint/variants/clear-items"},{"title":"Delete Variant","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}","href":"/api-reference/endpoint/variants/delete"},{"title":"Delete Field","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}","href":"/api-reference/endpoint/variants/fields/delete"},{"title":"Delete Field Option","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}/options/{optionId}","href":"/api-reference/endpoint/variants/fields/options/delete"},{"title":"Order Variants","openapi":"PATCH /stores/{storeId}/products/{productId}/variants/order","href":"/api-reference/endpoint/variants/order"},{"title":"Duplicate Variant","openapi":"POST /stores/{storeId}/products/{productId}/variants/{variantId}/duplicate","href":"/api-reference/endpoint/variants/duplicate"},{"title":"Search License Keys","openapi":"GET /stores/{storeId}/products/{productId}/variants/{variantId}/items/search/{query}","href":"/api-reference/endpoint/variants/search-items"},{"title":"Remove File from Variant","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/file/{fileId}","href":"/api-reference/endpoint/variants/delete-file"},{"title":"Get Volume Discounts","openapi":"GET /stores/{storeId}/products/{productId}/variants/{variantId}/discounts","href":"/api-reference/endpoint/variants/discounts/get"},{"title":"Create Volume Discount","openapi":"POST /stores/{storeId}/products/{productId}/variants/{variantId}/discounts","href":"/api-reference/endpoint/variants/discounts/create"},{"title":"Replace Volume Discounts","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/discounts","href":"/api-reference/endpoint/variants/discounts/replace"},{"title":"Update Volume Discount","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/discounts/{discountId}","href":"/api-reference/endpoint/variants/discounts/update"},{"title":"Delete Volume Discount","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/discounts/{discountId}","href":"/api-reference/endpoint/variants/discounts/delete"}]},{"group":"Coupons","pages":[{"title":"Get Coupon","openapi":"GET /stores/{storeId}/coupons/{couponId}","href":"/api-reference/endpoint/coupons/get"},{"title":"Get Coupons","openapi":"GET /stores/{storeId}/coupons","href":"/api-reference/endpoint/coupons/get-list"},{"title":"Get All Coupons","openapi":"GET /stores/{storeId}/coupons/all","href":"/api-reference/endpoint/coupons/get-all"},{"title":"Search Coupons","openapi":"GET /stores/{storeId}/coupons/search/{query}","href":"/api-reference/endpoint/coupons/search"},{"title":"Create Coupon","openapi":"POST /stores/{storeId}/coupons","href":"/api-reference/endpoint/coupons/create"},{"title":"Update Coupon","openapi":"PUT /stores/{storeId}/coupons/{couponId}","href":"/api-reference/endpoint/coupons/update"},{"title":"Delete Coupon","openapi":"DELETE /stores/{storeId}/coupons/{couponId}","href":"/api-reference/endpoint/coupons/delete"}]},{"group":"Tickets","pages":[{"title":"Get Ticket","openapi":"GET /stores/{storeId}/tickets/{ticketId}","href":"/api-reference/endpoint/tickets/get"},{"title":"Get Tickets","openapi":"GET /stores/{storeId}/tickets","href":"/api-reference/endpoint/tickets/get-list"},{"title":"Add Ticket Response","openapi":"PUT /stores/{storeId}/tickets/{ticketId}","href":"/api-reference/endpoint/tickets/add"},{"title":"Close Ticket","openapi":"DELETE /stores/{storeId}/tickets/{ticketId}","href":"/api-reference/endpoint/tickets/delete"}]},{"group":"Customers","pages":[{"title":"Get Customer","openapi":"GET /stores/{storeId}/customers/{customerId}","href":"/api-reference/endpoint/customers/get"},{"title":"Get Customers","openapi":"GET /stores/{storeId}/customers","href":"/api-reference/endpoint/customers/get-list"},{"title":"Search Customers","openapi":"GET /stores/{storeId}/customers/search/{query}","href":"/api-reference/endpoint/customers/search"},{"title":"Create Customer","openapi":"POST /stores/{storeId}/customers","href":"/api-reference/endpoint/customers/create"},{"title":"Update Customer Balance","openapi":"PATCH /stores/{storeId}/customers/{customerId}/balance","href":"/api-reference/endpoint/customers/update-balance"},{"title":"Get Customer by Email","openapi":"GET /stores/{storeId}/customers/{customerEmail}/email","href":"/api-reference/endpoint/customers/get-by-email"}]},{"group":"Orders","pages":[{"title":"Get Order","openapi":"GET /stores/{storeId}/orders/{orderId}","href":"/api-reference/endpoint/orders/get"},{"title":"Get Orders","openapi":"GET /stores/{storeId}/orders","href":"/api-reference/endpoint/orders/get-list"},{"title":"Search Orders","openapi":"GET /stores/{storeId}/orders/search/{query}","href":"/api-reference/endpoint/orders/search"},{"title":"Create Order","openapi":"POST /stores/{storeId}/orders","href":"/api-reference/endpoint/orders/create"},{"title":"Deliver Order","openapi":"PUT /stores/{storeId}/orders/{orderId}/deliver","href":"/api-reference/endpoint/orders/deliver"},{"title":"Refund Order","openapi":"DELETE /stores/{storeId}/orders/{orderId}/refund","href":"/api-reference/endpoint/orders/refund"},{"title":"Re-deliver Order","openapi":"PUT /stores/{storeId}/orders/{orderId}/redeliver","href":"/api-reference/endpoint/orders/redeliver"},{"title":"Get Proof of Payment","openapi":"GET /stores/{storeId}/paymentMethods/custom/orders/{orderId}/proof","href":"/api-reference/endpoint/orders/get-payment-proof"}]},{"group":"Reviews","pages":[{"title":"Get Reviews","openapi":"GET /stores/{storeId}/reviews","href":"/api-reference/endpoint/reviews/get-list"},{"title":"Reply to Review","openapi":"PUT /stores/{storeId}/reviews/{reviewId}/reply","href":"/api-reference/endpoint/reviews/reply"},{"title":"Get Review Analytics","openapi":"GET /stores/{storeId}/reviews/analytics","href":"/api-reference/endpoint/reviews/analytics"}]},{"group":"Affiliates","pages":[{"title":"Get Affiliates","openapi":"GET /stores/{storeId}/affiliates","href":"/api-reference/endpoint/affiliates/get-list"},{"title":"Search Affiliates","openapi":"GET /stores/{storeId}/affiliates/search","href":"/api-reference/endpoint/affiliates/search"},{"title":"Get Affiliate Statistics","openapi":"GET /stores/{storeId}/affiliates/stats","href":"/api-reference/endpoint/affiliates/stats"},{"title":"Create Affiliate","openapi":"POST /stores/{storeId}/affiliates/{customerId}","href":"/api-reference/endpoint/affiliates/create"},{"title":"Update Affiliate","openapi":"PUT /stores/{storeId}/affiliates/{customerId}","href":"/api-reference/endpoint/affiliates/update"},{"title":"Delete Affiliate","openapi":"DELETE /stores/{storeId}/affiliates/{customerId}","href":"/api-reference/endpoint/affiliates/delete"},{"title":"Invite Affiliate","openapi":"POST /stores/{storeId}/affiliates/invite","href":"/api-reference/endpoint/affiliates/invite"},{"title":"Blacklist Affiliate","openapi":"POST /stores/{storeId}/affiliates/{customerId}/blacklist","href":"/api-reference/endpoint/affiliates/blacklist"},{"title":"Configure Affiliate Program","openapi":"PUT /stores/{storeId}/affiliates/configure","href":"/api-reference/endpoint/affiliates/configure"},{"title":"List Affiliate Orders","openapi":"GET /stores/{storeId}/affiliates/{customerId}/orders/{page}","href":"/api-reference/endpoint/affiliates/get-orders"},{"title":"List Affiliate Payouts","openapi":"GET /stores/{storeId}/affiliates/{customerId}/payouts/{page}","href":"/api-reference/endpoint/affiliates/get-payouts"},{"title":"Record Affiliate Payout","openapi":"POST /stores/{storeId}/affiliates/{customerId}/payouts","href":"/api-reference/endpoint/affiliates/record-payout"},{"title":"Void Affiliate Payout","openapi":"PATCH /stores/{storeId}/affiliates/{customerId}/payouts/{payoutId}","href":"/api-reference/endpoint/affiliates/void-payout"}]},{"group":"Affiliate API","pages":[{"title":"Affiliate API","href":"/api-reference/affiliate-api"},{"title":"Get Affiliate Account","openapi":"GET /affiliate","href":"/api-reference/endpoint/affiliate/get-account"},{"title":"List Affiliate Discounts","openapi":"GET /affiliate/discounts","href":"/api-reference/endpoint/affiliate/get-discounts"},{"title":"List Referred Orders","openapi":"GET /affiliate/orders","href":"/api-reference/endpoint/affiliate/get-orders"},{"title":"List Received Payouts","openapi":"GET /affiliate/payouts","href":"/api-reference/endpoint/affiliate/get-payouts"},{"title":"Get Referral Statistics","openapi":"GET /affiliate/stats","href":"/api-reference/endpoint/affiliate/stats"}]},{"group":"Reseller Programme","pages":[{"title":"Get Programme","openapi":"GET /stores/{storeId}/reseller","href":"/api-reference/endpoint/reseller-programme/get"},{"title":"Configure Programme","openapi":"PUT /stores/{storeId}/reseller","href":"/api-reference/endpoint/reseller-programme/configure"},{"title":"Get Catalogue","openapi":"GET /stores/{storeId}/reseller/catalogue","href":"/api-reference/endpoint/reseller-programme/get-catalogue"},{"title":"Add to Catalogue","openapi":"PUT /stores/{storeId}/reseller/catalogue/{variantId}","href":"/api-reference/endpoint/reseller-programme/add-to-catalogue"},{"title":"Remove from Catalogue","openapi":"DELETE /stores/{storeId}/reseller/catalogue/{variantId}","href":"/api-reference/endpoint/reseller-programme/remove-from-catalogue"},{"title":"Get Variant Stats","openapi":"GET /stores/{storeId}/reseller/catalogue/{variantId}/stats","href":"/api-reference/endpoint/reseller-programme/get-variant-stats"},{"title":"Set Volume Tiers","openapi":"PUT /stores/{storeId}/reseller/catalogue/{variantId}/tiers","href":"/api-reference/endpoint/reseller-programme/set-volume-tiers"},{"title":"Get Resellers","openapi":"GET /stores/{storeId}/reseller/resellers","href":"/api-reference/endpoint/reseller-programme/get-resellers"},{"title":"Update Status","openapi":"PUT /stores/{storeId}/reseller/resellers/{resellerId}/status","href":"/api-reference/endpoint/reseller-programme/update-status"},{"title":"Grant Samples","openapi":"POST /stores/{storeId}/reseller/resellers/{resellerId}/samples","href":"/api-reference/endpoint/reseller-programme/grant-samples"},{"title":"Get Invitations","openapi":"GET /stores/{storeId}/reseller/invites","href":"/api-reference/endpoint/reseller-programme/get-invites"},{"title":"Create Invitation","openapi":"POST /stores/{storeId}/reseller/invites","href":"/api-reference/endpoint/reseller-programme/create-invite"},{"title":"Delete Invitation","openapi":"DELETE /stores/{storeId}/reseller/invites/{inviteId}","href":"/api-reference/endpoint/reseller-programme/delete-invite"},{"title":"Get Questions","openapi":"GET /stores/{storeId}/reseller/application/questions","href":"/api-reference/endpoint/reseller-programme/get-questions"},{"title":"Create Question","openapi":"POST /stores/{storeId}/reseller/application/questions","href":"/api-reference/endpoint/reseller-programme/create-question"},{"title":"Update Question","openapi":"PUT /stores/{storeId}/reseller/application/questions/{questionId}","href":"/api-reference/endpoint/reseller-programme/update-question"},{"title":"Delete Question","openapi":"DELETE /stores/{storeId}/reseller/application/questions/{questionId}","href":"/api-reference/endpoint/reseller-programme/delete-question"},{"title":"Get Applications","openapi":"GET /stores/{storeId}/reseller/application/submissions","href":"/api-reference/endpoint/reseller-programme/get-applications"},{"title":"Create Application","openapi":"POST /stores/{storeId}/reseller/applications","href":"/api-reference/endpoint/reseller-programme/create-application"},{"title":"Get Bundles","openapi":"GET /stores/{storeId}/reseller/bundles","href":"/api-reference/endpoint/reseller-programme/get-bundles"},{"title":"Create Bundle","openapi":"POST /stores/{storeId}/reseller/bundles","href":"/api-reference/endpoint/reseller-programme/create-bundle"},{"title":"Update Bundle","openapi":"PUT /stores/{storeId}/reseller/bundles/{bundleId}","href":"/api-reference/endpoint/reseller-programme/update-bundle"},{"title":"Delete Bundle","openapi":"DELETE /stores/{storeId}/reseller/bundles/{bundleId}","href":"/api-reference/endpoint/reseller-programme/delete-bundle"},{"title":"Get Basket Discounts","openapi":"GET /stores/{storeId}/reseller/basket-tiers","href":"/api-reference/endpoint/reseller-programme/get-basket-tiers"},{"title":"Create Basket Discount","openapi":"POST /stores/{storeId}/reseller/basket-tiers","href":"/api-reference/endpoint/reseller-programme/create-basket-tier"},{"title":"Update Basket Discount","openapi":"PUT /stores/{storeId}/reseller/basket-tiers/{basketTierId}","href":"/api-reference/endpoint/reseller-programme/update-basket-tier"},{"title":"Delete Basket Discount","openapi":"DELETE /stores/{storeId}/reseller/basket-tiers/{basketTierId}","href":"/api-reference/endpoint/reseller-programme/delete-basket-tier"},{"title":"Get Leaderboard","openapi":"GET /stores/{storeId}/reseller/leaderboard","href":"/api-reference/endpoint/reseller-programme/get-leaderboard"}]},{"group":"Reselling","pages":[{"title":"Get Suppliers","openapi":"GET /stores/{storeId}/reselling/suppliers","href":"/api-reference/endpoint/reselling/get-suppliers"},{"title":"Find Supplier","openapi":"GET /stores/{storeId}/reselling/suppliers/lookup","href":"/api-reference/endpoint/reselling/find-supplier"},{"title":"Apply to Supplier","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}","href":"/api-reference/endpoint/reselling/apply"},{"title":"Get Catalogue","openapi":"GET /stores/{storeId}/reselling/suppliers/{supplierStoreId}/catalogue","href":"/api-reference/endpoint/reselling/get-catalogue"},{"title":"Get Bundles","openapi":"GET /stores/{storeId}/reselling/suppliers/{supplierStoreId}/bundles","href":"/api-reference/endpoint/reselling/get-bundles"},{"title":"Buy Basket","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}/basket","href":"/api-reference/endpoint/reselling/buy-basket"},{"title":"Quote Basket","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}/basket/quote","href":"/api-reference/endpoint/reselling/quote-basket"},{"title":"Buy Stock","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}/stock","href":"/api-reference/endpoint/reselling/buy-stock"},{"title":"Get Draws","openapi":"GET /stores/{storeId}/reselling/suppliers/{supplierStoreId}/draws","href":"/api-reference/endpoint/reselling/get-draws"},{"title":"Add Funds","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}/topup","href":"/api-reference/endpoint/reselling/add-funds"},{"title":"Get Payment Methods","openapi":"GET /stores/{storeId}/reselling/suppliers/{supplierStoreId}/payment-methods","href":"/api-reference/endpoint/reselling/get-payment-methods"},{"title":"Create Listing","openapi":"PUT /stores/{storeId}/reselling/suppliers/{supplierStoreId}/listings/{sourceVariantId}","href":"/api-reference/endpoint/reselling/create-listing"},{"title":"Delete Listing","openapi":"DELETE /stores/{storeId}/reselling/suppliers/{supplierStoreId}/listings/{sourceVariantId}","href":"/api-reference/endpoint/reselling/delete-listing"},{"title":"Get Resold Products","openapi":"GET /stores/{storeId}/reselling/products","href":"/api-reference/endpoint/reselling/get-products"},{"title":"Get Linkable Accounts","openapi":"GET /stores/{storeId}/reselling/linkable","href":"/api-reference/endpoint/reselling/get-linkable"},{"title":"Link Account","openapi":"POST /stores/{storeId}/reselling/linkable/{resellerId}","href":"/api-reference/endpoint/reselling/link-account"},{"title":"Accept Invitation","openapi":"POST /stores/{storeId}/reselling/invites/accept","href":"/api-reference/endpoint/reselling/accept-invite"}]},{"group":"Webhooks","pages":[{"title":"Get Webhooks","openapi":"GET /webhooks","href":"/api-reference/endpoint/webhooks/get-list"},{"title":"Create Webhook","openapi":"POST /webhooks","href":"/api-reference/endpoint/webhooks/create"},{"title":"Get Webhook","openapi":"GET /webhooks/{webhookId}","href":"/api-reference/endpoint/webhooks/get"},{"title":"Update Webhook","openapi":"PUT /webhooks/{webhookId}","href":"/api-reference/endpoint/webhooks/update"},{"title":"Delete Webhook","openapi":"DELETE /webhooks/{webhookId}","href":"/api-reference/endpoint/webhooks/delete"},{"title":"Get Webhook Logs","openapi":"GET /webhooks/{webhookId}/logs","href":"/api-reference/endpoint/webhooks/get-logs"},{"title":"Resend Webhook","openapi":"POST /webhooks/{webhookId}/logs/{executionLogId}/resend","href":"/api-reference/endpoint/webhooks/resend"},{"title":"Search Webhook Logs","openapi":"GET /webhooks/{webhookId}/logs/search/{query}","href":"/api-reference/endpoint/webhooks/search-logs"}]}]},{"tab":"SDK Storefront","pages":[{"title":"SDK Storefront","href":"/fr/storefront/introduction"}]}]},{"language":"de","tabs":[{"tab":"Anleitungen","pages":[{"title":"Anleitungen","href":"/de"}]},{"tab":"API-Referenz","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Quick Start","href":"/api-reference/quickstart"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Scopes","href":"/api-reference/scopes"},{"title":"SDKs","href":"/api-reference/sdks"}]},{"group":"Reference","pages":[{"title":"Conventions","href":"/api-reference/conventions"},{"title":"Responses \u0026 Errors","href":"/api-reference/responses"},{"title":"Filtering \u0026 Sorting","href":"/api-reference/filtering"},{"title":"Enums \u0026 Constants","href":"/api-reference/enums"},{"title":"Error Codes","href":"/api-reference/error-codes"},{"title":"Payment Methods","href":"/api-reference/payment-methods"},{"title":"Order Status","href":"/api-reference/payment-status"}]},{"group":"OAuth2","pages":[{"title":"OAuth2 Integration","href":"/api-reference/oauth2/introduction"},{"title":"Exchange Code","openapi":"GET /oauth2/{appId}/exchange/{code}","description":null,"href":"/api-reference/oauth2/exchange"}]},{"group":"User","pages":[{"title":"Get User","openapi":"GET /user","href":"/api-reference/endpoint/users/get"}]},{"group":"Stores","pages":[{"title":"Get Store","openapi":"GET /stores/{storeId}","description":"Retrieves the specified store's reference information.\nRequires the `stores.view` permission.","href":"/api-reference/endpoint/stores/get"},{"title":"Create Store","openapi":"POST /stores","href":"/api-reference/endpoint/stores/create"},{"title":"Update Store","openapi":"PUT /stores/{storeId}","href":"/api-reference/endpoint/stores/update"},{"title":"Maintenance Mode","openapi":"PUT /stores/{storeId}/maintenance","href":"/api-reference/endpoint/stores/update-maintenance"}]},{"group":"Products","pages":[{"title":"Get Product","openapi":"GET /stores/{storeId}/products/{productId}","href":"/api-reference/endpoint/products/get"},{"title":"Search Products","openapi":"GET /stores/{storeId}/products/search/{query}","href":"/api-reference/endpoint/products/search"},{"title":"Get Product by Slug","openapi":"GET /stores/{storeId}/products/slug/{slug}","href":"/api-reference/endpoint/products/get-slug"},{"title":"Get All Products","openapi":"GET /stores/{storeId}/products/all","href":"/api-reference/endpoint/products/get-all"},{"title":"Get Products","openapi":"GET /stores/{storeId}/products","href":"/api-reference/endpoint/products/get-list"},{"title":"Create Product","openapi":"POST /stores/{storeId}/products","href":"/api-reference/endpoint/products/create"},{"title":"Delete Product","openapi":"DELETE /stores/{storeId}/products/{productId}","href":"/api-reference/endpoint/products/delete"},{"title":"Update Product","openapi":"PUT /stores/{storeId}/products/{productId}","href":"/api-reference/endpoint/products/update"},{"title":"Update Payment Settings","openapi":"PUT /stores/{storeId}/products/{productId}/payment","href":"/api-reference/endpoint/products/update-payment"},{"title":"Bulk Update Products","openapi":"PUT /stores/{storeId}/products","href":"/api-reference/endpoint/products/update-bulk"},{"title":"Order Products","openapi":"PATCH /stores/{storeId}/products/order","href":"/api-reference/endpoint/products/order"},{"title":"Order Product Images","openapi":"PATCH /stores/{storeId}/products/{productId}/images/order","href":"/api-reference/endpoint/products/order-images"},{"title":"Duplicate Product","openapi":"POST /stores/{storeId}/products/{productId}/duplicate","href":"/api-reference/endpoint/products/duplicate"},{"title":"Update Affiliate Discount","openapi":"PUT /stores/{storeId}/products/{productId}/affiliateDiscount","href":"/api-reference/endpoint/products/update-affiliate-discount"},{"title":"Update Product Badges","openapi":"PUT /stores/{storeId}/products/{productId}/badges","href":"/api-reference/endpoint/products/update-badges"},{"title":"Update Product Security","openapi":"PUT /stores/{storeId}/products/{productId}/security","href":"/api-reference/endpoint/products/update-security"},{"title":"Bulk Delete Products","openapi":"DELETE /stores/{storeId}/products","href":"/api-reference/endpoint/products/delete-bulk"}]},{"group":"Categories","pages":[{"title":"Get Category","openapi":"GET /stores/{storeId}/categories/{categoryId}","href":"/api-reference/endpoint/categories/get"},{"title":"Get Categories","openapi":"GET /stores/{storeId}/categories","href":"/api-reference/endpoint/categories/get-list"},{"title":"Get All Categories","openapi":"GET /stores/{storeId}/categories/all","href":"/api-reference/endpoint/categories/get-all"},{"title":"Create Category","openapi":"POST /stores/{storeId}/categories","href":"/api-reference/endpoint/categories/create"},{"title":"Update Category","openapi":"PUT /stores/{storeId}/categories/{categoryId}","href":"/api-reference/endpoint/categories/update"},{"title":"Delete Category","openapi":"DELETE /stores/{storeId}/categories/{categoryId}","href":"/api-reference/endpoint/categories/delete"},{"title":"Order Categories","openapi":"PATCH /stores/{storeId}/categories/order","href":"/api-reference/endpoint/categories/order"},{"title":"Order Products in Category","openapi":"PATCH /stores/{storeId}/categories/{categoryId}/products/order","href":"/api-reference/endpoint/categories/order-products"}]},{"group":"Variants","pages":[{"title":"Get Variant","openapi":"GET /stores/{storeId}/products/{productId}/variants/{variantId}","href":"/api-reference/endpoint/variants/get"},{"title":"Get License Keys","openapi":"GET /stores/{storeId}/products/{productId}/variants/{variantId}/items/{page}","href":"/api-reference/endpoint/variants/get-items"},{"title":"Create Variant","openapi":"POST /stores/{storeId}/products/{productId}/variants","href":"/api-reference/endpoint/variants/create"},{"title":"Create Field","openapi":"POST /stores/{storeId}/products/{productId}/variants/{variantId}/fields","href":"/api-reference/endpoint/variants/fields/create"},{"title":"Create Field Option","openapi":"POST /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}/options","href":"/api-reference/endpoint/variants/fields/options/create"},{"title":"Add License Keys","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/items","href":"/api-reference/endpoint/variants/add-items"},{"title":"Update Variant","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}","href":"/api-reference/endpoint/variants/update"},{"title":"Update Delivery Settings","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/delivery","href":"/api-reference/endpoint/variants/update-delivery"},{"title":"Update Field","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}","href":"/api-reference/endpoint/variants/fields/update"},{"title":"Update Field Option","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}/options/{optionId}","href":"/api-reference/endpoint/variants/fields/options/update"},{"title":"Order Variant Images","openapi":"PATCH /stores/{storeId}/products/{productId}/variants/{variantId}/images/order","href":"/api-reference/endpoint/variants/order-images"},{"title":"Delete License Keys","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/items","href":"/api-reference/endpoint/variants/delete-items"},{"title":"Clear License Keys","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/items/clear","href":"/api-reference/endpoint/variants/clear-items"},{"title":"Delete Variant","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}","href":"/api-reference/endpoint/variants/delete"},{"title":"Delete Field","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}","href":"/api-reference/endpoint/variants/fields/delete"},{"title":"Delete Field Option","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}/options/{optionId}","href":"/api-reference/endpoint/variants/fields/options/delete"},{"title":"Order Variants","openapi":"PATCH /stores/{storeId}/products/{productId}/variants/order","href":"/api-reference/endpoint/variants/order"},{"title":"Duplicate Variant","openapi":"POST /stores/{storeId}/products/{productId}/variants/{variantId}/duplicate","href":"/api-reference/endpoint/variants/duplicate"},{"title":"Search License Keys","openapi":"GET /stores/{storeId}/products/{productId}/variants/{variantId}/items/search/{query}","href":"/api-reference/endpoint/variants/search-items"},{"title":"Remove File from Variant","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/file/{fileId}","href":"/api-reference/endpoint/variants/delete-file"},{"title":"Get Volume Discounts","openapi":"GET /stores/{storeId}/products/{productId}/variants/{variantId}/discounts","href":"/api-reference/endpoint/variants/discounts/get"},{"title":"Create Volume Discount","openapi":"POST /stores/{storeId}/products/{productId}/variants/{variantId}/discounts","href":"/api-reference/endpoint/variants/discounts/create"},{"title":"Replace Volume Discounts","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/discounts","href":"/api-reference/endpoint/variants/discounts/replace"},{"title":"Update Volume Discount","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/discounts/{discountId}","href":"/api-reference/endpoint/variants/discounts/update"},{"title":"Delete Volume Discount","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/discounts/{discountId}","href":"/api-reference/endpoint/variants/discounts/delete"}]},{"group":"Coupons","pages":[{"title":"Get Coupon","openapi":"GET /stores/{storeId}/coupons/{couponId}","href":"/api-reference/endpoint/coupons/get"},{"title":"Get Coupons","openapi":"GET /stores/{storeId}/coupons","href":"/api-reference/endpoint/coupons/get-list"},{"title":"Get All Coupons","openapi":"GET /stores/{storeId}/coupons/all","href":"/api-reference/endpoint/coupons/get-all"},{"title":"Search Coupons","openapi":"GET /stores/{storeId}/coupons/search/{query}","href":"/api-reference/endpoint/coupons/search"},{"title":"Create Coupon","openapi":"POST /stores/{storeId}/coupons","href":"/api-reference/endpoint/coupons/create"},{"title":"Update Coupon","openapi":"PUT /stores/{storeId}/coupons/{couponId}","href":"/api-reference/endpoint/coupons/update"},{"title":"Delete Coupon","openapi":"DELETE /stores/{storeId}/coupons/{couponId}","href":"/api-reference/endpoint/coupons/delete"}]},{"group":"Tickets","pages":[{"title":"Get Ticket","openapi":"GET /stores/{storeId}/tickets/{ticketId}","href":"/api-reference/endpoint/tickets/get"},{"title":"Get Tickets","openapi":"GET /stores/{storeId}/tickets","href":"/api-reference/endpoint/tickets/get-list"},{"title":"Add Ticket Response","openapi":"PUT /stores/{storeId}/tickets/{ticketId}","href":"/api-reference/endpoint/tickets/add"},{"title":"Close Ticket","openapi":"DELETE /stores/{storeId}/tickets/{ticketId}","href":"/api-reference/endpoint/tickets/delete"}]},{"group":"Customers","pages":[{"title":"Get Customer","openapi":"GET /stores/{storeId}/customers/{customerId}","href":"/api-reference/endpoint/customers/get"},{"title":"Get Customers","openapi":"GET /stores/{storeId}/customers","href":"/api-reference/endpoint/customers/get-list"},{"title":"Search Customers","openapi":"GET /stores/{storeId}/customers/search/{query}","href":"/api-reference/endpoint/customers/search"},{"title":"Create Customer","openapi":"POST /stores/{storeId}/customers","href":"/api-reference/endpoint/customers/create"},{"title":"Update Customer Balance","openapi":"PATCH /stores/{storeId}/customers/{customerId}/balance","href":"/api-reference/endpoint/customers/update-balance"},{"title":"Get Customer by Email","openapi":"GET /stores/{storeId}/customers/{customerEmail}/email","href":"/api-reference/endpoint/customers/get-by-email"}]},{"group":"Orders","pages":[{"title":"Get Order","openapi":"GET /stores/{storeId}/orders/{orderId}","href":"/api-reference/endpoint/orders/get"},{"title":"Get Orders","openapi":"GET /stores/{storeId}/orders","href":"/api-reference/endpoint/orders/get-list"},{"title":"Search Orders","openapi":"GET /stores/{storeId}/orders/search/{query}","href":"/api-reference/endpoint/orders/search"},{"title":"Create Order","openapi":"POST /stores/{storeId}/orders","href":"/api-reference/endpoint/orders/create"},{"title":"Deliver Order","openapi":"PUT /stores/{storeId}/orders/{orderId}/deliver","href":"/api-reference/endpoint/orders/deliver"},{"title":"Refund Order","openapi":"DELETE /stores/{storeId}/orders/{orderId}/refund","href":"/api-reference/endpoint/orders/refund"},{"title":"Re-deliver Order","openapi":"PUT /stores/{storeId}/orders/{orderId}/redeliver","href":"/api-reference/endpoint/orders/redeliver"},{"title":"Get Proof of Payment","openapi":"GET /stores/{storeId}/paymentMethods/custom/orders/{orderId}/proof","href":"/api-reference/endpoint/orders/get-payment-proof"}]},{"group":"Reviews","pages":[{"title":"Get Reviews","openapi":"GET /stores/{storeId}/reviews","href":"/api-reference/endpoint/reviews/get-list"},{"title":"Reply to Review","openapi":"PUT /stores/{storeId}/reviews/{reviewId}/reply","href":"/api-reference/endpoint/reviews/reply"},{"title":"Get Review Analytics","openapi":"GET /stores/{storeId}/reviews/analytics","href":"/api-reference/endpoint/reviews/analytics"}]},{"group":"Affiliates","pages":[{"title":"Get Affiliates","openapi":"GET /stores/{storeId}/affiliates","href":"/api-reference/endpoint/affiliates/get-list"},{"title":"Search Affiliates","openapi":"GET /stores/{storeId}/affiliates/search","href":"/api-reference/endpoint/affiliates/search"},{"title":"Get Affiliate Statistics","openapi":"GET /stores/{storeId}/affiliates/stats","href":"/api-reference/endpoint/affiliates/stats"},{"title":"Create Affiliate","openapi":"POST /stores/{storeId}/affiliates/{customerId}","href":"/api-reference/endpoint/affiliates/create"},{"title":"Update Affiliate","openapi":"PUT /stores/{storeId}/affiliates/{customerId}","href":"/api-reference/endpoint/affiliates/update"},{"title":"Delete Affiliate","openapi":"DELETE /stores/{storeId}/affiliates/{customerId}","href":"/api-reference/endpoint/affiliates/delete"},{"title":"Invite Affiliate","openapi":"POST /stores/{storeId}/affiliates/invite","href":"/api-reference/endpoint/affiliates/invite"},{"title":"Blacklist Affiliate","openapi":"POST /stores/{storeId}/affiliates/{customerId}/blacklist","href":"/api-reference/endpoint/affiliates/blacklist"},{"title":"Configure Affiliate Program","openapi":"PUT /stores/{storeId}/affiliates/configure","href":"/api-reference/endpoint/affiliates/configure"},{"title":"List Affiliate Orders","openapi":"GET /stores/{storeId}/affiliates/{customerId}/orders/{page}","href":"/api-reference/endpoint/affiliates/get-orders"},{"title":"List Affiliate Payouts","openapi":"GET /stores/{storeId}/affiliates/{customerId}/payouts/{page}","href":"/api-reference/endpoint/affiliates/get-payouts"},{"title":"Record Affiliate Payout","openapi":"POST /stores/{storeId}/affiliates/{customerId}/payouts","href":"/api-reference/endpoint/affiliates/record-payout"},{"title":"Void Affiliate Payout","openapi":"PATCH /stores/{storeId}/affiliates/{customerId}/payouts/{payoutId}","href":"/api-reference/endpoint/affiliates/void-payout"}]},{"group":"Affiliate API","pages":[{"title":"Affiliate API","href":"/api-reference/affiliate-api"},{"title":"Get Affiliate Account","openapi":"GET /affiliate","href":"/api-reference/endpoint/affiliate/get-account"},{"title":"List Affiliate Discounts","openapi":"GET /affiliate/discounts","href":"/api-reference/endpoint/affiliate/get-discounts"},{"title":"List Referred Orders","openapi":"GET /affiliate/orders","href":"/api-reference/endpoint/affiliate/get-orders"},{"title":"List Received Payouts","openapi":"GET /affiliate/payouts","href":"/api-reference/endpoint/affiliate/get-payouts"},{"title":"Get Referral Statistics","openapi":"GET /affiliate/stats","href":"/api-reference/endpoint/affiliate/stats"}]},{"group":"Reseller Programme","pages":[{"title":"Get Programme","openapi":"GET /stores/{storeId}/reseller","href":"/api-reference/endpoint/reseller-programme/get"},{"title":"Configure Programme","openapi":"PUT /stores/{storeId}/reseller","href":"/api-reference/endpoint/reseller-programme/configure"},{"title":"Get Catalogue","openapi":"GET /stores/{storeId}/reseller/catalogue","href":"/api-reference/endpoint/reseller-programme/get-catalogue"},{"title":"Add to Catalogue","openapi":"PUT /stores/{storeId}/reseller/catalogue/{variantId}","href":"/api-reference/endpoint/reseller-programme/add-to-catalogue"},{"title":"Remove from Catalogue","openapi":"DELETE /stores/{storeId}/reseller/catalogue/{variantId}","href":"/api-reference/endpoint/reseller-programme/remove-from-catalogue"},{"title":"Get Variant Stats","openapi":"GET /stores/{storeId}/reseller/catalogue/{variantId}/stats","href":"/api-reference/endpoint/reseller-programme/get-variant-stats"},{"title":"Set Volume Tiers","openapi":"PUT /stores/{storeId}/reseller/catalogue/{variantId}/tiers","href":"/api-reference/endpoint/reseller-programme/set-volume-tiers"},{"title":"Get Resellers","openapi":"GET /stores/{storeId}/reseller/resellers","href":"/api-reference/endpoint/reseller-programme/get-resellers"},{"title":"Update Status","openapi":"PUT /stores/{storeId}/reseller/resellers/{resellerId}/status","href":"/api-reference/endpoint/reseller-programme/update-status"},{"title":"Grant Samples","openapi":"POST /stores/{storeId}/reseller/resellers/{resellerId}/samples","href":"/api-reference/endpoint/reseller-programme/grant-samples"},{"title":"Get Invitations","openapi":"GET /stores/{storeId}/reseller/invites","href":"/api-reference/endpoint/reseller-programme/get-invites"},{"title":"Create Invitation","openapi":"POST /stores/{storeId}/reseller/invites","href":"/api-reference/endpoint/reseller-programme/create-invite"},{"title":"Delete Invitation","openapi":"DELETE /stores/{storeId}/reseller/invites/{inviteId}","href":"/api-reference/endpoint/reseller-programme/delete-invite"},{"title":"Get Questions","openapi":"GET /stores/{storeId}/reseller/application/questions","href":"/api-reference/endpoint/reseller-programme/get-questions"},{"title":"Create Question","openapi":"POST /stores/{storeId}/reseller/application/questions","href":"/api-reference/endpoint/reseller-programme/create-question"},{"title":"Update Question","openapi":"PUT /stores/{storeId}/reseller/application/questions/{questionId}","href":"/api-reference/endpoint/reseller-programme/update-question"},{"title":"Delete Question","openapi":"DELETE /stores/{storeId}/reseller/application/questions/{questionId}","href":"/api-reference/endpoint/reseller-programme/delete-question"},{"title":"Get Applications","openapi":"GET /stores/{storeId}/reseller/application/submissions","href":"/api-reference/endpoint/reseller-programme/get-applications"},{"title":"Create Application","openapi":"POST /stores/{storeId}/reseller/applications","href":"/api-reference/endpoint/reseller-programme/create-application"},{"title":"Get Bundles","openapi":"GET /stores/{storeId}/reseller/bundles","href":"/api-reference/endpoint/reseller-programme/get-bundles"},{"title":"Create Bundle","openapi":"POST /stores/{storeId}/reseller/bundles","href":"/api-reference/endpoint/reseller-programme/create-bundle"},{"title":"Update Bundle","openapi":"PUT /stores/{storeId}/reseller/bundles/{bundleId}","href":"/api-reference/endpoint/reseller-programme/update-bundle"},{"title":"Delete Bundle","openapi":"DELETE /stores/{storeId}/reseller/bundles/{bundleId}","href":"/api-reference/endpoint/reseller-programme/delete-bundle"},{"title":"Get Basket Discounts","openapi":"GET /stores/{storeId}/reseller/basket-tiers","href":"/api-reference/endpoint/reseller-programme/get-basket-tiers"},{"title":"Create Basket Discount","openapi":"POST /stores/{storeId}/reseller/basket-tiers","href":"/api-reference/endpoint/reseller-programme/create-basket-tier"},{"title":"Update Basket Discount","openapi":"PUT /stores/{storeId}/reseller/basket-tiers/{basketTierId}","href":"/api-reference/endpoint/reseller-programme/update-basket-tier"},{"title":"Delete Basket Discount","openapi":"DELETE /stores/{storeId}/reseller/basket-tiers/{basketTierId}","href":"/api-reference/endpoint/reseller-programme/delete-basket-tier"},{"title":"Get Leaderboard","openapi":"GET /stores/{storeId}/reseller/leaderboard","href":"/api-reference/endpoint/reseller-programme/get-leaderboard"}]},{"group":"Reselling","pages":[{"title":"Get Suppliers","openapi":"GET /stores/{storeId}/reselling/suppliers","href":"/api-reference/endpoint/reselling/get-suppliers"},{"title":"Find Supplier","openapi":"GET /stores/{storeId}/reselling/suppliers/lookup","href":"/api-reference/endpoint/reselling/find-supplier"},{"title":"Apply to Supplier","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}","href":"/api-reference/endpoint/reselling/apply"},{"title":"Get Catalogue","openapi":"GET /stores/{storeId}/reselling/suppliers/{supplierStoreId}/catalogue","href":"/api-reference/endpoint/reselling/get-catalogue"},{"title":"Get Bundles","openapi":"GET /stores/{storeId}/reselling/suppliers/{supplierStoreId}/bundles","href":"/api-reference/endpoint/reselling/get-bundles"},{"title":"Buy Basket","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}/basket","href":"/api-reference/endpoint/reselling/buy-basket"},{"title":"Quote Basket","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}/basket/quote","href":"/api-reference/endpoint/reselling/quote-basket"},{"title":"Buy Stock","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}/stock","href":"/api-reference/endpoint/reselling/buy-stock"},{"title":"Get Draws","openapi":"GET /stores/{storeId}/reselling/suppliers/{supplierStoreId}/draws","href":"/api-reference/endpoint/reselling/get-draws"},{"title":"Add Funds","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}/topup","href":"/api-reference/endpoint/reselling/add-funds"},{"title":"Get Payment Methods","openapi":"GET /stores/{storeId}/reselling/suppliers/{supplierStoreId}/payment-methods","href":"/api-reference/endpoint/reselling/get-payment-methods"},{"title":"Create Listing","openapi":"PUT /stores/{storeId}/reselling/suppliers/{supplierStoreId}/listings/{sourceVariantId}","href":"/api-reference/endpoint/reselling/create-listing"},{"title":"Delete Listing","openapi":"DELETE /stores/{storeId}/reselling/suppliers/{supplierStoreId}/listings/{sourceVariantId}","href":"/api-reference/endpoint/reselling/delete-listing"},{"title":"Get Resold Products","openapi":"GET /stores/{storeId}/reselling/products","href":"/api-reference/endpoint/reselling/get-products"},{"title":"Get Linkable Accounts","openapi":"GET /stores/{storeId}/reselling/linkable","href":"/api-reference/endpoint/reselling/get-linkable"},{"title":"Link Account","openapi":"POST /stores/{storeId}/reselling/linkable/{resellerId}","href":"/api-reference/endpoint/reselling/link-account"},{"title":"Accept Invitation","openapi":"POST /stores/{storeId}/reselling/invites/accept","href":"/api-reference/endpoint/reselling/accept-invite"}]},{"group":"Webhooks","pages":[{"title":"Get Webhooks","openapi":"GET /webhooks","href":"/api-reference/endpoint/webhooks/get-list"},{"title":"Create Webhook","openapi":"POST /webhooks","href":"/api-reference/endpoint/webhooks/create"},{"title":"Get Webhook","openapi":"GET /webhooks/{webhookId}","href":"/api-reference/endpoint/webhooks/get"},{"title":"Update Webhook","openapi":"PUT /webhooks/{webhookId}","href":"/api-reference/endpoint/webhooks/update"},{"title":"Delete Webhook","openapi":"DELETE /webhooks/{webhookId}","href":"/api-reference/endpoint/webhooks/delete"},{"title":"Get Webhook Logs","openapi":"GET /webhooks/{webhookId}/logs","href":"/api-reference/endpoint/webhooks/get-logs"},{"title":"Resend Webhook","openapi":"POST /webhooks/{webhookId}/logs/{executionLogId}/resend","href":"/api-reference/endpoint/webhooks/resend"},{"title":"Search Webhook Logs","openapi":"GET /webhooks/{webhookId}/logs/search/{query}","href":"/api-reference/endpoint/webhooks/search-logs"}]}]},{"tab":"Storefront-SDK","pages":[{"title":"Storefront-SDK","href":"/de/storefront/introduction"}]}]},{"language":"pl","tabs":[{"tab":"Przewodniki","pages":[{"title":"Przewodniki","href":"/pl"}]},{"tab":"Dokumentacja API","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Quick Start","href":"/api-reference/quickstart"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Scopes","href":"/api-reference/scopes"},{"title":"SDKs","href":"/api-reference/sdks"}]},{"group":"Reference","pages":[{"title":"Conventions","href":"/api-reference/conventions"},{"title":"Responses \u0026 Errors","href":"/api-reference/responses"},{"title":"Filtering \u0026 Sorting","href":"/api-reference/filtering"},{"title":"Enums \u0026 Constants","href":"/api-reference/enums"},{"title":"Error Codes","href":"/api-reference/error-codes"},{"title":"Payment Methods","href":"/api-reference/payment-methods"},{"title":"Order Status","href":"/api-reference/payment-status"}]},{"group":"OAuth2","pages":[{"title":"OAuth2 Integration","href":"/api-reference/oauth2/introduction"},{"title":"Exchange Code","openapi":"GET /oauth2/{appId}/exchange/{code}","description":null,"href":"/api-reference/oauth2/exchange"}]},{"group":"User","pages":[{"title":"Get User","openapi":"GET /user","href":"/api-reference/endpoint/users/get"}]},{"group":"Stores","pages":[{"title":"Get Store","openapi":"GET /stores/{storeId}","description":"Retrieves the specified store's reference information.\nRequires the `stores.view` permission.","href":"/api-reference/endpoint/stores/get"},{"title":"Create Store","openapi":"POST /stores","href":"/api-reference/endpoint/stores/create"},{"title":"Update Store","openapi":"PUT /stores/{storeId}","href":"/api-reference/endpoint/stores/update"},{"title":"Maintenance Mode","openapi":"PUT /stores/{storeId}/maintenance","href":"/api-reference/endpoint/stores/update-maintenance"}]},{"group":"Products","pages":[{"title":"Get Product","openapi":"GET /stores/{storeId}/products/{productId}","href":"/api-reference/endpoint/products/get"},{"title":"Search Products","openapi":"GET /stores/{storeId}/products/search/{query}","href":"/api-reference/endpoint/products/search"},{"title":"Get Product by Slug","openapi":"GET /stores/{storeId}/products/slug/{slug}","href":"/api-reference/endpoint/products/get-slug"},{"title":"Get All Products","openapi":"GET /stores/{storeId}/products/all","href":"/api-reference/endpoint/products/get-all"},{"title":"Get Products","openapi":"GET /stores/{storeId}/products","href":"/api-reference/endpoint/products/get-list"},{"title":"Create Product","openapi":"POST /stores/{storeId}/products","href":"/api-reference/endpoint/products/create"},{"title":"Delete Product","openapi":"DELETE /stores/{storeId}/products/{productId}","href":"/api-reference/endpoint/products/delete"},{"title":"Update Product","openapi":"PUT /stores/{storeId}/products/{productId}","href":"/api-reference/endpoint/products/update"},{"title":"Update Payment Settings","openapi":"PUT /stores/{storeId}/products/{productId}/payment","href":"/api-reference/endpoint/products/update-payment"},{"title":"Bulk Update Products","openapi":"PUT /stores/{storeId}/products","href":"/api-reference/endpoint/products/update-bulk"},{"title":"Order Products","openapi":"PATCH /stores/{storeId}/products/order","href":"/api-reference/endpoint/products/order"},{"title":"Order Product Images","openapi":"PATCH /stores/{storeId}/products/{productId}/images/order","href":"/api-reference/endpoint/products/order-images"},{"title":"Duplicate Product","openapi":"POST /stores/{storeId}/products/{productId}/duplicate","href":"/api-reference/endpoint/products/duplicate"},{"title":"Update Affiliate Discount","openapi":"PUT /stores/{storeId}/products/{productId}/affiliateDiscount","href":"/api-reference/endpoint/products/update-affiliate-discount"},{"title":"Update Product Badges","openapi":"PUT /stores/{storeId}/products/{productId}/badges","href":"/api-reference/endpoint/products/update-badges"},{"title":"Update Product Security","openapi":"PUT /stores/{storeId}/products/{productId}/security","href":"/api-reference/endpoint/products/update-security"},{"title":"Bulk Delete Products","openapi":"DELETE /stores/{storeId}/products","href":"/api-reference/endpoint/products/delete-bulk"}]},{"group":"Categories","pages":[{"title":"Get Category","openapi":"GET /stores/{storeId}/categories/{categoryId}","href":"/api-reference/endpoint/categories/get"},{"title":"Get Categories","openapi":"GET /stores/{storeId}/categories","href":"/api-reference/endpoint/categories/get-list"},{"title":"Get All Categories","openapi":"GET /stores/{storeId}/categories/all","href":"/api-reference/endpoint/categories/get-all"},{"title":"Create Category","openapi":"POST /stores/{storeId}/categories","href":"/api-reference/endpoint/categories/create"},{"title":"Update Category","openapi":"PUT /stores/{storeId}/categories/{categoryId}","href":"/api-reference/endpoint/categories/update"},{"title":"Delete Category","openapi":"DELETE /stores/{storeId}/categories/{categoryId}","href":"/api-reference/endpoint/categories/delete"},{"title":"Order Categories","openapi":"PATCH /stores/{storeId}/categories/order","href":"/api-reference/endpoint/categories/order"},{"title":"Order Products in Category","openapi":"PATCH /stores/{storeId}/categories/{categoryId}/products/order","href":"/api-reference/endpoint/categories/order-products"}]},{"group":"Variants","pages":[{"title":"Get Variant","openapi":"GET /stores/{storeId}/products/{productId}/variants/{variantId}","href":"/api-reference/endpoint/variants/get"},{"title":"Get License Keys","openapi":"GET /stores/{storeId}/products/{productId}/variants/{variantId}/items/{page}","href":"/api-reference/endpoint/variants/get-items"},{"title":"Create Variant","openapi":"POST /stores/{storeId}/products/{productId}/variants","href":"/api-reference/endpoint/variants/create"},{"title":"Create Field","openapi":"POST /stores/{storeId}/products/{productId}/variants/{variantId}/fields","href":"/api-reference/endpoint/variants/fields/create"},{"title":"Create Field Option","openapi":"POST /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}/options","href":"/api-reference/endpoint/variants/fields/options/create"},{"title":"Add License Keys","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/items","href":"/api-reference/endpoint/variants/add-items"},{"title":"Update Variant","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}","href":"/api-reference/endpoint/variants/update"},{"title":"Update Delivery Settings","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/delivery","href":"/api-reference/endpoint/variants/update-delivery"},{"title":"Update Field","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}","href":"/api-reference/endpoint/variants/fields/update"},{"title":"Update Field Option","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}/options/{optionId}","href":"/api-reference/endpoint/variants/fields/options/update"},{"title":"Order Variant Images","openapi":"PATCH /stores/{storeId}/products/{productId}/variants/{variantId}/images/order","href":"/api-reference/endpoint/variants/order-images"},{"title":"Delete License Keys","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/items","href":"/api-reference/endpoint/variants/delete-items"},{"title":"Clear License Keys","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/items/clear","href":"/api-reference/endpoint/variants/clear-items"},{"title":"Delete Variant","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}","href":"/api-reference/endpoint/variants/delete"},{"title":"Delete Field","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}","href":"/api-reference/endpoint/variants/fields/delete"},{"title":"Delete Field Option","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}/options/{optionId}","href":"/api-reference/endpoint/variants/fields/options/delete"},{"title":"Order Variants","openapi":"PATCH /stores/{storeId}/products/{productId}/variants/order","href":"/api-reference/endpoint/variants/order"},{"title":"Duplicate Variant","openapi":"POST /stores/{storeId}/products/{productId}/variants/{variantId}/duplicate","href":"/api-reference/endpoint/variants/duplicate"},{"title":"Search License Keys","openapi":"GET /stores/{storeId}/products/{productId}/variants/{variantId}/items/search/{query}","href":"/api-reference/endpoint/variants/search-items"},{"title":"Remove File from Variant","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/file/{fileId}","href":"/api-reference/endpoint/variants/delete-file"},{"title":"Get Volume Discounts","openapi":"GET /stores/{storeId}/products/{productId}/variants/{variantId}/discounts","href":"/api-reference/endpoint/variants/discounts/get"},{"title":"Create Volume Discount","openapi":"POST /stores/{storeId}/products/{productId}/variants/{variantId}/discounts","href":"/api-reference/endpoint/variants/discounts/create"},{"title":"Replace Volume Discounts","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/discounts","href":"/api-reference/endpoint/variants/discounts/replace"},{"title":"Update Volume Discount","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/discounts/{discountId}","href":"/api-reference/endpoint/variants/discounts/update"},{"title":"Delete Volume Discount","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/discounts/{discountId}","href":"/api-reference/endpoint/variants/discounts/delete"}]},{"group":"Coupons","pages":[{"title":"Get Coupon","openapi":"GET /stores/{storeId}/coupons/{couponId}","href":"/api-reference/endpoint/coupons/get"},{"title":"Get Coupons","openapi":"GET /stores/{storeId}/coupons","href":"/api-reference/endpoint/coupons/get-list"},{"title":"Get All Coupons","openapi":"GET /stores/{storeId}/coupons/all","href":"/api-reference/endpoint/coupons/get-all"},{"title":"Search Coupons","openapi":"GET /stores/{storeId}/coupons/search/{query}","href":"/api-reference/endpoint/coupons/search"},{"title":"Create Coupon","openapi":"POST /stores/{storeId}/coupons","href":"/api-reference/endpoint/coupons/create"},{"title":"Update Coupon","openapi":"PUT /stores/{storeId}/coupons/{couponId}","href":"/api-reference/endpoint/coupons/update"},{"title":"Delete Coupon","openapi":"DELETE /stores/{storeId}/coupons/{couponId}","href":"/api-reference/endpoint/coupons/delete"}]},{"group":"Tickets","pages":[{"title":"Get Ticket","openapi":"GET /stores/{storeId}/tickets/{ticketId}","href":"/api-reference/endpoint/tickets/get"},{"title":"Get Tickets","openapi":"GET /stores/{storeId}/tickets","href":"/api-reference/endpoint/tickets/get-list"},{"title":"Add Ticket Response","openapi":"PUT /stores/{storeId}/tickets/{ticketId}","href":"/api-reference/endpoint/tickets/add"},{"title":"Close Ticket","openapi":"DELETE /stores/{storeId}/tickets/{ticketId}","href":"/api-reference/endpoint/tickets/delete"}]},{"group":"Customers","pages":[{"title":"Get Customer","openapi":"GET /stores/{storeId}/customers/{customerId}","href":"/api-reference/endpoint/customers/get"},{"title":"Get Customers","openapi":"GET /stores/{storeId}/customers","href":"/api-reference/endpoint/customers/get-list"},{"title":"Search Customers","openapi":"GET /stores/{storeId}/customers/search/{query}","href":"/api-reference/endpoint/customers/search"},{"title":"Create Customer","openapi":"POST /stores/{storeId}/customers","href":"/api-reference/endpoint/customers/create"},{"title":"Update Customer Balance","openapi":"PATCH /stores/{storeId}/customers/{customerId}/balance","href":"/api-reference/endpoint/customers/update-balance"},{"title":"Get Customer by Email","openapi":"GET /stores/{storeId}/customers/{customerEmail}/email","href":"/api-reference/endpoint/customers/get-by-email"}]},{"group":"Orders","pages":[{"title":"Get Order","openapi":"GET /stores/{storeId}/orders/{orderId}","href":"/api-reference/endpoint/orders/get"},{"title":"Get Orders","openapi":"GET /stores/{storeId}/orders","href":"/api-reference/endpoint/orders/get-list"},{"title":"Search Orders","openapi":"GET /stores/{storeId}/orders/search/{query}","href":"/api-reference/endpoint/orders/search"},{"title":"Create Order","openapi":"POST /stores/{storeId}/orders","href":"/api-reference/endpoint/orders/create"},{"title":"Deliver Order","openapi":"PUT /stores/{storeId}/orders/{orderId}/deliver","href":"/api-reference/endpoint/orders/deliver"},{"title":"Refund Order","openapi":"DELETE /stores/{storeId}/orders/{orderId}/refund","href":"/api-reference/endpoint/orders/refund"},{"title":"Re-deliver Order","openapi":"PUT /stores/{storeId}/orders/{orderId}/redeliver","href":"/api-reference/endpoint/orders/redeliver"},{"title":"Get Proof of Payment","openapi":"GET /stores/{storeId}/paymentMethods/custom/orders/{orderId}/proof","href":"/api-reference/endpoint/orders/get-payment-proof"}]},{"group":"Reviews","pages":[{"title":"Get Reviews","openapi":"GET /stores/{storeId}/reviews","href":"/api-reference/endpoint/reviews/get-list"},{"title":"Reply to Review","openapi":"PUT /stores/{storeId}/reviews/{reviewId}/reply","href":"/api-reference/endpoint/reviews/reply"},{"title":"Get Review Analytics","openapi":"GET /stores/{storeId}/reviews/analytics","href":"/api-reference/endpoint/reviews/analytics"}]},{"group":"Affiliates","pages":[{"title":"Get Affiliates","openapi":"GET /stores/{storeId}/affiliates","href":"/api-reference/endpoint/affiliates/get-list"},{"title":"Search Affiliates","openapi":"GET /stores/{storeId}/affiliates/search","href":"/api-reference/endpoint/affiliates/search"},{"title":"Get Affiliate Statistics","openapi":"GET /stores/{storeId}/affiliates/stats","href":"/api-reference/endpoint/affiliates/stats"},{"title":"Create Affiliate","openapi":"POST /stores/{storeId}/affiliates/{customerId}","href":"/api-reference/endpoint/affiliates/create"},{"title":"Update Affiliate","openapi":"PUT /stores/{storeId}/affiliates/{customerId}","href":"/api-reference/endpoint/affiliates/update"},{"title":"Delete Affiliate","openapi":"DELETE /stores/{storeId}/affiliates/{customerId}","href":"/api-reference/endpoint/affiliates/delete"},{"title":"Invite Affiliate","openapi":"POST /stores/{storeId}/affiliates/invite","href":"/api-reference/endpoint/affiliates/invite"},{"title":"Blacklist Affiliate","openapi":"POST /stores/{storeId}/affiliates/{customerId}/blacklist","href":"/api-reference/endpoint/affiliates/blacklist"},{"title":"Configure Affiliate Program","openapi":"PUT /stores/{storeId}/affiliates/configure","href":"/api-reference/endpoint/affiliates/configure"},{"title":"List Affiliate Orders","openapi":"GET /stores/{storeId}/affiliates/{customerId}/orders/{page}","href":"/api-reference/endpoint/affiliates/get-orders"},{"title":"List Affiliate Payouts","openapi":"GET /stores/{storeId}/affiliates/{customerId}/payouts/{page}","href":"/api-reference/endpoint/affiliates/get-payouts"},{"title":"Record Affiliate Payout","openapi":"POST /stores/{storeId}/affiliates/{customerId}/payouts","href":"/api-reference/endpoint/affiliates/record-payout"},{"title":"Void Affiliate Payout","openapi":"PATCH /stores/{storeId}/affiliates/{customerId}/payouts/{payoutId}","href":"/api-reference/endpoint/affiliates/void-payout"}]},{"group":"Affiliate API","pages":[{"title":"Affiliate API","href":"/api-reference/affiliate-api"},{"title":"Get Affiliate Account","openapi":"GET /affiliate","href":"/api-reference/endpoint/affiliate/get-account"},{"title":"List Affiliate Discounts","openapi":"GET /affiliate/discounts","href":"/api-reference/endpoint/affiliate/get-discounts"},{"title":"List Referred Orders","openapi":"GET /affiliate/orders","href":"/api-reference/endpoint/affiliate/get-orders"},{"title":"List Received Payouts","openapi":"GET /affiliate/payouts","href":"/api-reference/endpoint/affiliate/get-payouts"},{"title":"Get Referral Statistics","openapi":"GET /affiliate/stats","href":"/api-reference/endpoint/affiliate/stats"}]},{"group":"Reseller Programme","pages":[{"title":"Get Programme","openapi":"GET /stores/{storeId}/reseller","href":"/api-reference/endpoint/reseller-programme/get"},{"title":"Configure Programme","openapi":"PUT /stores/{storeId}/reseller","href":"/api-reference/endpoint/reseller-programme/configure"},{"title":"Get Catalogue","openapi":"GET /stores/{storeId}/reseller/catalogue","href":"/api-reference/endpoint/reseller-programme/get-catalogue"},{"title":"Add to Catalogue","openapi":"PUT /stores/{storeId}/reseller/catalogue/{variantId}","href":"/api-reference/endpoint/reseller-programme/add-to-catalogue"},{"title":"Remove from Catalogue","openapi":"DELETE /stores/{storeId}/reseller/catalogue/{variantId}","href":"/api-reference/endpoint/reseller-programme/remove-from-catalogue"},{"title":"Get Variant Stats","openapi":"GET /stores/{storeId}/reseller/catalogue/{variantId}/stats","href":"/api-reference/endpoint/reseller-programme/get-variant-stats"},{"title":"Set Volume Tiers","openapi":"PUT /stores/{storeId}/reseller/catalogue/{variantId}/tiers","href":"/api-reference/endpoint/reseller-programme/set-volume-tiers"},{"title":"Get Resellers","openapi":"GET /stores/{storeId}/reseller/resellers","href":"/api-reference/endpoint/reseller-programme/get-resellers"},{"title":"Update Status","openapi":"PUT /stores/{storeId}/reseller/resellers/{resellerId}/status","href":"/api-reference/endpoint/reseller-programme/update-status"},{"title":"Grant Samples","openapi":"POST /stores/{storeId}/reseller/resellers/{resellerId}/samples","href":"/api-reference/endpoint/reseller-programme/grant-samples"},{"title":"Get Invitations","openapi":"GET /stores/{storeId}/reseller/invites","href":"/api-reference/endpoint/reseller-programme/get-invites"},{"title":"Create Invitation","openapi":"POST /stores/{storeId}/reseller/invites","href":"/api-reference/endpoint/reseller-programme/create-invite"},{"title":"Delete Invitation","openapi":"DELETE /stores/{storeId}/reseller/invites/{inviteId}","href":"/api-reference/endpoint/reseller-programme/delete-invite"},{"title":"Get Questions","openapi":"GET /stores/{storeId}/reseller/application/questions","href":"/api-reference/endpoint/reseller-programme/get-questions"},{"title":"Create Question","openapi":"POST /stores/{storeId}/reseller/application/questions","href":"/api-reference/endpoint/reseller-programme/create-question"},{"title":"Update Question","openapi":"PUT /stores/{storeId}/reseller/application/questions/{questionId}","href":"/api-reference/endpoint/reseller-programme/update-question"},{"title":"Delete Question","openapi":"DELETE /stores/{storeId}/reseller/application/questions/{questionId}","href":"/api-reference/endpoint/reseller-programme/delete-question"},{"title":"Get Applications","openapi":"GET /stores/{storeId}/reseller/application/submissions","href":"/api-reference/endpoint/reseller-programme/get-applications"},{"title":"Create Application","openapi":"POST /stores/{storeId}/reseller/applications","href":"/api-reference/endpoint/reseller-programme/create-application"},{"title":"Get Bundles","openapi":"GET /stores/{storeId}/reseller/bundles","href":"/api-reference/endpoint/reseller-programme/get-bundles"},{"title":"Create Bundle","openapi":"POST /stores/{storeId}/reseller/bundles","href":"/api-reference/endpoint/reseller-programme/create-bundle"},{"title":"Update Bundle","openapi":"PUT /stores/{storeId}/reseller/bundles/{bundleId}","href":"/api-reference/endpoint/reseller-programme/update-bundle"},{"title":"Delete Bundle","openapi":"DELETE /stores/{storeId}/reseller/bundles/{bundleId}","href":"/api-reference/endpoint/reseller-programme/delete-bundle"},{"title":"Get Basket Discounts","openapi":"GET /stores/{storeId}/reseller/basket-tiers","href":"/api-reference/endpoint/reseller-programme/get-basket-tiers"},{"title":"Create Basket Discount","openapi":"POST /stores/{storeId}/reseller/basket-tiers","href":"/api-reference/endpoint/reseller-programme/create-basket-tier"},{"title":"Update Basket Discount","openapi":"PUT /stores/{storeId}/reseller/basket-tiers/{basketTierId}","href":"/api-reference/endpoint/reseller-programme/update-basket-tier"},{"title":"Delete Basket Discount","openapi":"DELETE /stores/{storeId}/reseller/basket-tiers/{basketTierId}","href":"/api-reference/endpoint/reseller-programme/delete-basket-tier"},{"title":"Get Leaderboard","openapi":"GET /stores/{storeId}/reseller/leaderboard","href":"/api-reference/endpoint/reseller-programme/get-leaderboard"}]},{"group":"Reselling","pages":[{"title":"Get Suppliers","openapi":"GET /stores/{storeId}/reselling/suppliers","href":"/api-reference/endpoint/reselling/get-suppliers"},{"title":"Find Supplier","openapi":"GET /stores/{storeId}/reselling/suppliers/lookup","href":"/api-reference/endpoint/reselling/find-supplier"},{"title":"Apply to Supplier","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}","href":"/api-reference/endpoint/reselling/apply"},{"title":"Get Catalogue","openapi":"GET /stores/{storeId}/reselling/suppliers/{supplierStoreId}/catalogue","href":"/api-reference/endpoint/reselling/get-catalogue"},{"title":"Get Bundles","openapi":"GET /stores/{storeId}/reselling/suppliers/{supplierStoreId}/bundles","href":"/api-reference/endpoint/reselling/get-bundles"},{"title":"Buy Basket","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}/basket","href":"/api-reference/endpoint/reselling/buy-basket"},{"title":"Quote Basket","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}/basket/quote","href":"/api-reference/endpoint/reselling/quote-basket"},{"title":"Buy Stock","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}/stock","href":"/api-reference/endpoint/reselling/buy-stock"},{"title":"Get Draws","openapi":"GET /stores/{storeId}/reselling/suppliers/{supplierStoreId}/draws","href":"/api-reference/endpoint/reselling/get-draws"},{"title":"Add Funds","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}/topup","href":"/api-reference/endpoint/reselling/add-funds"},{"title":"Get Payment Methods","openapi":"GET /stores/{storeId}/reselling/suppliers/{supplierStoreId}/payment-methods","href":"/api-reference/endpoint/reselling/get-payment-methods"},{"title":"Create Listing","openapi":"PUT /stores/{storeId}/reselling/suppliers/{supplierStoreId}/listings/{sourceVariantId}","href":"/api-reference/endpoint/reselling/create-listing"},{"title":"Delete Listing","openapi":"DELETE /stores/{storeId}/reselling/suppliers/{supplierStoreId}/listings/{sourceVariantId}","href":"/api-reference/endpoint/reselling/delete-listing"},{"title":"Get Resold Products","openapi":"GET /stores/{storeId}/reselling/products","href":"/api-reference/endpoint/reselling/get-products"},{"title":"Get Linkable Accounts","openapi":"GET /stores/{storeId}/reselling/linkable","href":"/api-reference/endpoint/reselling/get-linkable"},{"title":"Link Account","openapi":"POST /stores/{storeId}/reselling/linkable/{resellerId}","href":"/api-reference/endpoint/reselling/link-account"},{"title":"Accept Invitation","openapi":"POST /stores/{storeId}/reselling/invites/accept","href":"/api-reference/endpoint/reselling/accept-invite"}]},{"group":"Webhooks","pages":[{"title":"Get Webhooks","openapi":"GET /webhooks","href":"/api-reference/endpoint/webhooks/get-list"},{"title":"Create Webhook","openapi":"POST /webhooks","href":"/api-reference/endpoint/webhooks/create"},{"title":"Get Webhook","openapi":"GET /webhooks/{webhookId}","href":"/api-reference/endpoint/webhooks/get"},{"title":"Update Webhook","openapi":"PUT /webhooks/{webhookId}","href":"/api-reference/endpoint/webhooks/update"},{"title":"Delete Webhook","openapi":"DELETE /webhooks/{webhookId}","href":"/api-reference/endpoint/webhooks/delete"},{"title":"Get Webhook Logs","openapi":"GET /webhooks/{webhookId}/logs","href":"/api-reference/endpoint/webhooks/get-logs"},{"title":"Resend Webhook","openapi":"POST /webhooks/{webhookId}/logs/{executionLogId}/resend","href":"/api-reference/endpoint/webhooks/resend"},{"title":"Search Webhook Logs","openapi":"GET /webhooks/{webhookId}/logs/search/{query}","href":"/api-reference/endpoint/webhooks/search-logs"}]}]},{"tab":"SDK Sklepowy","pages":[{"title":"SDK Sklepowy","href":"/pl/storefront/introduction"}]}]},{"language":"es","tabs":[{"tab":"Guías","pages":[{"title":"Guías","href":"/es"}]},{"tab":"Referencia de API","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Quick Start","href":"/api-reference/quickstart"},{"title":"Scopes","href":"/api-reference/scopes"},{"title":"SDKs","href":"/api-reference/sdks"}]},{"group":"Reference","pages":[{"title":"Filtering \u0026 Sorting","href":"/api-reference/filtering"},{"title":"Payment Methods","href":"/api-reference/payment-methods"},{"title":"Order Status","href":"/api-reference/payment-status"},{"title":"Error Codes","href":"/api-reference/error-codes"},{"title":"Enums \u0026 Constants","href":"/api-reference/enums"}]},{"group":"OAuth2","pages":[{"title":"OAuth2 Integration","href":"/api-reference/oauth2/introduction"},{"title":"Exchange Code","openapi":"GET /oauth2/{appId}/exchange/{code}","description":null,"href":"/api-reference/oauth2/exchange"}]},{"group":"User","pages":[{"title":"Get User","openapi":"GET /user","href":"/api-reference/endpoint/users/get"}]},{"group":"Stores","pages":[{"title":"Get Store","openapi":"GET /stores/{storeId}","description":"Retrieves the specified store's reference information.\nRequires the `stores.view` permission.","href":"/api-reference/endpoint/stores/get"},{"title":"Create Store","openapi":"POST /stores","href":"/api-reference/endpoint/stores/create"},{"title":"Update Store","openapi":"PUT /stores/{storeId}","href":"/api-reference/endpoint/stores/update"},{"title":"Maintenance Mode","openapi":"PUT /stores/{storeId}/maintenance","href":"/api-reference/endpoint/stores/update-maintenance"}]},{"group":"Products","pages":[{"title":"Get Product","openapi":"GET /stores/{storeId}/products/{productId}","href":"/api-reference/endpoint/products/get"},{"title":"Search Products","openapi":"GET /stores/{storeId}/products/search/{query}","href":"/api-reference/endpoint/products/search"},{"title":"Get Product by Slug","openapi":"GET /stores/{storeId}/products/slug/{slug}","href":"/api-reference/endpoint/products/get-slug"},{"title":"Get All Products","openapi":"GET /stores/{storeId}/products/all","href":"/api-reference/endpoint/products/get-all"},{"title":"Get Products","openapi":"GET /stores/{storeId}/products","href":"/api-reference/endpoint/products/get-list"},{"title":"Create Product","openapi":"POST /stores/{storeId}/products","href":"/api-reference/endpoint/products/create"},{"title":"Delete Product","openapi":"DELETE /stores/{storeId}/products/{productId}","href":"/api-reference/endpoint/products/delete"},{"title":"Update Product","openapi":"PUT /stores/{storeId}/products/{productId}","href":"/api-reference/endpoint/products/update"},{"title":"Update Payment Settings","openapi":"PUT /stores/{storeId}/products/{productId}/payment","href":"/api-reference/endpoint/products/update-payment"},{"title":"Bulk Update Products","openapi":"PUT /stores/{storeId}/products","href":"/api-reference/endpoint/products/update-bulk"},{"title":"Order Products","openapi":"PATCH /stores/{storeId}/products/order","href":"/api-reference/endpoint/products/order"},{"title":"Order Product Images","openapi":"PATCH /stores/{storeId}/products/{productId}/images/order","href":"/api-reference/endpoint/products/order-images"},{"title":"Duplicate Product","openapi":"POST /stores/{storeId}/products/{productId}/duplicate","href":"/api-reference/endpoint/products/duplicate"},{"title":"Update Affiliate Discount","openapi":"PUT /stores/{storeId}/products/{productId}/affiliateDiscount","href":"/api-reference/endpoint/products/update-affiliate-discount"},{"title":"Update Product Badges","openapi":"PUT /stores/{storeId}/products/{productId}/badges","href":"/api-reference/endpoint/products/update-badges"},{"title":"Update Product Security","openapi":"PUT /stores/{storeId}/products/{productId}/security","href":"/api-reference/endpoint/products/update-security"},{"title":"Bulk Delete Products","openapi":"DELETE /stores/{storeId}/products","href":"/api-reference/endpoint/products/delete-bulk"}]},{"group":"Categories","pages":[{"title":"Get Category","openapi":"GET /stores/{storeId}/categories/{categoryId}","href":"/api-reference/endpoint/categories/get"},{"title":"Get Categories","openapi":"GET /stores/{storeId}/categories","href":"/api-reference/endpoint/categories/get-list"},{"title":"Get All Categories","openapi":"GET /stores/{storeId}/categories/all","href":"/api-reference/endpoint/categories/get-all"},{"title":"Create Category","openapi":"POST /stores/{storeId}/categories","href":"/api-reference/endpoint/categories/create"},{"title":"Update Category","openapi":"PUT /stores/{storeId}/categories/{categoryId}","href":"/api-reference/endpoint/categories/update"},{"title":"Delete Category","openapi":"DELETE /stores/{storeId}/categories/{categoryId}","href":"/api-reference/endpoint/categories/delete"},{"title":"Order Categories","openapi":"PATCH /stores/{storeId}/categories/order","href":"/api-reference/endpoint/categories/order"},{"title":"Order Products in Category","openapi":"PATCH /stores/{storeId}/categories/{categoryId}/products/order","href":"/api-reference/endpoint/categories/order-products"}]},{"group":"Variants","pages":[{"title":"Get Variant","openapi":"GET /stores/{storeId}/products/{productId}/variants/{variantId}","href":"/api-reference/endpoint/variants/get"},{"title":"Get License Keys","openapi":"GET /stores/{storeId}/products/{productId}/variants/{variantId}/items/{page}","href":"/api-reference/endpoint/variants/get-items"},{"title":"Create Variant","openapi":"POST /stores/{storeId}/products/{productId}/variants","href":"/api-reference/endpoint/variants/create"},{"title":"Create Field","openapi":"POST /stores/{storeId}/products/{productId}/variants/{variantId}/fields","href":"/api-reference/endpoint/variants/fields/create"},{"title":"Create Field Option","openapi":"POST /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}/options","href":"/api-reference/endpoint/variants/fields/options/create"},{"title":"Add License Keys","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/items","href":"/api-reference/endpoint/variants/add-items"},{"title":"Update Variant","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}","href":"/api-reference/endpoint/variants/update"},{"title":"Update Delivery Settings","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/delivery","href":"/api-reference/endpoint/variants/update-delivery"},{"title":"Update Field","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}","href":"/api-reference/endpoint/variants/fields/update"},{"title":"Update Field Option","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}/options/{optionId}","href":"/api-reference/endpoint/variants/fields/options/update"},{"title":"Order Variant Images","openapi":"PATCH /stores/{storeId}/products/{productId}/variants/{variantId}/images/order","href":"/api-reference/endpoint/variants/order-images"},{"title":"Delete License Keys","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/items","href":"/api-reference/endpoint/variants/delete-items"},{"title":"Clear License Keys","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/items/clear","href":"/api-reference/endpoint/variants/clear-items"},{"title":"Delete Variant","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}","href":"/api-reference/endpoint/variants/delete"},{"title":"Delete Field","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}","href":"/api-reference/endpoint/variants/fields/delete"},{"title":"Delete Field Option","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}/options/{optionId}","href":"/api-reference/endpoint/variants/fields/options/delete"},{"title":"Order Variants","openapi":"PATCH /stores/{storeId}/products/{productId}/variants/order","href":"/api-reference/endpoint/variants/order"},{"title":"Duplicate Variant","openapi":"POST /stores/{storeId}/products/{productId}/variants/{variantId}/duplicate","href":"/api-reference/endpoint/variants/duplicate"},{"title":"Search License Keys","openapi":"GET /stores/{storeId}/products/{productId}/variants/{variantId}/items/search/{query}","href":"/api-reference/endpoint/variants/search-items"},{"title":"Remove File from Variant","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/file/{fileId}","href":"/api-reference/endpoint/variants/delete-file"},{"title":"Get Volume Discounts","openapi":"GET /stores/{storeId}/products/{productId}/variants/{variantId}/discounts","href":"/api-reference/endpoint/variants/discounts/get"},{"title":"Create Volume Discount","openapi":"POST /stores/{storeId}/products/{productId}/variants/{variantId}/discounts","href":"/api-reference/endpoint/variants/discounts/create"},{"title":"Replace Volume Discounts","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/discounts","href":"/api-reference/endpoint/variants/discounts/replace"},{"title":"Update Volume Discount","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/discounts/{discountId}","href":"/api-reference/endpoint/variants/discounts/update"},{"title":"Delete Volume Discount","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/discounts/{discountId}","href":"/api-reference/endpoint/variants/discounts/delete"}]},{"group":"Coupons","pages":[{"title":"Get Coupon","openapi":"GET /stores/{storeId}/coupons/{couponId}","href":"/api-reference/endpoint/coupons/get"},{"title":"Get Coupons","openapi":"GET /stores/{storeId}/coupons","href":"/api-reference/endpoint/coupons/get-list"},{"title":"Get All Coupons","openapi":"GET /stores/{storeId}/coupons/all","href":"/api-reference/endpoint/coupons/get-all"},{"title":"Search Coupons","openapi":"GET /stores/{storeId}/coupons/search/{query}","href":"/api-reference/endpoint/coupons/search"},{"title":"Create Coupon","openapi":"POST /stores/{storeId}/coupons","href":"/api-reference/endpoint/coupons/create"},{"title":"Update Coupon","openapi":"PUT /stores/{storeId}/coupons/{couponId}","href":"/api-reference/endpoint/coupons/update"},{"title":"Delete Coupon","openapi":"DELETE /stores/{storeId}/coupons/{couponId}","href":"/api-reference/endpoint/coupons/delete"}]},{"group":"Tickets","pages":[{"title":"Get Ticket","openapi":"GET /stores/{storeId}/tickets/{ticketId}","href":"/api-reference/endpoint/tickets/get"},{"title":"Get Tickets","openapi":"GET /stores/{storeId}/tickets","href":"/api-reference/endpoint/tickets/get-list"},{"title":"Add Ticket Response","openapi":"PUT /stores/{storeId}/tickets/{ticketId}","href":"/api-reference/endpoint/tickets/add"},{"title":"Close Ticket","openapi":"DELETE /stores/{storeId}/tickets/{ticketId}","href":"/api-reference/endpoint/tickets/delete"}]},{"group":"Customers","pages":[{"title":"Get Customer","openapi":"GET /stores/{storeId}/customers/{customerId}","href":"/api-reference/endpoint/customers/get"},{"title":"Get Customers","openapi":"GET /stores/{storeId}/customers","href":"/api-reference/endpoint/customers/get-list"},{"title":"Search Customers","openapi":"GET /stores/{storeId}/customers/search/{query}","href":"/api-reference/endpoint/customers/search"},{"title":"Create Customer","openapi":"POST /stores/{storeId}/customers","href":"/api-reference/endpoint/customers/create"},{"title":"Update Customer Balance","openapi":"PATCH /stores/{storeId}/customers/{customerId}/balance","href":"/api-reference/endpoint/customers/update-balance"},{"title":"Get Customer by Email","openapi":"GET /stores/{storeId}/customers/{customerEmail}/email","href":"/api-reference/endpoint/customers/get-by-email"}]},{"group":"Orders","pages":[{"title":"Get Order","openapi":"GET /stores/{storeId}/orders/{orderId}","href":"/api-reference/endpoint/orders/get"},{"title":"Get Orders","openapi":"GET /stores/{storeId}/orders","href":"/api-reference/endpoint/orders/get-list"},{"title":"Search Orders","openapi":"GET /stores/{storeId}/orders/search/{query}","href":"/api-reference/endpoint/orders/search"},{"title":"Create Order","openapi":"POST /stores/{storeId}/orders","href":"/api-reference/endpoint/orders/create"},{"title":"Deliver Order","openapi":"PUT /stores/{storeId}/orders/{orderId}/deliver","href":"/api-reference/endpoint/orders/deliver"},{"title":"Refund Order","openapi":"DELETE /stores/{storeId}/orders/{orderId}/refund","href":"/api-reference/endpoint/orders/refund"},{"title":"Re-deliver Order","openapi":"PUT /stores/{storeId}/orders/{orderId}/redeliver","href":"/api-reference/endpoint/orders/redeliver"},{"title":"Get Proof of Payment","openapi":"GET /stores/{storeId}/paymentMethods/custom/orders/{orderId}/proof","href":"/api-reference/endpoint/orders/get-payment-proof"}]},{"group":"Reviews","pages":[{"title":"Get Reviews","openapi":"GET /stores/{storeId}/reviews","href":"/api-reference/endpoint/reviews/get-list"},{"title":"Reply to Review","openapi":"PUT /stores/{storeId}/reviews/{reviewId}/reply","href":"/api-reference/endpoint/reviews/reply"},{"title":"Get Review Analytics","openapi":"GET /stores/{storeId}/reviews/analytics","href":"/api-reference/endpoint/reviews/analytics"}]},{"group":"Affiliates","pages":[{"title":"Get Affiliates","openapi":"GET /stores/{storeId}/affiliates","href":"/api-reference/endpoint/affiliates/get-list"},{"title":"Search Affiliates","openapi":"GET /stores/{storeId}/affiliates/search","href":"/api-reference/endpoint/affiliates/search"},{"title":"Get Affiliate Statistics","openapi":"GET /stores/{storeId}/affiliates/stats","href":"/api-reference/endpoint/affiliates/stats"},{"title":"Create Affiliate","openapi":"POST /stores/{storeId}/affiliates/{customerId}","href":"/api-reference/endpoint/affiliates/create"},{"title":"Update Affiliate","openapi":"PUT /stores/{storeId}/affiliates/{customerId}","href":"/api-reference/endpoint/affiliates/update"},{"title":"Delete Affiliate","openapi":"DELETE /stores/{storeId}/affiliates/{customerId}","href":"/api-reference/endpoint/affiliates/delete"},{"title":"Invite Affiliate","openapi":"POST /stores/{storeId}/affiliates/invite","href":"/api-reference/endpoint/affiliates/invite"},{"title":"Blacklist Affiliate","openapi":"POST /stores/{storeId}/affiliates/{customerId}/blacklist","href":"/api-reference/endpoint/affiliates/blacklist"},{"title":"Configure Affiliate Program","openapi":"PUT /stores/{storeId}/affiliates/configure","href":"/api-reference/endpoint/affiliates/configure"},{"title":"List Affiliate Orders","openapi":"GET /stores/{storeId}/affiliates/{customerId}/orders/{page}","href":"/api-reference/endpoint/affiliates/get-orders"},{"title":"List Affiliate Payouts","openapi":"GET /stores/{storeId}/affiliates/{customerId}/payouts/{page}","href":"/api-reference/endpoint/affiliates/get-payouts"},{"title":"Record Affiliate Payout","openapi":"POST /stores/{storeId}/affiliates/{customerId}/payouts","href":"/api-reference/endpoint/affiliates/record-payout"},{"title":"Void Affiliate Payout","openapi":"PATCH /stores/{storeId}/affiliates/{customerId}/payouts/{payoutId}","href":"/api-reference/endpoint/affiliates/void-payout"}]},{"group":"Affiliate API","pages":[{"title":"Affiliate API","href":"/api-reference/affiliate-api"},{"title":"Get Affiliate Account","openapi":"GET /affiliate","href":"/api-reference/endpoint/affiliate/get-account"},{"title":"List Affiliate Discounts","openapi":"GET /affiliate/discounts","href":"/api-reference/endpoint/affiliate/get-discounts"},{"title":"List Referred Orders","openapi":"GET /affiliate/orders","href":"/api-reference/endpoint/affiliate/get-orders"},{"title":"List Received Payouts","openapi":"GET /affiliate/payouts","href":"/api-reference/endpoint/affiliate/get-payouts"},{"title":"Get Referral Statistics","openapi":"GET /affiliate/stats","href":"/api-reference/endpoint/affiliate/stats"}]},{"group":"Reseller Programme","pages":[{"title":"Get Programme","openapi":"GET /stores/{storeId}/reseller","href":"/api-reference/endpoint/reseller-programme/get"},{"title":"Configure Programme","openapi":"PUT /stores/{storeId}/reseller","href":"/api-reference/endpoint/reseller-programme/configure"},{"title":"Get Catalogue","openapi":"GET /stores/{storeId}/reseller/catalogue","href":"/api-reference/endpoint/reseller-programme/get-catalogue"},{"title":"Add to Catalogue","openapi":"PUT /stores/{storeId}/reseller/catalogue/{variantId}","href":"/api-reference/endpoint/reseller-programme/add-to-catalogue"},{"title":"Remove from Catalogue","openapi":"DELETE /stores/{storeId}/reseller/catalogue/{variantId}","href":"/api-reference/endpoint/reseller-programme/remove-from-catalogue"},{"title":"Get Variant Stats","openapi":"GET /stores/{storeId}/reseller/catalogue/{variantId}/stats","href":"/api-reference/endpoint/reseller-programme/get-variant-stats"},{"title":"Set Volume Tiers","openapi":"PUT /stores/{storeId}/reseller/catalogue/{variantId}/tiers","href":"/api-reference/endpoint/reseller-programme/set-volume-tiers"},{"title":"Get Resellers","openapi":"GET /stores/{storeId}/reseller/resellers","href":"/api-reference/endpoint/reseller-programme/get-resellers"},{"title":"Update Status","openapi":"PUT /stores/{storeId}/reseller/resellers/{resellerId}/status","href":"/api-reference/endpoint/reseller-programme/update-status"},{"title":"Grant Samples","openapi":"POST /stores/{storeId}/reseller/resellers/{resellerId}/samples","href":"/api-reference/endpoint/reseller-programme/grant-samples"},{"title":"Get Invitations","openapi":"GET /stores/{storeId}/reseller/invites","href":"/api-reference/endpoint/reseller-programme/get-invites"},{"title":"Create Invitation","openapi":"POST /stores/{storeId}/reseller/invites","href":"/api-reference/endpoint/reseller-programme/create-invite"},{"title":"Delete Invitation","openapi":"DELETE /stores/{storeId}/reseller/invites/{inviteId}","href":"/api-reference/endpoint/reseller-programme/delete-invite"},{"title":"Get Questions","openapi":"GET /stores/{storeId}/reseller/application/questions","href":"/api-reference/endpoint/reseller-programme/get-questions"},{"title":"Create Question","openapi":"POST /stores/{storeId}/reseller/application/questions","href":"/api-reference/endpoint/reseller-programme/create-question"},{"title":"Update Question","openapi":"PUT /stores/{storeId}/reseller/application/questions/{questionId}","href":"/api-reference/endpoint/reseller-programme/update-question"},{"title":"Delete Question","openapi":"DELETE /stores/{storeId}/reseller/application/questions/{questionId}","href":"/api-reference/endpoint/reseller-programme/delete-question"},{"title":"Get Applications","openapi":"GET /stores/{storeId}/reseller/application/submissions","href":"/api-reference/endpoint/reseller-programme/get-applications"},{"title":"Create Application","openapi":"POST /stores/{storeId}/reseller/applications","href":"/api-reference/endpoint/reseller-programme/create-application"},{"title":"Get Bundles","openapi":"GET /stores/{storeId}/reseller/bundles","href":"/api-reference/endpoint/reseller-programme/get-bundles"},{"title":"Create Bundle","openapi":"POST /stores/{storeId}/reseller/bundles","href":"/api-reference/endpoint/reseller-programme/create-bundle"},{"title":"Update Bundle","openapi":"PUT /stores/{storeId}/reseller/bundles/{bundleId}","href":"/api-reference/endpoint/reseller-programme/update-bundle"},{"title":"Delete Bundle","openapi":"DELETE /stores/{storeId}/reseller/bundles/{bundleId}","href":"/api-reference/endpoint/reseller-programme/delete-bundle"},{"title":"Get Basket Discounts","openapi":"GET /stores/{storeId}/reseller/basket-tiers","href":"/api-reference/endpoint/reseller-programme/get-basket-tiers"},{"title":"Create Basket Discount","openapi":"POST /stores/{storeId}/reseller/basket-tiers","href":"/api-reference/endpoint/reseller-programme/create-basket-tier"},{"title":"Update Basket Discount","openapi":"PUT /stores/{storeId}/reseller/basket-tiers/{basketTierId}","href":"/api-reference/endpoint/reseller-programme/update-basket-tier"},{"title":"Delete Basket Discount","openapi":"DELETE /stores/{storeId}/reseller/basket-tiers/{basketTierId}","href":"/api-reference/endpoint/reseller-programme/delete-basket-tier"},{"title":"Get Leaderboard","openapi":"GET /stores/{storeId}/reseller/leaderboard","href":"/api-reference/endpoint/reseller-programme/get-leaderboard"}]},{"group":"Reselling","pages":[{"title":"Get Suppliers","openapi":"GET /stores/{storeId}/reselling/suppliers","href":"/api-reference/endpoint/reselling/get-suppliers"},{"title":"Find Supplier","openapi":"GET /stores/{storeId}/reselling/suppliers/lookup","href":"/api-reference/endpoint/reselling/find-supplier"},{"title":"Apply to Supplier","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}","href":"/api-reference/endpoint/reselling/apply"},{"title":"Get Catalogue","openapi":"GET /stores/{storeId}/reselling/suppliers/{supplierStoreId}/catalogue","href":"/api-reference/endpoint/reselling/get-catalogue"},{"title":"Get Bundles","openapi":"GET /stores/{storeId}/reselling/suppliers/{supplierStoreId}/bundles","href":"/api-reference/endpoint/reselling/get-bundles"},{"title":"Buy Basket","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}/basket","href":"/api-reference/endpoint/reselling/buy-basket"},{"title":"Quote Basket","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}/basket/quote","href":"/api-reference/endpoint/reselling/quote-basket"},{"title":"Buy Stock","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}/stock","href":"/api-reference/endpoint/reselling/buy-stock"},{"title":"Get Draws","openapi":"GET /stores/{storeId}/reselling/suppliers/{supplierStoreId}/draws","href":"/api-reference/endpoint/reselling/get-draws"},{"title":"Add Funds","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}/topup","href":"/api-reference/endpoint/reselling/add-funds"},{"title":"Get Payment Methods","openapi":"GET /stores/{storeId}/reselling/suppliers/{supplierStoreId}/payment-methods","href":"/api-reference/endpoint/reselling/get-payment-methods"},{"title":"Create Listing","openapi":"PUT /stores/{storeId}/reselling/suppliers/{supplierStoreId}/listings/{sourceVariantId}","href":"/api-reference/endpoint/reselling/create-listing"},{"title":"Delete Listing","openapi":"DELETE /stores/{storeId}/reselling/suppliers/{supplierStoreId}/listings/{sourceVariantId}","href":"/api-reference/endpoint/reselling/delete-listing"},{"title":"Get Resold Products","openapi":"GET /stores/{storeId}/reselling/products","href":"/api-reference/endpoint/reselling/get-products"},{"title":"Get Linkable Accounts","openapi":"GET /stores/{storeId}/reselling/linkable","href":"/api-reference/endpoint/reselling/get-linkable"},{"title":"Link Account","openapi":"POST /stores/{storeId}/reselling/linkable/{resellerId}","href":"/api-reference/endpoint/reselling/link-account"},{"title":"Accept Invitation","openapi":"POST /stores/{storeId}/reselling/invites/accept","href":"/api-reference/endpoint/reselling/accept-invite"}]},{"group":"Webhooks","pages":[{"title":"Get Webhooks","openapi":"GET /webhooks","href":"/api-reference/endpoint/webhooks/get-list"},{"title":"Create Webhook","openapi":"POST /webhooks","href":"/api-reference/endpoint/webhooks/create"},{"title":"Get Webhook","openapi":"GET /webhooks/{webhookId}","href":"/api-reference/endpoint/webhooks/get"},{"title":"Update Webhook","openapi":"PUT /webhooks/{webhookId}","href":"/api-reference/endpoint/webhooks/update"},{"title":"Delete Webhook","openapi":"DELETE /webhooks/{webhookId}","href":"/api-reference/endpoint/webhooks/delete"},{"title":"Get Webhook Logs","openapi":"GET /webhooks/{webhookId}/logs","href":"/api-reference/endpoint/webhooks/get-logs"},{"title":"Resend Webhook","openapi":"POST /webhooks/{webhookId}/logs/{executionLogId}/resend","href":"/api-reference/endpoint/webhooks/resend"},{"title":"Search Webhook Logs","openapi":"GET /webhooks/{webhookId}/logs/search/{query}","href":"/api-reference/endpoint/webhooks/search-logs"}]}]},{"tab":"SDK de Tienda","pages":[{"title":"SDK de Tienda","href":"/es/storefront/introduction"}]}]}]},"basePath":"","title":"Get User - Komerza Documentation","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","Page-Bevw23-4.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Markdown-BOgQCTwD.js","clsx-BIWXJmsZ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DKZWslLH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-UDqbR6xh.js"]}