This is a partner-generated ID to map a subscription. Partners can use this to query the subscriptions as well. This cannot be the same for two subscriptions.
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"TransactBridge Developer Kit","colors":{"primary":"#007bff","light":"#007bff","dark":"#007bff"},"logo":{"light":"https://mintcdn.com/transactbridge/AUMzJw7lV4Z0k5oq/logo/light.svg?fit=max\u0026auto=format\u0026n=AUMzJw7lV4Z0k5oq\u0026q=85\u0026s=a4112e5d2a5685d273285d995ed4b1c4","dark":"https://mintcdn.com/transactbridge/AUMzJw7lV4Z0k5oq/logo/dark.svg?fit=max\u0026auto=format\u0026n=AUMzJw7lV4Z0k5oq\u0026q=85\u0026s=4917537b5264793d4c7fb9baa30ab610"},"favicon":"https://mintcdn.com/transactbridge/AUMzJw7lV4Z0k5oq/favicon.svg?fit=max\u0026auto=format\u0026n=AUMzJw7lV4Z0k5oq\u0026q=85\u0026s=e9ce7bc27d535ec848648091166a861a","navbar":{"links":[{"href":"mailto:info@transactbridge.com.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://reseller.transactbridge.com/admin/dashboard"}},"footer":{"socials":{"x":"https://x.com/transactbridge","linkedin":"https://linkedin.com/company/transactbridge","website":"https://transactbridge.com"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"API Endpoints","icon":"book-open-cover","href":"https://docs.transactbridge.com"},{"anchor":"Blog","icon":"newspaper","href":"https://transactbridge.com/blog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"transactbridge","hasAudioNarration":false,"actualSubdomain":"transactbridge","customDomains":["developer.transactbridge.com"],"gitSource":{"type":"github","owner":"transactbridgeorg","repo":"mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae84767ed2f58cb10edb10e","collectionId":"d2d6241c-41eb-487f-817b-6f305c36cf92","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae84767ed2f58cb10edb10e"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6aea0a0a8c693588234f7efa","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"API Reference","count":57},{"language":"default","tag":"Subscription","count":39},{"language":"default","tag":"Guides","count":23},{"language":"default","tag":"Features","count":21},{"language":"default","tag":"Checkout","count":20},{"language":"default","tag":"One Time Payments","count":16},{"language":"default","tag":"Web SDK","count":12},{"language":"default","tag":"Manage Subscription","count":12},{"language":"default","tag":"Dropin","count":11},{"language":"default","tag":"API Documentation","count":10}]},"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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/subscription/single-payment-subscription","slug":"/api-reference/subscription/single-payment-subscription","pageMetadata":{"title":"Single Payment Subscription","description":"This API is used to create a new invoice on an ACTIVE subscription, that can be shared with a customer.","deprecated":null,"version":null,"openapi":"/api-reference/subscriptions/subs.json post /subscription/v1.0/singlePaymentSubscription","href":"/api-reference/subscription/single-payment-subscription","autogeneratedByOpenApi":true},"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: \"This API is used to create a new invoice on an ACTIVE subscription, that can be shared with a customer.\"\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":"Single Payment Subscription","description":"This API is used to create a new invoice on an ACTIVE subscription, that can be shared with a customer.","deprecated":null,"version":null,"openapi":"/api-reference/subscriptions/subs.json post /subscription/v1.0/singlePaymentSubscription","href":"/api-reference/subscription/single-payment-subscription","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/transactbridge/089a9976a162a023/floating-help.js","/_mintlify/custom/transactbridge/0e5ec01044da9a9c/.prettierrc.js"],"openApiReferenceData":{"operation":{"summary":"Single Payment Subscription","description":"This API is used to create a new invoice on an ACTIVE subscription, that can be shared with a customer.","operationId":"singlePaymentSubscription","tags":["Subscription"],"requestBody":"7e6a06dc-602f-467c-9705-4a53106ff612","responses":{"200":"527dccec-4f73-49ff-81da-56231206a0b1"},"method":"post","type":"path","servers":["e834658b-c3f7-4f95-88ec-14a9a3e8e059","4756c6ae-67d9-4340-b6e9-4acda2b122da"],"security":["c9eb5758-3f7d-4587-a919-811dd6b98a4a"],"path":"/subscription/v1.0/singlePaymentSubscription","baseUrlOptions":["https://sandbox-api.transactbridge.com","https://api.transactbridge.com"],"title":"Single Payment Subscription","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscriptionId","returnUrl","items","referenceId"],"properties":{"subscriptionId":{"type":"string","format":"MongoId","description":"This is transact bridge subscription Id","isRequired":true,"uniqueKey":"subscriptionId","typeLabel":"string\u003cMongoId>"},"referenceId":{"type":"string","format":"referenceId","description":"This is a partner-generated ID to map a subscription. Partners can use this to query the subscriptions as well. This cannot be the same for two subscriptions.","isRequired":true,"uniqueKey":"referenceId","typeLabel":"string\u003creferenceId>"},"returnUrl":{"type":"string","description":"This URL is needed to redirect the user after the session is completed.","example":"https://example.com/payment/success","isRequired":true,"uniqueKey":"returnUrl","typeLabel":"string"},"items":{"type":"array","description":"Items the customer wants to buy.","items":{"type":"object","required":["productReferenceId","name","quantity","amount"],"properties":{"productReferenceId":{"type":"string","format":"referenceId","description":"If the product is already created use the refereneId of that product.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].productReferenceId","typeLabel":"string\u003creferenceId>"},"name":{"type":"string","description":"Name of the product the customer wants to buy. Name is not mandatory if productReferenceId is passed.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].name","typeLabel":"string"},"quantity":{"type":"number","description":"Number of products the customer wants to buy.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].quantity","typeLabel":"number"},"amount":{"type":"number","description":"Price of the product.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].amount","typeLabel":"number"},"description":{"type":"string","description":"Description of the product.\nDescription in the items object allows HTML syntax for customer view. Use so that the description on the product page is better from a UI perspective. We break and show the description like unlisted items.","uniqueKey":"\\items.items.[INDEX].description","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"\\items","typeLabel":"object[]"},"mandatePay":{"type":"boolean","default":false,"description":"If marked as **`true`** then the invoice will be paid through the current mandate.","example":false,"uniqueKey":"mandatePay","typeLabel":"boolean"},"payMethod":{"type":"array","description":"If payMethod parameter is sent by the partner then on the payment page for the customer only that payment method will be visible to user.","items":{"type":"string","enum":["UPI","NB","CC","DC"],"uniqueKey":"payMethod.items.[INDEX]","typeLabel":"enum\u003cstring>"},"example":["UPI","CC"],"uniqueKey":"payMethod","typeLabel":"enum\u003cstring>[]"},"dayUntillDue":{"type":"string","description":"Period of time from the issue date after which **`DUE`** invoice is converted into **`OVERDUE`** status","example":"7","uniqueKey":"dayUntillDue","typeLabel":"string"},"reAttempt":{"type":"array","description":"To configure how the reattempt for failed invoices be processed.","items":{"type":"object","uniqueKey":"reAttempt.items.[INDEX]","typeLabel":"object"},"uniqueKey":"reAttempt","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"subscriptionId":"\u003cstring>","referenceId":"\u003cstring>","returnUrl":"https://example.com/payment/success","items":[{"productReferenceId":"\u003cstring>","name":"\u003cstring>","quantity":123,"amount":123,"description":"\u003cstring>"}],"mandatePay":false,"payMethod":["UPI","CC"],"dayUntillDue":"7","reAttempt":[{}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"527dccec-4f73-49ff-81da-56231206a0b1":{"description":"Contains the subscriptionId and URL","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"The response from the API","uniqueKey":"status","typeLabel":"string"},"sub_status":{"type":"string","description":"Used for internal purposes only","uniqueKey":"sub_status","typeLabel":"string"},"data":{"type":"object","description":"Contains the subscriptionId and URL.","properties":{"subscriptionId":{"type":"string","description":"Transact Bridge subscription Id","uniqueKey":"data.subscriptionId","typeLabel":"string"},"url":{"type":"string","description":"URL to redirect the user after the session is completed.","uniqueKey":"data.url","typeLabel":"string"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"\u003cstring>","sub_status":"\u003cstring>","data":{"subscriptionId":"\u003cstring>","url":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"c9eb5758-3f7d-4587-a919-811dd6b98a4a":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"Merchant API Key","scopes":[],"schemeName":"ApiKeyAuth"},"SignatureAuth":{"type":"apiKey","in":"header","name":"x-signature","description":"Generated request signature","scopes":[],"schemeName":"SignatureAuth"}}},"servers":{"e834658b-c3f7-4f95-88ec-14a9a3e8e059":{"url":"https://sandbox-api.transactbridge.com","description":"Sandbox Environment"},"4756c6ae-67d9-4340-b6e9-4acda2b122da":{"url":"https://api.transactbridge.com","description":"Production Environment"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","description":"Merchant API Key","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"x-api-key","type":"string","description":"Merchant API Key","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"x-api-key"},{"scheme":{"type":"apiKey","in":"header","name":"x-signature","description":"Generated request signature","scopes":[],"schemeName":"SignatureAuth"},"schema":{"title":"x-signature","type":"string","description":"Generated request signature","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"SignatureAuth","name":"x-signature"}],"title":"ApiKeyAuth \u0026 SignatureAuth"}]},"originalFileLocation":"api-reference/subscriptions/subs.json"},"subdomain":"transactbridge","siteName":"TransactBridge Developer Kit","title":"Single Payment Subscription - TransactBridge Developer Kit","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-03T16:21:37.813Z","originalFileLocation":"api-reference/subscription/single-payment-subscription.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=\"description\" content=\"This API is used to create a new invoice on an ACTIVE subscription, that can be shared with a customer.\">\u003cmeta data-mint-head name=\"application-name\" content=\"TransactBridge Developer Kit\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/transactbridge/X3kFY3fAw4BsM2CG/_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/transactbridge/X3kFY3fAw4BsM2CG/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/transactbridge/X3kFY3fAw4BsM2CG/_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/transactbridge/X3kFY3fAw4BsM2CG/_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/transactbridge/X3kFY3fAw4BsM2CG/_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/transactbridge/X3kFY3fAw4BsM2CG/_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/transactbridge/X3kFY3fAw4BsM2CG/_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/transactbridge/X3kFY3fAw4BsM2CG/_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/transactbridge/X3kFY3fAw4BsM2CG/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Single Payment Subscription - TransactBridge Developer Kit\">\u003cmeta data-mint-head property=\"og:description\" content=\"This API is used to create a new invoice on an ACTIVE subscription, that can be shared with a customer.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"TransactBridge Developer Kit\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.transactbridge.com/api-reference/subscription/single-payment-subscription\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://transactbridge.mintlify.app/_mintlify/api/og/v2?division=Subscription\u0026amp;title=Single+Payment+Subscription\u0026amp;description=This+API+is+used+to+create+a+new+invoice+on+an+ACTIVE+subscription%2C+that+can+be+shared+with+a+customer.\u0026amp;theme=3433087150f3e7110fcb26b6\u0026amp;signature=6d6c826d632cce8b38f831fa6791620f0fbee3696fe4eb37ea3745aa4fb0fc07\">\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=\"Single Payment Subscription - TransactBridge Developer Kit\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"This API is used to create a new invoice on an ACTIVE subscription, that can be shared with a customer.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://transactbridge.mintlify.app/_mintlify/api/og/v2?division=Subscription\u0026amp;title=Single+Payment+Subscription\u0026amp;description=This+API+is+used+to+create+a+new+invoice+on+an+ACTIVE+subscription%2C+that+can+be+shared+with+a+customer.\u0026amp;theme=3433087150f3e7110fcb26b6\u0026amp;signature=6d6c826d632cce8b38f831fa6791620f0fbee3696fe4eb37ea3745aa4fb0fc07\">\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/transactbridge/X3kFY3fAw4BsM2CG/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"TransactBridge Developer Kit\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#007bff\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.transactbridge.com/api-reference/subscription/single-payment-subscription\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/subscription/single-payment-subscription.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.transactbridge.com/#organization\",\"name\":\"TransactBridge Developer Kit\",\"url\":\"https://developer.transactbridge.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/transactbridge/AUMzJw7lV4Z0k5oq/logo/light.svg?fit=max\u0026auto=format\u0026n=AUMzJw7lV4Z0k5oq\u0026q=85\u0026s=a4112e5d2a5685d273285d995ed4b1c4\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.transactbridge.com#website\",\"name\":\"TransactBridge Developer Kit\",\"url\":\"https://developer.transactbridge.com\",\"publisher\":{\"@id\":\"https://developer.transactbridge.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.transactbridge.com/api-reference/subscription/single-payment-subscription#webpage\",\"url\":\"https://developer.transactbridge.com/api-reference/subscription/single-payment-subscription\",\"name\":\"Single Payment Subscription\",\"description\":\"This API is used to create a new invoice on an ACTIVE subscription, that can be shared with a customer.\",\"dateModified\":\"2026-11-03T16:21:37.813Z\",\"isPartOf\":{\"@id\":\"https://developer.transactbridge.com#website\"},\"breadcrumb\":{\"@id\":\"https://developer.transactbridge.com/api-reference/subscription/single-payment-subscription#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.transactbridge.com/api-reference/subscription/single-payment-subscription#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Subscription\",\"item\":\"https://developer.transactbridge.com/api-reference/subscription/add-subscription\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Single Payment Subscription\",\"item\":\"https://developer.transactbridge.com/api-reference/subscription/single-payment-subscription\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.transactbridge.com/api-reference/subscription/single-payment-subscription#apireference\",\"headline\":\"Single Payment Subscription\",\"name\":\"Single Payment Subscription\",\"description\":\"This API is used to create a new invoice on an ACTIVE subscription, that can be shared with a customer.\",\"url\":\"https://developer.transactbridge.com/api-reference/subscription/single-payment-subscription\",\"mainEntityOfPage\":{\"@id\":\"https://developer.transactbridge.com/api-reference/subscription/single-payment-subscription#webpage\"},\"dateModified\":\"2026-11-03T16:21:37.813Z\",\"publisher\":{\"@id\":\"https://developer.transactbridge.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.transactbridge.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"TransactBridge Developer Kit\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"TransactBridge Developer Kit","nav":{"global":{"anchors":[{"anchor":"API Endpoints","icon":"book-open-cover","href":"https://docs.transactbridge.com"},{"anchor":"Blog","icon":"newspaper","href":"https://transactbridge.com/blog"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/introduction"}]},{"tab":"One Time Payments","pages":[{"title":"One Time Payments","href":"/one-time-payments/getting-started/overview"}]},{"tab":"Subscription","pages":[{"title":"Subscription","href":"/subscription/getting-started/overview"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Environments","href":"/api-reference/environments"},{"title":null,"href":"/api-reference/authorization"},{"title":"Validators and Enum","href":"/api-reference/validators-and-enum"},{"title":"Request and Response","href":"/api-reference/request-response"},{"title":"Errors And Status Code","href":"/api-reference/errors-status-code"},{"title":null,"href":"/api-reference/definitions"},{"title":"Webhooks","href":"/api-reference/webhook"},{"title":"Sandbox Testing Details","href":"/api-reference/uat-testing-details"},{"title":"Going Live","href":"/api-reference/go-live"}]},{"group":"Session","pages":[{"title":"Generate Billing Session","deprecated":null,"version":null,"openapi":"/api-reference/onetimepayments/sessions.json post /billingSession/v1.0/generateBillingSession","href":"/api-reference/sessions/generate-billing-session"},{"title":"Get Session","deprecated":null,"version":null,"openapi":"/api-reference/onetimepayments/sessions.json post /billingSession/v1.0/getBillingSession","href":"/api-reference/sessions/get-session"},{"title":"Get All Sessions","deprecated":null,"version":null,"openapi":"/api-reference/onetimepayments/sessions.json post /billingSession/v1.0/getAllBillingSession","href":"/api-reference/sessions/get-all-sessions"}]},{"group":"Subscription","pages":[{"title":"Add Subscription","deprecated":null,"version":null,"openapi":"/api-reference/subscriptions/subs.json post /subscription/v1.0/addSubscription","href":"/api-reference/subscription/add-subscription"},{"title":"Get Subscription","deprecated":null,"version":null,"openapi":"/api-reference/subscriptions/subs.json post /subscription/v1.0/getSubscription","href":"/api-reference/subscription/get-subscription"},{"title":"Get All Subscription","deprecated":null,"version":null,"openapi":"/api-reference/subscriptions/subs.json post /subscription/v1.0/getAllSubscription","href":"/api-reference/subscription/get-all-subscription"},{"title":"Update Subscription","deprecated":null,"version":null,"openapi":"/api-reference/subscriptions/subs.json post /subscription/v1.0/updateSubscription","href":"/api-reference/subscription/update-subscription"},{"title":"Update Subscription Summary","deprecated":null,"version":null,"openapi":"/api-reference/subscriptions/subs.json post /subscription/v1.0/updateSubscriptionSummary","href":"/api-reference/subscription/update-subscription-summary"},{"title":"Cancel Subscription","deprecated":null,"version":null,"openapi":"/api-reference/subscriptions/subs.json post /subscription/v1.0/cancelSubscription","href":"/api-reference/subscription/cancel-subscription"},{"title":"Pause Subscription","deprecated":null,"version":null,"openapi":"/api-reference/subscriptions/subs.json post /subscription/v1.0/pauseSubscription","href":"/api-reference/subscription/pause-subscription"},{"title":"Unpause Subscription","description":"This API is used to mark a **`PAUSED`** subscription to **`ACTIVE`**. This API updates the status of the subscription to **`ACTIVE`**. **`PAUSED`**, a subscription can be **`UNPAUSED`** to reinstate the billing. If the subscription is marked **`ACTIVE`** in the same billing cycle in which it was marked **`PAUSED`** it would not be considered **`PAUSED`** at all and the billing cycle will be considered to be used fully.\n\nPartner cannot unpause a subscription if the subscription was in PAUSED state and the renewal date of the subscription has passed. Partner can create new subscription and the adjustment credits from the previous PAUSED subscription will be used automatically.\n\nTo test the pause flow, partner can use **`unpausedDate`** parameter in non-production environment. The value of **`unpausedDate`** is a future date at which the subscription will be considered to be unpaused. This will help to check the adjustment credits and other payment flow.","deprecated":null,"version":null,"openapi":"/api-reference/subscriptions/subs.json post /subscription/v1.0/unpauseSubscription","href":"/api-reference/subscription/unpause-subscription"},{"title":"Single Payment Subscription","deprecated":null,"version":null,"openapi":"/api-reference/subscriptions/subs.json post /subscription/v1.0/singlePaymentSubscription","href":"/api-reference/subscription/single-payment-subscription"}]},{"group":"Mandate","pages":[{"title":"Get Mandate","description":"Mandates allow us to auto-debit the amount from the customer's bank account. Mandate transactions can be of ₹ 2 value for subscriptions with **`billAtStart`** marked as **`false`** or the actual amount of subscription value for those with **`billAtStart`** marked as **`true`**.\n\nIn India, a mandate needs a minimum of 24 hours from the bank to get permission to initiate auto-debit. So, if on the 1st of the month, we post a request to the bank to ask permission for an auto-debit amount from the customer's bank account, the bank will notify the customer about the due amount, and after 24 hours we will give permission to invoke auto-debit on the customer's bank account and after that we will be able to deduct the amount. So on the 2nd of the month, we will try to deduct the money from the customer's bank account.\n\nA mandate can be canceled by the end-user using his/her banking app. If a customer has cancelled his mandate we push this event to the mandate web-hook configured by the partner. It is a good practice to check periodically if the mandate linked with the subscription is still in **`ACTIVE`** state or not. If not the customer should be prompted to add a new mandate to make sure the subscription remains active. The partner can ask for a new mandate using [Update Mandate API](https://docs.transactbridge.com/#b7abc54b-bf8a-4569-8f65-46b613600d47).\n This API is used for getting a specific mandate. The partner can pass the _id as txId or pass the ref_id that was used in the initiation of the payment.","deprecated":null,"version":null,"openapi":"/api-reference/Mandate/mand.json post /subscription/v1.0/getMandate","href":"/api-reference/mandate/get-mandate"},{"title":"Get All Mandates","deprecated":null,"version":null,"openapi":"/api-reference/Mandate/mand.json post /subscription/v1.0/getAllMandates","href":"/api-reference/mandate/get-all-mandates"},{"title":"Add Mandate","deprecated":null,"version":null,"openapi":"/api-reference/Mandate/mand.json post /subscription/v1.0/updateSubscriptionMandate","href":"/api-reference/mandate/add-mandate"}]},{"group":"Invoices","pages":[{"title":"Get Invoice","deprecated":null,"version":null,"openapi":"/api-reference/invoices/invoice.json post /invoice/v1.0/getInvoice","href":"/api-reference/invoice/get-invoice"},{"title":"Get All Invoices","deprecated":null,"version":null,"openapi":"/api-reference/invoices/invoice.json post /invoice/v1.0/getAllInvoice","href":"/api-reference/invoice/get-all-invoices"},{"title":"Update Draft Invoice","deprecated":null,"version":null,"openapi":"/api-reference/invoices/invoice.json post /invoice/v1.0/updateDraftInvoice","href":"/api-reference/invoice/update-draft-invoice"},{"title":"Approve Draft Invoice","deprecated":null,"version":null,"openapi":"/api-reference/invoices/invoice.json post /invoice/v1.0/approveInvoice","href":"/api-reference/invoice/approve-draft-invoice"},{"title":"Refund Invoice","deprecated":null,"version":null,"openapi":"/api-reference/invoices/invoice.json post /invoice/v1.0/createRefund","href":"/api-reference/invoice/refund-invoice"},{"title":"Send Invoice Email","deprecated":null,"version":null,"openapi":"/api-reference/invoices/invoice.json post /invoice/v1.0/sendInvoiceEmail","href":"/api-reference/invoice/send-invoice-email"}]},{"group":"Transactions","pages":[{"title":"Get Transaction","deprecated":null,"version":null,"openapi":"/api-reference/Transactions/transaction.json post /transaction/v1.0/getTransaction","href":"/api-reference/transaction/get-transaction"},{"title":"Get All Transactions","deprecated":null,"version":null,"openapi":"/api-reference/Transactions/transaction.json post /transaction/v1.0/getDepositTxs","href":"/api-reference/transaction/get-all-transactions"},{"title":"Create Refund Transaction","deprecated":null,"version":null,"openapi":"/api-reference/Transactions/transaction.json post /transaction/v1.0/createRefund","href":"/api-reference/transaction/create-refund-transaction"}]},{"group":"Settlements","pages":[{"title":"Get Settlement","deprecated":null,"version":null,"openapi":"/api-reference/Settlements/settlements.json post /settlement/v1.0/getSettlement","href":"/api-reference/settlement/get-settlement"},{"title":"Get All Settlements","deprecated":null,"version":null,"openapi":"/api-reference/Settlements/settlements.json post /settlement/v1.0/getAllSettlements","href":"/api-reference/settlement/get-all-settlements"},{"title":"Get Unsettled Balance","deprecated":null,"version":null,"openapi":"/api-reference/Settlements/settlements.json post /settlement/v1.0/getUnsettledBalance","href":"/api-reference/settlement/get-unsettled-balance"}]},{"group":"Customers","pages":[{"title":"Create Customer","deprecated":null,"version":null,"openapi":"/api-reference/customers/customer.json post /customer/v1.0/addCustomer","href":"/api-reference/customer/create-customer"},{"title":"Update Customer","deprecated":null,"version":null,"openapi":"/api-reference/customers/customer.json post /customer/v1.0/updateCustomer","href":"/api-reference/customers/update-customer"},{"title":"Get Customer","deprecated":null,"version":null,"openapi":"/api-reference/customers/customer.json post /customer/v1.0/getCustomer","href":"/api-reference/customer/get-customer"},{"title":"Get All Customers","deprecated":null,"version":null,"openapi":"/api-reference/customers/customer.json post /customer/v1.0/getAllCustomer","href":"/api-reference/customer/get-all-customers"},{"title":"Search Customer","deprecated":null,"version":null,"openapi":"/api-reference/customers/customer.json post /customer/v1.0/searchCustomer","href":"/api-reference/customer/search-customer"}]},{"group":"Products","pages":[{"title":"Create Product","deprecated":null,"version":null,"openapi":"/api-reference/Products/product.json post /product/v1.0/createProduct","href":"/api-reference/product/create-product"},{"title":"Get Product","deprecated":null,"version":null,"openapi":"/api-reference/Products/product.json post /product/v1.0/getProduct","href":"/api-reference/product/get-product"},{"title":"Get All Products","deprecated":null,"version":null,"openapi":"/api-reference/Products/product.json post /product/v1.0/getAllProduct","href":"/api-reference/product/get-all-products"},{"title":"Calculate Product Taxes","deprecated":null,"version":null,"openapi":"/api-reference/Products/product.json post /product/v1.0/calProductSummary","href":"/api-reference/product/calculate-product-taxes"},{"title":"Update Product","deprecated":null,"version":null,"openapi":"/api-reference/Products/product.json post /product/v1.0/updateProduct","href":"/api-reference/product/update-product"}]},{"group":"Distribution","pages":[{"title":"Validate Product","deprecated":null,"version":null,"openapi":"/api-reference/distributions/distribution.json post /webstore/v1.0/validateProductTopupDetails","href":"/api-reference/distribution/validate-product"},{"title":"Create Payment Session","deprecated":null,"version":null,"openapi":"/api-reference/distributions/distribution.json post /billingSession/v1.0/generateBillingSession","href":"/api-reference/sessions/create-payment-session"},{"title":"Get Order Details","deprecated":null,"version":null,"openapi":"/api-reference/distributions/distribution.json post /billingSession/v1.0/getOrderDetails","href":"/api-reference/distribution/get-order-details"}]},{"group":"PACB","pages":[{"title":null,"href":"/api-reference/pacb/overview"},{"title":"Create Payment Request","deprecated":null,"version":null,"openapi":"/api-reference/pacb/pacb.json post /payment/v1.0/createPaymentRequest","href":"/api-reference/pacb/create-payment-request"},{"title":"Create Payment Link","deprecated":null,"version":null,"openapi":"/api-reference/pacb/pacb.json post /payment/v1.0/createPaymentLink","href":"/api-reference/pacb/create-payment-link"},{"title":"Upload Payment Verification Details","deprecated":null,"version":null,"openapi":"/api-reference/pacb/pacb.json post /transaction/v1.0/uploadPaymentVerificationDetails","href":"/api-reference/pacb/upload-payment-verification-details"},{"title":"Get Transaction Status","deprecated":null,"version":null,"openapi":"/api-reference/pacb/pacb.json post /transaction/v1.0/getTransaction","href":"/api-reference/transaction/get-transaction-status"}]},{"group":"Others","pages":[{"title":"Get Team Members","deprecated":null,"version":null,"openapi":"/api-reference/others/others.json post /user/v1.0/getAllUsers","href":"/api-reference/others/get-team-members"},{"title":"Get Pincode","deprecated":null,"version":null,"openapi":"/api-reference/others/others.json get /getPincode","href":"/api-reference/get-pincode"}]}]},{"tab":"Checkout","pages":[{"title":"Checkout","href":"/checkout.js/checkout/checkout-overview"}]}]},"basePath":"","title":"Single Payment Subscription - TransactBridge Developer Kit","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"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","Page-Bevw23-4.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.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"]}