Import the Orb collection into Postman. You can download the Postman application.
Orb recommends forking the collection so you can safely add your API key:
Postman environment setup
A full list of available Orb API calls is structured by resource in the left sidebar. In the left sidebar, you can click on the menu button to view the documentation for the given folder or specific API request.
Authentication
Before you generate an API Key, you’ll want to enable test mode in the top left of the Orb UI. Test mode gives you a safe playground that doesn’t affect your production customers or data.
This collection includes a Postman “Environment” called “Test Mode”. In the Orb UI, you’ll want to head over to the API Keys tab in the settings page here to generate an API Key. Once you have that:
Navigate to the environment by clicking the “Environments” tab on the left side, and clicking the “Test Mode” environment.
Fill in the api_key with your API key
Variables allow you to share values within the collection.
To learn more about Postman variables, see the documentation.
Working with the collection
After setup is complete, you are ready to begin making API calls. In the Orb API Reference folder, there are subfolders for each type of API resource listed in the Orb API Reference. Expand the subfolders to see the HTTP methods and API call names.
Was this page helpful?
{"docsConfig":{"theme":"palm","$schema":"https://mintlify.com/docs.json","name":"Orb","colors":{"primary":"#15003F","light":"#7DD3FC","dark":"#15003F"},"logo":{"light":"https://mintcdn.com/orb-9bba378a/LPn-ELJYNR-oFxhG/logo/orb-dark.svg?fit=max\u0026auto=format\u0026n=LPn-ELJYNR-oFxhG\u0026q=85\u0026s=9fbf232788a0bfab91e460473924a06f","dark":"https://mintcdn.com/orb-9bba378a/LPn-ELJYNR-oFxhG/logo/orb-light.svg?fit=max\u0026auto=format\u0026n=LPn-ELJYNR-oFxhG\u0026q=85\u0026s=7d375c8ed123a3f10f67ebef1346f66f"},"favicon":"https://mintcdn.com/orb-9bba378a/LPn-ELJYNR-oFxhG/logo/orb.svg?fit=max\u0026auto=format\u0026n=LPn-ELJYNR-oFxhG\u0026q=85\u0026s=7f05ef56022577fa316499a16c91db8e","api":{"playground":{"display":"simple"},"mdx":{"auth":{"method":"bearer"},"server":"https://api.withorb.com/v1"}},"navbar":{"links":[{"href":"https://support.withorb.com","label":"Support"}],"primary":{"type":"button","label":"Orb dashboard","href":"https://app.withorb.com"}},"footer":{"socials":{"x":"https://x.com/useOrb","github":"https://github.com/orbcorp","linkedin":"https://linkedin.com/company/orbhq"}},"integrations":{"gtm":{"tagId":"GTM-NVW7HVV"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Changelog","icon":"newspaper","color":{"light":"#15003F","dark":"#F9FAFB"},"href":"https://changelog.withorb.com"},{"anchor":"Status","icon":"signal","color":{"light":"#15003F","dark":"#F9FAFB"},"href":"https://status.withorb.com"},{"anchor":"Blog","icon":"book-open-cover","color":{"light":"#15003F","dark":"#F9FAFB"},"href":"https://www.withorb.com/blog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"orb-9bba378a","hasAudioNarration":false,"actualSubdomain":"orb-9bba378a","customDomains":["docs.withorb.com"],"gitSource":{"type":"github","owner":"orbcorp","repo":"dev-docs","deployBranch":"prod-docs","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aff412d37c19af492ceb38a","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"default","tag":"API reference","count":267},{"language":"default","tag":"Documentation","count":103},{"language":"default","tag":"Webhooks","count":90},{"language":"default","tag":"Subscription","count":37},{"language":"default","tag":"Integrations","count":33},{"language":"default","tag":"Plan","count":31},{"language":"default","tag":"Integrations and exports","count":28},{"language":"default","tag":"Customer","count":22},{"language":"default","tag":"Credit","count":18},{"language":"default","tag":"Invoicing","count":17}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"essentials/postman","slug":"/essentials/postman","pageMetadata":{"title":"Postman","description":null,"href":"/essentials/postman"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,img:`img`,li:`li`,ol:`ol`,p:`p`,ul:`ul`,..._provideComponents(),...props.components},{Heading,Tip}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`prerequisites`,children:`Prerequisites`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`An active Orb account`}),`\n`,_jsxs(_components.li,{children:[`Access to your Orb API key `,_jsx(_components.a,{href:`https://app.withorb.com/settings?tab=api_keys`,children:`here`})]}),`\n`,_jsxs(_components.li,{children:[`A free `,_jsx(_components.a,{href:`https://identity.getpostman.com/signup`,children:`Postman Account`})]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`setup`,children:`Setup`}),`\n`,_jsxs(_components.p,{children:[`Import the Orb collection into Postman. You can `,_jsx(_components.a,{href:`https://www.postman.com/downloads/`,children:`download the Postman application`}),`.\nOrb recommends forking the collection so you can safely add your API key:`]}),`\n`,_jsx(_components.p,{children:_jsx(_components.a,{href:`https://god.gw.postman.com/run-collection/20577229-2cfaecbf-54a1-48ec-b012-3bb037213253?action=collection%2Ffork\u0026source=rip_markdown\u0026collection-url=entityId%3D20577229-2cfaecbf-54a1-48ec-b012-3bb037213253%26entityType%3Dcollection%26workspaceId%3D7728bdfa-2fdb-408d-91bc-bef873cb9715`,children:_jsx(_components.img,{src:`https://run.pstmn.io/button.svg`,alt:`Run in Postman`})})}),`\n`,_jsx(Heading,{level:`3`,id:`postman-environment-setup`,children:`Postman environment setup`}),`\n`,_jsx(_components.p,{children:`A full list of available Orb API calls is structured by resource in the left sidebar. In the left sidebar, you can click on the menu button to view the documentation for the given folder or specific API request.`}),`\n`,_jsx(Heading,{level:`4`,id:`authentication`,children:`Authentication`}),`\n`,_jsx(Tip,{children:_jsx(_components.p,{children:`Before you generate an API Key, you’ll want to enable test mode in the top left of the Orb UI. Test mode gives you a safe playground that doesn’t affect your production customers or data.`})}),`\n`,_jsxs(_components.p,{children:[`This collection includes a Postman “Environment” called “Test Mode”. In the Orb UI, you’ll want to head over to the API Keys tab in the settings page `,_jsx(_components.a,{href:`https://app.withorb.com/settings?tab=api_keys`,children:`here`}),` to generate an API Key. Once you have that:`]}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsx(_components.li,{children:`Navigate to the environment by clicking the “Environments” tab on the left side, and clicking the “Test Mode” environment.`}),`\n`,_jsxs(_components.li,{children:[`Fill in the api_key with your API key`,`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Variables allow you to share values within the collection.`}),`\n`,_jsxs(_components.li,{children:[`To learn more about Postman variables, see the `,_jsx(_components.a,{href:`https://learning.postman.com/docs/sending-requests/variables/`,children:`documentation`}),`.`]}),`\n`]}),`\n`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`working-with-the-collection`,children:`Working with the collection`}),`\n`,_jsxs(_components.p,{children:[`After setup is complete, you are ready to begin making API calls. In the Orb API Reference folder, there are subfolders for each type of API resource listed in the `,_jsx(_components.a,{href:`/api-reference`,children:`Orb API Reference`}),`. Expand the subfolders to see the HTTP methods and API call names.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Postman","description":null,"href":"/essentials/postman"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Prerequisites","slug":"prerequisites","depth":2,"children":[]},{"title":"Setup","slug":"setup","depth":2,"children":[{"title":"Postman environment setup","slug":"postman-environment-setup","depth":3,"children":[]},{"title":"Authentication","slug":"authentication","depth":4,"children":[]}]},{"title":"Working with the collection","slug":"working-with-the-collection","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"orb-9bba378a","siteName":"Orb","title":"Postman - Orb","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-16T18:37:46.736Z","originalFileLocation":"essentials/postman.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Orb\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/orb-9bba378a/hy43bbps97NOnsM5/_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/orb-9bba378a/hy43bbps97NOnsM5/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/orb-9bba378a/hy43bbps97NOnsM5/_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/orb-9bba378a/hy43bbps97NOnsM5/_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/orb-9bba378a/hy43bbps97NOnsM5/_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/orb-9bba378a/hy43bbps97NOnsM5/_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/orb-9bba378a/hy43bbps97NOnsM5/_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/orb-9bba378a/hy43bbps97NOnsM5/_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/orb-9bba378a/hy43bbps97NOnsM5/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Postman - Orb\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Orb\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.withorb.com/essentials/postman\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://orb-9bba378a.mintlify.site/_mintlify/api/og/v2?division=Essentials\u0026amp;title=Postman\u0026amp;theme=2186b2a469dd41dc51bb29c5\u0026amp;signature=103e5bf02367b08fb8d2dc33f2eca5978a1d2fce750d6911b671480407f3ecef\">\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=\"Postman - Orb\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://orb-9bba378a.mintlify.site/_mintlify/api/og/v2?division=Essentials\u0026amp;title=Postman\u0026amp;theme=2186b2a469dd41dc51bb29c5\u0026amp;signature=103e5bf02367b08fb8d2dc33f2eca5978a1d2fce750d6911b671480407f3ecef\">\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/orb-9bba378a/hy43bbps97NOnsM5/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Orb\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#15003F\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.withorb.com/essentials/postman\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/essentials/postman.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.withorb.com/#organization\",\"name\":\"Orb\",\"url\":\"https://docs.withorb.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/orb-9bba378a/LPn-ELJYNR-oFxhG/logo/orb-dark.svg?fit=max\u0026auto=format\u0026n=LPn-ELJYNR-oFxhG\u0026q=85\u0026s=9fbf232788a0bfab91e460473924a06f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.withorb.com#website\",\"name\":\"Orb\",\"url\":\"https://docs.withorb.com\",\"publisher\":{\"@id\":\"https://docs.withorb.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.withorb.com/essentials/postman#webpage\",\"url\":\"https://docs.withorb.com/essentials/postman\",\"name\":\"Postman\",\"dateModified\":\"2026-11-16T18:37:46.736Z\",\"isPartOf\":{\"@id\":\"https://docs.withorb.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.withorb.com/essentials/postman#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.withorb.com/essentials/postman#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Essentials\",\"item\":\"https://docs.withorb.com/essentials/authentication\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Postman\",\"item\":\"https://docs.withorb.com/essentials/postman\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.withorb.com/essentials/postman#article\",\"headline\":\"Postman\",\"name\":\"Postman\",\"url\":\"https://docs.withorb.com/essentials/postman\",\"mainEntityOfPage\":{\"@id\":\"https://docs.withorb.com/essentials/postman#webpage\"},\"dateModified\":\"2026-11-16T18:37:46.736Z\",\"publisher\":{\"@id\":\"https://docs.withorb.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.withorb.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Orb\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Orb\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/essentials/postman.md","siteName":"Orb","nav":{"global":{"anchors":[{"anchor":"Changelog","icon":"newspaper","color":{"light":"#15003F","dark":"#F9FAFB"},"href":"https://changelog.withorb.com"},{"anchor":"Status","icon":"signal","color":{"light":"#15003F","dark":"#F9FAFB"},"href":"https://status.withorb.com"},{"anchor":"Blog","icon":"book-open-cover","color":{"light":"#15003F","dark":"#F9FAFB"},"href":"https://www.withorb.com/blog"}]},"tabs":[{"tab":"Documentation","pages":[{"group":"Get started","pages":[{"title":"Overview","href":"/overview"},{"title":"What is Orb?","href":"/introduction"},{"title":"How Orb works","href":"/how-orb-works"},{"title":"Core concepts","href":"/core-concepts"},{"group":"Quickstart","pages":[{"title":"Quickstart overview","sidebarTitle":"Overview","href":"/quickstart-guide"},{"title":"Ingest events","href":"/quickstart/ingest"},{"title":"Create a billable metric","href":"/quickstart/metrics"},{"title":"Build your product catalog","href":"/quickstart/catalog"},{"title":"Package prices into a plan","href":"/quickstart/pricing"},{"title":"Manage subscriptions","href":"/quickstart/subscriptions"},{"title":"Invoice your customers","href":"/quickstart/invoicing"}]},{"title":"Next steps","href":"/next-steps"}]},{"group":"Architecture","pages":[{"title":"Query-based billing","href":"/architecture/query-based-billing"},{"title":"Diff-based engine","href":"/architecture/billing-architecture"}]},{"group":"Essentials","pages":[{"title":"Authentication","href":"/essentials/authentication"},{"title":"Audit logs","href":"/essentials/audit-logs"},{"title":"SDK","description":null,"href":"/essentials/sdk"},{"title":"Postman","href":"/essentials/postman"},{"title":"Timezone localization","description":null,"href":"/essentials/timezones"},{"title":null,"href":"/essentials/production-readiness-review"},{"title":"Dry run requests","href":"/essentials/dry-run"},{"title":"Preview side effects","href":"/essentials/previews"},{"title":"Pending changes","href":"/essentials/pending-changes"}]},{"group":"Events and metrics","pages":[{"title":"Ingest events","href":"/events-and-metrics/event-ingestion"},{"title":"Integrate with cloud storage","href":"/events-and-metrics/cloud-storage-integration"},{"title":"Segment integration","href":"/events-and-metrics/segment-integration"},{"title":"Construct metrics","href":"/events-and-metrics/construct-metrics"},{"title":"Parameterized metrics","href":"/events-and-metrics/parameterized-metrics"},{"title":"Customer aliases","href":"/events-and-metrics/customer-aliases"},{"title":"Hosted rollups","href":"/events-and-metrics/high-throughput-ingestion"},{"title":"Querying data with SQL","href":"/events-and-metrics/querying-with-sql"},{"title":"Events query explorer","href":"/events-and-metrics/query-explorer"},{"title":"Backfill and amend events","href":"/events-and-metrics/reporting-errors"}]},{"group":"Pricebook","pages":[{"title":"Core concepts","href":"/pricebook/core-concepts"},{"title":"Building your pricebook","href":"/pricebook/building"},{"title":"Price configuration","href":"/product-catalog/price-configuration"},{"title":"Dimensional pricing","href":"/product-catalog/dimensional-pricing"},{"title":"Configuring plans","href":"/product-catalog/build-catalog"},{"title":"Managing your pricebook","href":"/pricebook/managing-the-pricebook-and-product-catalog"},{"title":"Handling duplicate prices","href":"/pricebook/handling-duplicate-prices"}]},{"group":"Subscription management","pages":[{"title":"Creating subscriptions","href":"/product-catalog/creating-subscriptions"},{"group":"License pricing","pages":[{"title":"License configuration","href":"/product-catalog/license-pricing"},{"title":"License allocations","href":"/product-catalog/license-allocations"},{"title":"License alerting","href":"/product-catalog/license-alerting"}]},{"group":"Subscription lifecycle management","pages":[{"title":"Subscription edits","href":"/product-catalog/editing-subscriptions"},{"title":"Subscription plan changes","href":"/product-catalog/subscription-plan-change"}]},{"title":"Applying adjustments and discounts","href":"/product-catalog/adjustments"},{"group":"Prepaid credits","pages":[{"title":"Configure prepaid credits","href":"/product-catalog/prepurchase"},{"title":"Credit systems","href":"/product-catalog/credit-systems"},{"title":"Scoped credit blocks","href":"/product-catalog/scoped-credits"}]},{"title":"Executing a price change","href":"/product-catalog/price-changes"},{"title":"View subscription usage","href":"/product-catalog/usage-visibility"},{"title":"Customer hierarchy","href":"/product-catalog/customer-hierarchy"}]},{"group":"Usage alerting","pages":[{"title":"Alerting overview","href":"/usage-alerting/overview"},{"title":"Subscription alerts","href":"/usage-alerting/subscription-alerts"},{"title":"Grouped cost alerts","href":"/usage-alerting/grouped-cost-alerts"},{"title":"Spend alerts","href":"/usage-alerting/spend-alerts"},{"title":"Balance alerts","href":"/usage-alerting/balance-alerts"},{"title":"Spend management","href":"/usage-alerting/spend-management"}]},{"group":"Invoicing","pages":[{"title":"Invoicing Overview","href":"/invoicing/introduction"},{"title":"Multi-entity billing","href":"/multi-entity-billing"},{"title":"Structure and lifecycle","href":"/invoicing/structure"},{"group":"Invoice calculations","pages":[{"title":"Invoice calculations","href":"/invoicing/invoice-calculations"},{"title":"Invoice calculation examples","href":"/invoicing/invoice-calculation-examples"}]},{"title":"Adjust draft invoices","href":"/invoicing/Invoice-adjustments"},{"title":"Invoice issuance","href":"/invoicing/invoice-issuance"},{"title":"Payments","href":"/invoicing/payments"},{"title":"Customer balance","href":"/invoicing/customer-balance-transactions"},{"title":"Invoice portal","href":"/invoicing/invoice-portal"},{"title":"Invoice delivery","href":"/invoicing/invoice-delivery"},{"group":"Invoice deferral","pages":[{"title":"Invoice deferral","sidebarTitle":"Overview","href":"/invoicing/invoice-deferral"},{"title":"Invoice deferral scenarios","sidebarTitle":"Advanced scenarios","href":"/invoicing/invoice-deferral-scenarios"}]},{"title":"Invoice display","href":"/invoicing/invoice-display"},{"title":"One-off invoices","href":"/invoicing/one-off-invoice-creation"},{"title":"Threshold Invoicing","href":"/invoicing/threshold-invoicing"},{"title":"Cumulative invoicing","href":"/invoicing/cumulative-invoicing"},{"title":"Credit notes","href":"/invoicing/credit-notes"},{"title":"CSV downloads","href":"/invoicing/invoice-csv-downloads"}]},{"group":"Collections","pages":[{"title":"AR aging","href":"/financial-operations/ar-aging"},{"title":"Essential dunning","href":"/financial-operations/essential-dunning"},{"title":"Advanced dunning","hidden":true,"href":"/invoicing/advanced-dunning"},{"title":"Collections Automations","href":"/financial-operations/automations"}]},{"group":"Revenue reporting","pages":[{"title":"Reporting configurations","href":"/revenue-reporting/reporting-pivots"},{"title":"Recognition methodology","href":"/revenue-reporting/revenue-recognition"},{"title":"Examples","href":"/revenue-reporting/revenue-recognition-examples"},{"title":"Month-end close","href":"/revenue-reporting/month-end-close"}]},{"group":"Data exports","pages":[{"title":"Data Exports Overview","href":"/data-exports/introduction"},{"title":"Best practices","href":"/data-exports/best-practices"},{"title":"Financial analyses using Orb data","href":"/data-exports/use-cases"},{"title":"Exported resource types","href":"/data-exports/resource-types"},{"group":"Export destinations","pages":[{"title":null,"href":"/data-exports/athena"},{"title":null,"href":"/data-exports/aurora-postgres"},{"title":null,"href":"/data-exports/aurora-mysql"},{"title":null,"href":"/data-exports/big-query"},{"title":null,"href":"/data-exports/clickhouse"},{"title":null,"href":"/data-exports/databricks"},{"title":null,"href":"/data-exports/motherduck"},{"title":null,"href":"/data-exports/postgres"},{"title":null,"href":"/data-exports/redshift"},{"group":"Snowflake","pages":[{"title":null,"href":"/data-exports/snowflake"},{"title":null,"href":"/data-exports/snowflake-password-deprecation"}]},{"title":null,"href":"/data-exports/s3"}]}]},{"group":"Simulations","pages":[{"title":"Introduction","href":"/simulations/introduction"},{"title":"Use case guide: launching new products","href":"/simulations/new-product"},{"title":"Use case guide: evolve existing pricing","href":"/simulations/evolve-pricing"}]},{"group":"Extending Orb","pages":[{"title":"Advanced metrics","href":"/extensibility/advanced-metrics"},{"title":"Custom pricing","href":"/extensibility/custom-pricing"}]}]},{"tab":"Implementation guides","pages":[{"title":"Implementation guides","href":"/tutorials/first-usage-event"}]},{"tab":"API reference","pages":[{"title":"API reference","href":"/api-reference/idempotency"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations-and-exports/introduction"}]}]},"basePath":"","title":"Postman - Orb","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":["a74be98ba7"],"chunks":["zoom-image-lightbox-BguUeq2N.js","lightbox-handle-r17bVUz3.js"]}