Integrate BillBuddy payments and subscriptions through a unified API
BillBuddy provides payment and subscription services for merchants and integration partners. Use a unified API to connect direct payments, batch transactions, transaction queries and subscription management to your existing systems.From one-off payments to recurring debits, BillBuddy supports card payments, payment tokens, bank account payments and scheduled transactions. Hosted subscription pages let customers enter payment details, authorize debits and activate subscriptions. Availability depends on the individual endpoint and the services enabled for your account.This documentation gives third-party developers authentication guidance, complete field definitions, business restrictions, and request and response examples. Read the Quickstart to obtain credentials and use an access token, or explore the API reference for endpoint details and request examples.
Quickstart
Obtain credentials and an access token, then review authentication and request conventions.
API reference
Explore field definitions, business restrictions, and request and response examples.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"BillBuddy API","colors":{"primary":"#2563EB","light":"#2563EB","dark":"#60A5FA"},"api":{"playground":{"display":"interactive","proxy":false},"examples":{"defaults":"all","languages":["curl","python","javascript","php","go","java","ruby"],"autogenerate":false}},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","default":true,"href":"en/introduction"},{"language":"cn","href":"cn/introduction"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"bill-buddy","hasAudioNarration":false,"actualSubdomain":"bill-buddy","customDomains":[],"gitSource":{"type":"github","owner":"billbuddyteam","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":"","_id":"6ae2c549e7eb44cacb512b71"},"chroma":{"latestBuiltDeploymentHistoryId":"6ae45ce25507c0d0db07e2f8","collectionId":"4d6950a8-fc85-48ee-9f6b-6507ae37afd6","liveDeploymentHistoryId":"6ae45ce25507c0d0db07e2f8","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae46817187ae8fd10debe8f","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"cn","tag":"API 参考","count":12},{"language":"en","tag":"API reference","count":12},{"language":"cn","tag":"交易","count":7},{"language":"en","tag":"Transactions","count":7},{"language":"cn","tag":"订阅","count":4},{"language":"en","tag":"Subscriptions","count":4},{"language":"cn","tag":"接入指南","count":2},{"language":"cn","tag":"开始接入","count":2},{"language":"en","tag":"Integration guide","count":2},{"language":"en","tag":"Get started","count":2},{"language":"cn","tag":"认证","count":1},{"language":"en","tag":"Authentication","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"en/introduction","slug":"/en/introduction","pageMetadata":{"mode":"wide","title":"Introduction","description":"Integrate BillBuddy payments and subscriptions through a unified API","href":"/en/introduction"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Integrate BillBuddy payments and subscriptions through a unified API\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Card,CardGroup}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`BillBuddy provides payment and subscription services for merchants and integration partners. Use a unified API to connect direct payments, batch transactions, transaction queries and subscription management to your existing systems.`}),`\n`,_jsx(_components.p,{children:`From one-off payments to recurring debits, BillBuddy supports card payments, payment tokens, bank account payments and scheduled transactions. Hosted subscription pages let customers enter payment details, authorize debits and activate subscriptions. Availability depends on the individual endpoint and the services enabled for your account.`}),`\n`,_jsxs(_components.p,{children:[`This documentation gives third-party developers authentication guidance, complete field definitions, business restrictions, and request and response examples. Read the `,_jsx(_components.strong,{children:`Quickstart`}),` to obtain credentials and use an access token, or explore the `,_jsx(_components.strong,{children:`API reference`}),` for endpoint details and request examples.`]}),`\n`,_jsxs(CardGroup,{cols:2,children:[_jsx(Card,{title:`Quickstart`,icon:`rocket`,href:`/en/quickstart`,children:_jsx(_components.p,{children:`Obtain credentials and an access token, then review authentication and request conventions.`})}),_jsx(Card,{title:`API reference`,icon:`code`,href:`/en/api-reference/transactions/direct-pay`,children:_jsx(_components.p,{children:`Explore field definitions, business restrictions, and request and response examples.`})})]})]})}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":{"mode":"wide","title":"Introduction","description":"Integrate BillBuddy payments and subscriptions through a unified API","href":"/en/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"bill-buddy","siteName":"BillBuddy API","title":"Introduction - BillBuddy API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/en/introduction","matchLevel":0},"cn":{"href":"/cn/introduction","matchLevel":1}}},"lastModified":"2026-10-29T12:41:31.960Z","originalFileLocation":"en/introduction.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=\"Integrate BillBuddy payments and subscriptions through a unified API\">\u003cmeta data-mint-head name=\"application-name\" content=\"BillBuddy API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/bill-buddy/_generated/favicon/apple-touch-icon.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/bill-buddy/_generated/favicon/favicon-32x32.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/bill-buddy/_generated/favicon/favicon-16x16.png?v=3\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/bill-buddy/_generated/favicon/favicon.ico?v=3\">\u003cmeta data-mint-head property=\"og:title\" content=\"Introduction - BillBuddy API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Integrate BillBuddy payments and subscriptions through a unified API\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"BillBuddy API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://bill-buddy.mintlify.app/en/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://bill-buddy.mintlify.app/_mintlify/api/og/v2?division=Get+started\u0026amp;title=Introduction\u0026amp;description=Integrate+BillBuddy+payments+and+subscriptions+through+a+unified+API\u0026amp;theme=64470f610240a2cb772d6400\u0026amp;signature=b563b395953a6da44414df17d53a5ff4934d48748a3b105dedf9c8ba82f42168\">\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=\"Introduction - BillBuddy API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Integrate BillBuddy payments and subscriptions through a unified API\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://bill-buddy.mintlify.app/_mintlify/api/og/v2?division=Get+started\u0026amp;title=Introduction\u0026amp;description=Integrate+BillBuddy+payments+and+subscriptions+through+a+unified+API\u0026amp;theme=64470f610240a2cb772d6400\u0026amp;signature=b563b395953a6da44414df17d53a5ff4934d48748a3b105dedf9c8ba82f42168\">\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=\"https://mintlify.s3.us-west-1.amazonaws.com/bill-buddy/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"BillBuddy API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2563EB\">\u003clink data-mint-head rel=\"canonical\" href=\"https://bill-buddy.mintlify.app/en/introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/en/introduction.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://bill-buddy.mintlify.app/en/introduction\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"zh\" href=\"https://bill-buddy.mintlify.app/cn/introduction\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://bill-buddy.mintlify.app/en/introduction\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://bill-buddy.mintlify.app/#organization\",\"name\":\"BillBuddy API\",\"url\":\"https://bill-buddy.mintlify.app\"},{\"@type\":\"WebSite\",\"@id\":\"https://bill-buddy.mintlify.app#website\",\"name\":\"BillBuddy API\",\"url\":\"https://bill-buddy.mintlify.app\",\"publisher\":{\"@id\":\"https://bill-buddy.mintlify.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://bill-buddy.mintlify.app/en/introduction#webpage\",\"url\":\"https://bill-buddy.mintlify.app/en/introduction\",\"name\":\"Introduction\",\"description\":\"Integrate BillBuddy payments and subscriptions through a unified API\",\"dateModified\":\"2026-10-29T12:41:31.960Z\",\"isPartOf\":{\"@id\":\"https://bill-buddy.mintlify.app#website\"},\"breadcrumb\":{\"@id\":\"https://bill-buddy.mintlify.app/en/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://bill-buddy.mintlify.app/en/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"BillBuddy API\",\"item\":\"https://bill-buddy.mintlify.app\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Introduction\",\"item\":\"https://bill-buddy.mintlify.app/en/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://bill-buddy.mintlify.app/en/introduction#article\",\"headline\":\"Introduction\",\"name\":\"Introduction\",\"description\":\"Integrate BillBuddy payments and subscriptions through a unified API\",\"url\":\"https://bill-buddy.mintlify.app/en/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://bill-buddy.mintlify.app/en/introduction#webpage\"},\"dateModified\":\"2026-10-29T12:41:31.960Z\",\"publisher\":{\"@id\":\"https://bill-buddy.mintlify.app/#organization\"},\"isPartOf\":{\"@id\":\"https://bill-buddy.mintlify.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"BillBuddy API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"BillBuddy API","nav":{"global":null,"languages":[{"language":"en","default":true,"tabs":[{"tab":"Integration guide","groups":[{"group":"Get started","pages":[{"mode":"wide","title":"Introduction","href":"/en/introduction"},{"title":"Quickstart","description":"Authentication, identifiers, amounts, dates and hosted subscription integration","href":"/en/quickstart"}]}]},{"tab":"API reference","pages":[{"title":"API reference","href":"/en/api-reference/transactions/direct-pay"}]}]},{"language":"cn","pages":[{"title":"cn","href":"/cn/introduction"}]}]},"title":"Introduction - BillBuddy API","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":[],"chunks":[]}