Price amount in major units as a decimal string (non-zero).
currency
string
required
Currency code for the price (recognised and enabled).
name
string
required
Display name shown on the payment link (max 100 characters).
Maximum string length: 100
account_ids
integer[]
Settlement account IDs to accept payment on.
account_ref
string
Settlement account reference as an alternative to account_ids.
Maximum string length: 100
after_completion
object
Checkout behaviour after payment or when the link expires. Known keys: type (hosted or redirect), redirect_url (success), failure_redirect_url (expire or Failed), custom_message. Additional keys are stored and returned. Takes precedence over metadata.after_completion.
Show child attributes
available_quantity
integer
Remaining purchasable quantity; set to 1 for single-use links.
Required range: x >= 1
description
string
Human-readable description shown at checkout (max 200 characters).
Maximum string length: 200
expires_at
string
When the payment link expires (must be in the future).
image_url
string
Optional image URL shown on the payment link.
interval
enum<string>
Billing interval unit for recurring links.
Available options:
Unknown,
Minute,
Hour,
Day,
Week,
Month,
Year
intervalCount
integer
Number of interval units between billings. Minimum 1.
Required range: x >= 1
metadata
object
Arbitrary key-value metadata (max 10 entries). after_completion may also be sent here for compatibility; the first-class after_completion field wins when both are set. customer_fields lists extra identity fields collected at checkout. Allowed values are address, date_of_birth, email, name, nationality, phone, and place_of_birth. nationality is an ISO 3166-1 country code; checkout may send alpha-2 or alpha-3, and the customer record stores alpha-3.
Optional trial period before the first charge (parseable duration).
type
string
Plan type: OneTime or Recurring. Defaults from interval when omitted.
Response
OK
data
object
Response payload when the request succeeded.
Show child attributes
error
boolean
True when the request failed.
message
string
Human-readable status or error message.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"BoomFi","colors":{"primary":"#242424","light":"#D5FF2F","dark":"#D5FF2F"},"logo":{"light":"https://mintcdn.com/boom-fi/U9Qjv5D7mWH8OHeQ/assets/logo.svg?fit=max\u0026auto=format\u0026n=U9Qjv5D7mWH8OHeQ\u0026q=85\u0026s=9f3a3b3a4a2d198c0c469c900f831e51","dark":"https://mintcdn.com/boom-fi/U9Qjv5D7mWH8OHeQ/assets/logo-dark.svg?fit=max\u0026auto=format\u0026n=U9Qjv5D7mWH8OHeQ\u0026q=85\u0026s=52a0e4a6e798b2441e5e70cb0a0751e0"},"favicon":"https://mintcdn.com/boom-fi/U9Qjv5D7mWH8OHeQ/assets/favicon.png?fit=max\u0026auto=format\u0026n=U9Qjv5D7mWH8OHeQ\u0026q=85\u0026s=59af6f0ccf788b748755b14883512919","api":{"playground":{"display":"interactive"}},"navbar":{"primary":{"type":"button","label":"Dashboard","href":"https://app.boomfi.xyz/login"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"boom-fi","hasAudioNarration":false,"actualSubdomain":"boom-fi","customDomains":["docs.boomfi.xyz"],"gitSource":{"type":"github","owner":"boomfi","repo":"docs","deployBranch":"deploy","contentDirectory":"dist/boomfi","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6afad18614079de35bcc8304","clientVersion":"0.0.4160","searchFilterCounts":[{"language":"default","tag":"API reference","count":75},{"language":"default","tag":"Documentation","count":53},{"language":"default","tag":"Payments","count":13},{"language":"default","tag":"Partners","count":10},{"language":"default","tag":"Paylinks","count":8},{"language":"default","tag":"Dashboard","count":7},{"language":"default","tag":"Integrations","count":7},{"language":"default","tag":"Pricing and Policies","count":7},{"language":"default","tag":"Checkout Sessions","count":7},{"language":"default","tag":"Virtual Accounts","count":7}]},"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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"#topbar-cta-button,#topbar-cta-button *{color:#242424!important}html:not(.dark) #sidebar-content li[data-active],html:not(.dark) #mobile-nav-content li[data-active]{background-color:transparent!important}html:not(.dark) #sidebar-content li[data-active] a,html:not(.dark) #mobile-nav-content li[data-active] a{background-color:#d5ff2f!important;color:#242424!important;border-radius:0.75rem}"}],"page":{"pagePath":"api-reference/paylinks/create-paylink","slug":"/api-reference/paylinks/create-paylink","pageMetadata":{"title":"Create Paylink","description":"Create payment link.","deprecated":null,"version":null,"openapi":"/openapi.yaml post /paylinks","href":"/api-reference/paylinks/create-paylink","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: \"Create payment link.\"\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":"Create Paylink","description":"Create payment link.","deprecated":null,"version":null,"openapi":"/openapi.yaml post /paylinks","href":"/api-reference/paylinks/create-paylink","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Create payment link.","requestBody":"d00593db-3ee4-4567-adbd-c0b89d900949","responses":{"200":"c1322870-d31a-4a96-b7b7-4d600f77ae60","400":"24a2313d-7448-45d0-8cd7-39d49d83a273","500":"c5cc2bbe-5833-459f-b3a1-042e75407f3b"},"security":["6f4db4bb-0654-4d70-8e2b-d0bca39a85b9"],"summary":"Create Paylink","tags":["Paylinks"],"method":"post","type":"path","servers":["21c14809-a1b3-4167-828c-ac108bf963ae","d589755c-5661-4f63-9ce2-902f160c59ad"],"path":"/paylinks","baseUrlOptions":["https://mapi.boomfi.xyz/v1","https://mapi-test.boomfi.xyz/v1"],"title":"Create Paylink","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"properties":{"amount":{"description":"Price amount in major units as a decimal string (non-zero).","type":"string","isRequired":true,"uniqueKey":"amount","typeLabel":"string"},"currency":{"description":"Currency code for the price (recognised and enabled).","type":"string","isRequired":true,"uniqueKey":"currency","typeLabel":"string"},"name":{"description":"Display name shown on the payment link (max 100 characters).","maxLength":100,"type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"account_ids":{"description":"Settlement account IDs to accept payment on.","items":{"type":"integer","uniqueKey":"account_ids.items.[INDEX]","typeLabel":"integer"},"type":"array","uniqueKey":"account_ids","typeLabel":"integer[]"},"account_ref":{"description":"Settlement account reference as an alternative to account_ids.","maxLength":100,"type":"string","uniqueKey":"account_ref","typeLabel":"string"},"after_completion":{"type":"object","description":"Checkout behaviour after payment or when the link expires. Known keys: type (hosted or redirect), redirect_url (success), failure_redirect_url (expire or Failed), custom_message. Additional keys are stored and returned. Takes precedence over metadata.after_completion.","properties":{"custom_message":{"description":"Custom message shown on the hosted success receipt after checkout completes.","maxLength":200,"type":"string","uniqueKey":"after_completion.custom_message","typeLabel":"string"},"failure_redirect_url":{"description":"Failure URL. Hosted and lite checkout send the customer here when the payment link is expired or exhausted, or when payment.status is Failed. Optional for both hosted and redirect types. Not used when the payer switches payment method (Canceled). Max 512 characters.","example":"https://merchant.example/checkout/failed","maxLength":512,"type":"string","uniqueKey":"after_completion.failure_redirect_url","typeLabel":"string"},"redirect_url":{"description":"Success URL. When type is redirect, hosted and lite checkout send the customer here after a successful payment (Succeeded). Required when type is redirect. Not used for expired links or Failed payments. Max 512 characters.","example":"https://merchant.example/checkout/success","maxLength":512,"type":"string","uniqueKey":"after_completion.redirect_url","typeLabel":"string"},"type":{"description":"After-completion behaviour: hosted keeps the customer on the in-app receipt; redirect sends them to redirect_url after a successful payment. When omitted, redirect_url implies redirect.","enum":["hosted","redirect"],"example":"redirect","type":"string","uniqueKey":"after_completion.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"after_completion","typeLabel":"object"},"available_quantity":{"description":"Remaining purchasable quantity; set to 1 for single-use links.","minimum":1,"type":"integer","uniqueKey":"available_quantity","typeLabel":"integer"},"description":{"description":"Human-readable description shown at checkout (max 200 characters).","maxLength":200,"type":"string","uniqueKey":"description","typeLabel":"string"},"expires_at":{"description":"When the payment link expires (must be in the future).","type":"string","uniqueKey":"expires_at","typeLabel":"string"},"image_url":{"description":"Optional image URL shown on the payment link.","type":"string","uniqueKey":"image_url","typeLabel":"string"},"interval":{"description":"Billing interval unit for recurring links.","enum":["Unknown","Minute","Hour","Day","Week","Month","Year"],"type":"string","uniqueKey":"interval","typeLabel":"enum\u003cstring>"},"intervalCount":{"description":"Number of interval units between billings. Minimum 1.","minimum":1,"type":"integer","uniqueKey":"intervalCount","typeLabel":"integer"},"metadata":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"metadata.additionalProperties","typeLabel":"any"},"description":"Arbitrary key-value metadata (max 10 entries). after_completion may also be sent here for compatibility; the first-class after_completion field wins when both are set. customer_fields lists extra identity fields collected at checkout. Allowed values are address, date_of_birth, email, name, nationality, phone, and place_of_birth. nationality is an ISO 3166-1 country code; checkout may send alpha-2 or alpha-3, and the customer record stores alpha-3.","type":"object","uniqueKey":"metadata","typeLabel":"object"},"reference":{"description":"Optional merchant-defined reference (max 50 characters).","maxLength":50,"type":"string","uniqueKey":"reference","typeLabel":"string"},"trial_period":{"description":"Optional trial period before the first charge (parseable duration).","type":"string","uniqueKey":"trial_period","typeLabel":"string"},"type":{"description":"Plan type: OneTime or Recurring. Defaults from interval when omitted.","type":"string","uniqueKey":"type","typeLabel":"string"}},"required":["amount","currency","name"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"amount":"\u003cstring>","currency":"\u003cstring>","name":"\u003cstring>","account_ids":[123],"account_ref":"\u003cstring>","after_completion":{"custom_message":"\u003cstring>","failure_redirect_url":"https://merchant.example/checkout/failed","redirect_url":"https://merchant.example/checkout/success","type":"redirect"},"available_quantity":2,"description":"\u003cstring>","expires_at":"\u003cstring>","image_url":"\u003cstring>","intervalCount":2,"metadata":{},"reference":"\u003cstring>","trial_period":"\u003cstring>","type":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Create Payment Link Request","required":true,"exampleType":"generated"},"responses":{"c1322870-d31a-4a96-b7b7-4d600f77ae60":{"description":"OK","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","description":"Response payload when the request succeeded.","properties":{"after_completion":{"type":"object","description":"Checkout behaviour after payment or when the link expires. Mirrors metadata.after_completion.","properties":{"custom_message":{"description":"Custom message shown on the hosted success receipt after checkout completes.","maxLength":200,"type":"string","uniqueKey":"data.after_completion.custom_message","typeLabel":"string"},"failure_redirect_url":{"description":"Failure URL. Hosted and lite checkout send the customer here when the payment link is expired or exhausted, or when payment.status is Failed. Optional for both hosted and redirect types. Not used when the payer switches payment method (Canceled). Max 512 characters.","example":"https://merchant.example/checkout/failed","maxLength":512,"type":"string","uniqueKey":"data.after_completion.failure_redirect_url","typeLabel":"string"},"redirect_url":{"description":"Success URL. When type is redirect, hosted and lite checkout send the customer here after a successful payment (Succeeded). Required when type is redirect. Not used for expired links or Failed payments. Max 512 characters.","example":"https://merchant.example/checkout/success","maxLength":512,"type":"string","uniqueKey":"data.after_completion.redirect_url","typeLabel":"string"},"type":{"description":"After-completion behaviour: hosted keeps the customer on the in-app receipt; redirect sends them to redirect_url after a successful payment. When omitted, redirect_url implies redirect.","enum":["hosted","redirect"],"example":"redirect","type":"string","uniqueKey":"data.after_completion.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.after_completion","typeLabel":"object"},"created_at":{"description":"created_at","type":"string","uniqueKey":"data.created_at","typeLabel":"string"},"created_by":{"description":"created_by","type":"string","uniqueKey":"data.created_by","typeLabel":"string"},"customer_ident_collection":{"description":"customer_ident_collection","type":"boolean","uniqueKey":"data.customer_ident_collection","typeLabel":"boolean"},"deleted_at":{"description":"deleted_at","type":"string","uniqueKey":"data.deleted_at","typeLabel":"string"},"enabled":{"description":"enabled","type":"boolean","uniqueKey":"data.enabled","typeLabel":"boolean"},"id":{"description":"id","type":"string","uniqueKey":"data.id","typeLabel":"string"},"invoice_id":{"description":"invoice_id","type":"string","uniqueKey":"data.invoice_id","typeLabel":"string"},"metadata":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"data.metadata.additionalProperties","typeLabel":"any"},"description":"Arbitrary merchant-defined metadata. Also includes after_completion when configured, and customer_fields when extra identity fields are collected at checkout.","type":"object","uniqueKey":"data.metadata","typeLabel":"object"},"plan":{"type":"object","description":"Plan associated with this resource.","properties":{"available_quantity":{"description":"Remaining purchasable quantity when the plan has a capped supply; omitted when unlimited.","type":"integer","uniqueKey":"data.plan.available_quantity","typeLabel":"integer"},"billing_scheme":{"type":"string","description":"billing_scheme","enum":["FlatFee","PerUnit","Graduated","Volume"],"x-enum-varnames":["BillingSchemeFlatFee","BillingSchemePerUnit","BillingSchemeGraduated","BillingSchemeVolume"],"uniqueKey":"data.plan.billing_scheme","typeLabel":"enum\u003cstring>"},"created_at":{"description":"created_at","type":"string","uniqueKey":"data.plan.created_at","typeLabel":"string"},"created_by":{"description":"created_by","type":"string","uniqueKey":"data.plan.created_by","typeLabel":"string"},"currency":{"description":"currency","type":"string","uniqueKey":"data.plan.currency","typeLabel":"string"},"deleted_at":{"description":"deleted_at","type":"string","uniqueKey":"data.plan.deleted_at","typeLabel":"string"},"enabled":{"description":"enabled","type":"boolean","uniqueKey":"data.plan.enabled","typeLabel":"boolean"},"expires_at":{"description":"expires_at","type":"string","uniqueKey":"data.plan.expires_at","typeLabel":"string"},"id":{"description":"id","type":"string","uniqueKey":"data.plan.id","typeLabel":"string"},"metadata":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"data.plan.metadata.additionalProperties","typeLabel":"any"},"description":"Arbitrary key-value metadata attached to the plan.","type":"object","uniqueKey":"data.plan.metadata","typeLabel":"object"},"name":{"description":"name","type":"string","uniqueKey":"data.plan.name","typeLabel":"string"},"org_id":{"description":"org_id","type":"string","uniqueKey":"data.plan.org_id","typeLabel":"string"},"payment_link":{"type":"object","description":"Checkout payment link associated with this plan, when one exists.","properties":{"after_completion":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"data.plan.payment_link.after_completion.additionalProperties","typeLabel":"any"},"description":"Checkout behaviour after payment or when the link expires. Mirrors metadata.after_completion.","type":"object","uniqueKey":"data.plan.payment_link.after_completion","typeLabel":"object"},"created_at":{"description":"created_at","type":"string","uniqueKey":"data.plan.payment_link.created_at","typeLabel":"string"},"created_by":{"description":"created_by","type":"string","uniqueKey":"data.plan.payment_link.created_by","typeLabel":"string"},"customer_ident_collection":{"description":"customer_ident_collection","type":"boolean","uniqueKey":"data.plan.payment_link.customer_ident_collection","typeLabel":"boolean"},"deleted_at":{"description":"deleted_at","type":"string","uniqueKey":"data.plan.payment_link.deleted_at","typeLabel":"string"},"enabled":{"description":"enabled","type":"boolean","uniqueKey":"data.plan.payment_link.enabled","typeLabel":"boolean"},"id":{"description":"id","type":"string","uniqueKey":"data.plan.payment_link.id","typeLabel":"string"},"invoice_id":{"description":"invoice_id","type":"string","uniqueKey":"data.plan.payment_link.invoice_id","typeLabel":"string"},"metadata":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"data.plan.payment_link.metadata.additionalProperties","typeLabel":"any"},"description":"Arbitrary key-value metadata attached to the payment link.","type":"object","uniqueKey":"data.plan.payment_link.metadata","typeLabel":"object"},"plan_id":{"description":"plan_id","type":"string","uniqueKey":"data.plan.payment_link.plan_id","typeLabel":"string"},"properties":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"data.plan.payment_link.properties.additionalProperties","typeLabel":"any"},"description":"Internal payment link properties.","type":"object","uniqueKey":"data.plan.payment_link.properties","typeLabel":"object"},"shipping_address_collection":{"description":"shipping_address_collection","type":"boolean","uniqueKey":"data.plan.payment_link.shipping_address_collection","typeLabel":"boolean"},"source":{"type":"string","description":"source","enum":["Lago","BoomFi","Stripe","Chargebee","QuickBooks"],"x-enum-varnames":["BillingSourceLago","BillingSourceBoomFi","BillingSourceStripe","BillingSourceChargebee","BillingSourceQuickBooks"],"uniqueKey":"data.plan.payment_link.source","typeLabel":"enum\u003cstring>"},"tax_ident_collection":{"description":"tax_ident_collection","type":"boolean","uniqueKey":"data.plan.payment_link.tax_ident_collection","typeLabel":"boolean"},"updated_at":{"description":"updated_at","type":"string","uniqueKey":"data.plan.payment_link.updated_at","typeLabel":"string"},"updated_by":{"description":"updated_by","type":"string","uniqueKey":"data.plan.payment_link.updated_by","typeLabel":"string"}},"uniqueKey":"data.plan.payment_link","typeLabel":"object"},"price":{"description":"price","type":"string","uniqueKey":"data.plan.price","typeLabel":"string"},"properties":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"data.plan.properties.additionalProperties","typeLabel":"any"},"description":"Internal plan properties (feature flags and display settings).","type":"object","uniqueKey":"data.plan.properties","typeLabel":"object"},"recurring_interval":{"type":"string","description":"recurring_interval","enum":["Unknown","Minute","Hour","Day","Week","Month","Year"],"x-enum-varnames":["RecurringIntervalUnknown","RecurringIntervalMinute","RecurringIntervalHour","RecurringIntervalDay","RecurringIntervalWeek","RecurringIntervalMonth","RecurringIntervalYear"],"uniqueKey":"data.plan.recurring_interval","typeLabel":"enum\u003cstring>"},"recurring_interval_count":{"description":"recurring_interval_count","type":"integer","uniqueKey":"data.plan.recurring_interval_count","typeLabel":"integer"},"recurring_usage_type":{"type":"string","description":"recurring_usage_type","enum":["Unknown","Licensed","Metered"],"x-enum-varnames":["RecurringUsageTypeUnknown","RecurringUsageTypeLicensed","RecurringUsageTypeMetered"],"uniqueKey":"data.plan.recurring_usage_type","typeLabel":"enum\u003cstring>"},"reference":{"description":"reference","type":"string","uniqueKey":"data.plan.reference","typeLabel":"string"},"source":{"type":"string","description":"source","enum":["Lago","BoomFi","Stripe","Chargebee","QuickBooks"],"x-enum-varnames":["BillingSourceLago","BillingSourceBoomFi","BillingSourceStripe","BillingSourceChargebee","BillingSourceQuickBooks"],"uniqueKey":"data.plan.source","typeLabel":"enum\u003cstring>"},"trial_period":{"description":"trial_period","type":"string","uniqueKey":"data.plan.trial_period","typeLabel":"string"},"type":{"type":"string","description":"type","enum":["Unknown","OneTime","Recurring"],"x-enum-varnames":["PlanTypeUnknown","PlanTypeOneTime","PlanTypeRecurring"],"uniqueKey":"data.plan.type","typeLabel":"enum\u003cstring>"},"updated_at":{"description":"updated_at","type":"string","uniqueKey":"data.plan.updated_at","typeLabel":"string"}},"uniqueKey":"data.plan","typeLabel":"object"},"plan_id":{"description":"plan_id","type":"string","uniqueKey":"data.plan_id","typeLabel":"string"},"properties":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"data.properties.additionalProperties","typeLabel":"any"},"description":"Additional properties as a key-value map.","type":"object","uniqueKey":"data.properties","typeLabel":"object"},"shipping_address_collection":{"description":"shipping_address_collection","type":"boolean","uniqueKey":"data.shipping_address_collection","typeLabel":"boolean"},"source":{"type":"string","description":"source","enum":["Lago","BoomFi","Stripe","Chargebee","QuickBooks"],"x-enum-varnames":["BillingSourceLago","BillingSourceBoomFi","BillingSourceStripe","BillingSourceChargebee","BillingSourceQuickBooks"],"uniqueKey":"data.source","typeLabel":"enum\u003cstring>"},"tax_ident_collection":{"description":"tax_ident_collection","type":"boolean","uniqueKey":"data.tax_ident_collection","typeLabel":"boolean"},"updated_at":{"description":"updated_at","type":"string","uniqueKey":"data.updated_at","typeLabel":"string"},"updated_by":{"description":"updated_by","type":"string","uniqueKey":"data.updated_by","typeLabel":"string"},"url":{"description":"Hosted checkout URL for this payment link.","type":"string","uniqueKey":"data.url","typeLabel":"string"}},"uniqueKey":"data","typeLabel":"object"},"error":{"description":"True when the request failed.","type":"boolean","uniqueKey":"error","typeLabel":"boolean"},"message":{"description":"Human-readable status or error message.","type":"string","uniqueKey":"message","typeLabel":"string"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"after_completion":{"custom_message":"\u003cstring>","failure_redirect_url":"https://merchant.example/checkout/failed","redirect_url":"https://merchant.example/checkout/success","type":"redirect"},"created_at":"\u003cstring>","created_by":"\u003cstring>","customer_ident_collection":true,"deleted_at":"\u003cstring>","enabled":true,"id":"\u003cstring>","invoice_id":"\u003cstring>","metadata":{},"plan":{"available_quantity":123,"billing_scheme":"FlatFee","created_at":"\u003cstring>","created_by":"\u003cstring>","currency":"\u003cstring>","deleted_at":"\u003cstring>","enabled":true,"expires_at":"\u003cstring>","id":"\u003cstring>","metadata":{},"name":"\u003cstring>","org_id":"\u003cstring>","payment_link":{"after_completion":{},"created_at":"\u003cstring>","created_by":"\u003cstring>","customer_ident_collection":true,"deleted_at":"\u003cstring>","enabled":true,"id":"\u003cstring>","invoice_id":"\u003cstring>","metadata":{},"plan_id":"\u003cstring>","properties":{},"shipping_address_collection":true,"source":"Lago","tax_ident_collection":true,"updated_at":"\u003cstring>","updated_by":"\u003cstring>"},"price":"\u003cstring>","properties":{},"recurring_interval":"Unknown","recurring_interval_count":123,"recurring_usage_type":"Unknown","reference":"\u003cstring>","source":"Lago","trial_period":"\u003cstring>","type":"Unknown","updated_at":"\u003cstring>"},"plan_id":"\u003cstring>","properties":{},"shipping_address_collection":true,"source":"Lago","tax_ident_collection":true,"updated_at":"\u003cstring>","updated_by":"\u003cstring>","url":"\u003cstring>"},"error":true,"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"24a2313d-7448-45d0-8cd7-39d49d83a273":{"description":"Bad Request","content":{"application/json":{"schema":{"properties":{"error":{"type":"object","description":"Error details including HTTP-style code and message.","properties":{"code":{"description":"Error code\nExample: 400","example":400,"type":"integer","uniqueKey":"error.code","typeLabel":"integer"},"errors":{"description":"List of errors","items":{"properties":{"domain":{"description":"Domain\nExample: orders","example":"orders","type":"string","uniqueKey":"error.errors.items.[INDEX].domain","typeLabel":"string"},"reason":{"description":"Error Reason\nExample: InsufficientQuantity","example":"InsufficientQuantity","type":"string","uniqueKey":"error.errors.items.[INDEX].reason","typeLabel":"string"}},"type":"object","uniqueKey":"error.errors.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"error.errors","typeLabel":"object[]"},"message":{"description":"Error message\nExample: Insufficient quantity","example":"Insufficient quantity","type":"string","uniqueKey":"error.message","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":400,"errors":[{"domain":"orders","reason":"InsufficientQuantity"}],"message":"Insufficient quantity"}}}},"exampleType":"generated"}},"exampleType":"generated"},"c5cc2bbe-5833-459f-b3a1-042e75407f3b":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"error":{"type":"object","description":"Error details including HTTP-style code and message.","properties":{"code":{"description":"Error code\nExample: 400","example":400,"type":"integer","uniqueKey":"error.code","typeLabel":"integer"},"errors":{"description":"List of errors","items":{"properties":{"domain":{"description":"Domain\nExample: orders","example":"orders","type":"string","uniqueKey":"error.errors.items.[INDEX].domain","typeLabel":"string"},"reason":{"description":"Error Reason\nExample: InsufficientQuantity","example":"InsufficientQuantity","type":"string","uniqueKey":"error.errors.items.[INDEX].reason","typeLabel":"string"}},"type":"object","uniqueKey":"error.errors.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"error.errors","typeLabel":"object[]"},"message":{"description":"Error message\nExample: Insufficient quantity","example":"Insufficient quantity","type":"string","uniqueKey":"error.message","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":400,"errors":[{"domain":"orders","reason":"InsufficientQuantity"}],"message":"Insufficient quantity"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"6f4db4bb-0654-4d70-8e2b-d0bca39a85b9":{"ApiKeyAuth":{"in":"header","name":"X-API-KEY","type":"apiKey","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"21c14809-a1b3-4167-828c-ac108bf963ae":{"url":"https://mapi.boomfi.xyz/v1","description":"Production"},"d589755c-5661-4f63-9ce2-902f160c59ad":{"url":"https://mapi-test.boomfi.xyz/v1","description":"Test"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"in":"header","name":"X-API-KEY","type":"apiKey","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"X-API-KEY","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"X-API-KEY"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"boom-fi","siteName":"BoomFi","title":"Create Paylink - BoomFi","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-16T09:48:59.512Z","originalFileLocation":"api-reference/paylinks/create-paylink.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=\"Create payment link.\">\u003cmeta data-mint-head name=\"application-name\" content=\"BoomFi\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/boom-fi/waJogTq0mCSqSidV/_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/boom-fi/waJogTq0mCSqSidV/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/boom-fi/waJogTq0mCSqSidV/_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/boom-fi/waJogTq0mCSqSidV/_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/boom-fi/waJogTq0mCSqSidV/_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/boom-fi/waJogTq0mCSqSidV/_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/boom-fi/waJogTq0mCSqSidV/_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/boom-fi/waJogTq0mCSqSidV/_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/boom-fi/waJogTq0mCSqSidV/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Paylink - BoomFi\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create payment link.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"BoomFi\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.boomfi.xyz/api-reference/paylinks/create-paylink\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://boom-fi.mintlify.site/_mintlify/api/og/v2?division=Paylinks\u0026amp;title=Create+Paylink\u0026amp;description=Create+payment+link.\u0026amp;theme=a68feaec111ff9376a17fd13\u0026amp;signature=3198ea97291aa0cfd48dcbd13a56074dead9c6474cf213a8e92a22735a316aae\">\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=\"Create Paylink - BoomFi\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create payment link.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://boom-fi.mintlify.site/_mintlify/api/og/v2?division=Paylinks\u0026amp;title=Create+Paylink\u0026amp;description=Create+payment+link.\u0026amp;theme=a68feaec111ff9376a17fd13\u0026amp;signature=3198ea97291aa0cfd48dcbd13a56074dead9c6474cf213a8e92a22735a316aae\">\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/boom-fi/waJogTq0mCSqSidV/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"BoomFi\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#242424\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.boomfi.xyz/api-reference/paylinks/create-paylink\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/paylinks/create-paylink.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.boomfi.xyz/#organization\",\"name\":\"BoomFi\",\"url\":\"https://docs.boomfi.xyz\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/boom-fi/U9Qjv5D7mWH8OHeQ/assets/logo.svg?fit=max\u0026auto=format\u0026n=U9Qjv5D7mWH8OHeQ\u0026q=85\u0026s=9f3a3b3a4a2d198c0c469c900f831e51\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.boomfi.xyz#website\",\"name\":\"BoomFi\",\"url\":\"https://docs.boomfi.xyz\",\"publisher\":{\"@id\":\"https://docs.boomfi.xyz/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.boomfi.xyz/api-reference/paylinks/create-paylink#webpage\",\"url\":\"https://docs.boomfi.xyz/api-reference/paylinks/create-paylink\",\"name\":\"Create Paylink\",\"description\":\"Create payment link.\",\"dateModified\":\"2026-11-16T09:48:59.512Z\",\"isPartOf\":{\"@id\":\"https://docs.boomfi.xyz#website\"},\"breadcrumb\":{\"@id\":\"https://docs.boomfi.xyz/api-reference/paylinks/create-paylink#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.boomfi.xyz/api-reference/paylinks/create-paylink#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Paylinks\",\"item\":\"https://docs.boomfi.xyz/api-reference/paylinks/list-paylinks\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Paylink\",\"item\":\"https://docs.boomfi.xyz/api-reference/paylinks/create-paylink\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.boomfi.xyz/api-reference/paylinks/create-paylink#apireference\",\"headline\":\"Create Paylink\",\"name\":\"Create Paylink\",\"description\":\"Create payment link.\",\"url\":\"https://docs.boomfi.xyz/api-reference/paylinks/create-paylink\",\"mainEntityOfPage\":{\"@id\":\"https://docs.boomfi.xyz/api-reference/paylinks/create-paylink#webpage\"},\"dateModified\":\"2026-11-16T09:48:59.512Z\",\"publisher\":{\"@id\":\"https://docs.boomfi.xyz/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.boomfi.xyz#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"BoomFi\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"BoomFi\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/paylinks/create-paylink.md","siteName":"BoomFi","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API reference","groups":[{"group":"Basics","pages":[{"title":"API Overview","sidebarTitle":"Overview","href":"/api/overview"},{"title":"Authentication","href":"/api/authentication"},{"title":"Response Patterns","sidebarTitle":"Response patterns","href":"/api/response-patterns"}]},{"group":"Paylinks","pages":[{"title":"List Paylinks","description":"List paylinks with optional reference, search, and status filters","deprecated":null,"version":null,"openapi":"/openapi.yaml get /paylinks","href":"/api-reference/paylinks/list-paylinks"},{"title":"Create Paylink","deprecated":null,"version":null,"openapi":"/openapi.yaml post /paylinks","href":"/api-reference/paylinks/create-paylink"},{"title":"Get Paylink","description":"Retrieve a payment link by paylink ID or plan ID. Includes the hosted checkout URL.","deprecated":null,"version":null,"openapi":"/openapi.yaml get /paylinks/{paylinkId}","href":"/api-reference/paylinks/get-paylink"},{"title":"Update Paylink","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /paylinks/{paylinkId}","href":"/api-reference/paylinks/update-paylink"},{"title":"Delete Paylink","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /paylinks/{paylinkId}","href":"/api-reference/paylinks/delete-paylink"},{"title":"Batch Update Paylinks","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /paylinks/batch","href":"/api-reference/paylinks/batch-update-paylinks"},{"title":"Batch Delete Paylinks","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /paylinks/batch","href":"/api-reference/paylinks/batch-delete-paylinks"},{"title":"Generate Paylink Variant URL","deprecated":null,"version":null,"openapi":"/openapi.yaml get /paylinks/generate-variant/{paylinkId}","href":"/api-reference/paylinks/generate-paylink-variant-url"}]},{"group":"Plans","pages":[{"title":"List Plans","deprecated":null,"version":null,"openapi":"/openapi.yaml get /plan","href":"/api-reference/plans/list-plans"},{"title":"Create Plan","deprecated":null,"version":null,"openapi":"/openapi.yaml post /plan","href":"/api-reference/plans/create-plan"},{"title":"Get Plan","deprecated":null,"version":null,"openapi":"/openapi.yaml get /plan/{planId}","href":"/api-reference/plans/get-plan"}]},{"group":"Subscriptions","pages":[{"title":"List Subscriptions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /subscriptions","href":"/api-reference/subscriptions/list-subscriptions"},{"title":"List Subscriptions By Customer","deprecated":null,"version":null,"openapi":"/openapi.yaml get /subscriptions/{customerID}","href":"/api-reference/subscriptions/list-subscriptions-by-customer"},{"title":"Cancel Subscription","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /subscriptions/{subscriptionID}","href":"/api-reference/subscriptions/cancel-subscription"},{"title":"Create Subscription Invoice","deprecated":null,"version":null,"openapi":"/openapi.yaml post /subscriptions/{subscriptionID}/invoices","href":"/api-reference/subscriptions/create-subscription-invoice"}]},{"group":"Customers","pages":[{"title":"List Customers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /customers","href":"/api-reference/customers/list-customers"},{"title":"Create Customer","deprecated":null,"version":null,"openapi":"/openapi.yaml post /customers","href":"/api-reference/customers/create-customer"},{"title":"Get Customer","deprecated":null,"version":null,"openapi":"/openapi.yaml get /customers/{customerID}","href":"/api-reference/customers/get-customer"},{"title":"Update Customer","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /customers/{customerID}","href":"/api-reference/customers/update-customer"},{"title":"Delete Customer","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /customers/{customerID}","href":"/api-reference/customers/delete-customer"}]},{"group":"Invoices","pages":[{"title":"List Invoices","deprecated":null,"version":null,"openapi":"/openapi.yaml get /invoices","href":"/api-reference/invoices/list-invoices"},{"title":"Get Invoice","deprecated":null,"version":null,"openapi":"/openapi.yaml get /invoices/{invoiceId}","href":"/api-reference/invoices/get-invoice"}]},{"group":"Payments","pages":[{"title":"List Payments","deprecated":null,"version":null,"openapi":"/openapi.yaml get /payments","href":"/api-reference/payments/list-payments"},{"title":"Get Payment","deprecated":null,"version":null,"openapi":"/openapi.yaml get /payments/{paymentId}","href":"/api-reference/payments/get-payment"},{"title":"Cancel Payment","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /payments/{paymentId}","href":"/api-reference/payments/cancel-payment"}]},{"group":"Networks","pages":[{"title":"List Chains","deprecated":null,"version":null,"openapi":"/openapi.yaml get /chain/list","href":"/api-reference/networks/list-chains"},{"title":"List Currencies","deprecated":null,"version":null,"openapi":"/openapi.yaml get /currency/list","href":"/api-reference/networks/list-currencies"},{"title":"List Tokens","deprecated":null,"version":null,"openapi":"/openapi.yaml get /currency/list/tokens","href":"/api-reference/networks/list-tokens"}]},{"group":"Events","pages":[{"title":"List Events","deprecated":null,"version":null,"openapi":"/openapi.yaml get /events","href":"/api-reference/events/list-events"}]},{"group":"Organisation","pages":[{"title":"Get Organisation","deprecated":null,"version":null,"openapi":"/openapi.yaml get /orgs","href":"/api-reference/organisation/get-organisation"},{"title":"Update Organisation","deprecated":null,"version":null,"openapi":"/openapi.yaml put /orgs","href":"/api-reference/organisation/update-organisation"},{"title":"Update Display Currency","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orgs/currency/{currency_code}","href":"/api-reference/organisation/update-display-currency"}]},{"group":"Secrets","pages":[{"title":"Get Signing Secret","deprecated":null,"version":null,"openapi":"/openapi.yaml get /orgs/signing-secret","href":"/api-reference/secrets/get-signing-secret"},{"title":"Rotate Signing Secret","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /orgs/signing-secret","href":"/api-reference/secrets/rotate-signing-secret"},{"title":"Rotate Webhook Secret","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /orgs/webhook-secret","href":"/api-reference/secrets/rotate-webhook-secret"}]},{"group":"Accounts","pages":[{"title":"List Accounts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /accounts","href":"/api-reference/accounts/list-accounts"},{"title":"Create Account","deprecated":true,"version":null,"openapi":"/openapi.yaml post /accounts","href":"/api-reference/accounts/create-account"},{"title":"Get Account","deprecated":null,"version":null,"openapi":"/openapi.yaml get /accounts/{accountId}","href":"/api-reference/accounts/get-account"},{"title":"Update Account","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /accounts/{accountId}","href":"/api-reference/accounts/update-account"},{"title":"Delete Account","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /accounts/{accountId}","href":"/api-reference/accounts/delete-account"},{"title":"List Account Movements","deprecated":null,"version":null,"openapi":"/openapi.yaml get /accounts/{accountId}/movement","href":"/api-reference/accounts/list-account-movements"}]},{"group":"External Accounts","pages":[{"title":"List External Accounts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /accounts/external-account","href":"/api-reference/external-accounts/list-external-accounts"},{"title":"Register External Account","deprecated":null,"version":null,"openapi":"/openapi.yaml post /accounts/external-account","href":"/api-reference/external-accounts/register-external-account"},{"title":"Delete External Account","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /accounts/external-account/{accountId}","href":"/api-reference/external-accounts/delete-external-account"}]},{"group":"Virtual Accounts","pages":[{"title":"Get Virtual Account","deprecated":null,"version":null,"openapi":"/openapi.yaml get /accounts/virtual","href":"/api-reference/virtual-accounts/get-virtual-account"},{"title":"Create Virtual Account","deprecated":null,"version":null,"openapi":"/openapi.yaml post /accounts/virtual","href":"/api-reference/virtual-accounts/create-virtual-account"},{"title":"Update Virtual Account","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /accounts/virtual","href":"/api-reference/virtual-accounts/update-virtual-account"},{"title":"List Virtual Account Balances","deprecated":null,"version":null,"openapi":"/openapi.yaml get /accounts/virtual/balances","href":"/api-reference/virtual-accounts/list-virtual-account-balances"},{"title":"Create Pay-In Deposit Wallet","deprecated":null,"version":null,"openapi":"/openapi.yaml post /accounts/virtual/payin/address","href":"/api-reference/virtual-accounts/create-pay-in-deposit-wallet"},{"title":"Create Virtual Account Payout","deprecated":null,"version":null,"openapi":"/openapi.yaml post /accounts/virtual/payout","href":"/api-reference/virtual-accounts/create-virtual-account-payout"},{"title":"Create Payout","deprecated":null,"version":null,"openapi":"/openapi.yaml post /accounts/virtual/payout/address","href":"/api-reference/virtual-accounts/create-payout"}]},{"group":"Partners","pages":[{"title":"Get Account By Reference","deprecated":null,"version":null,"openapi":"/openapi.yaml get /partners/accounts/{account_ref}","href":"/api-reference/partners/get-account-by-reference"},{"title":"List Account Balances","deprecated":null,"version":null,"openapi":"/openapi.yaml get /partners/accounts/{account_ref}/balances","href":"/api-reference/partners/list-account-balances"},{"title":"List Deposit Account Balances","deprecated":null,"version":null,"openapi":"/openapi.yaml get /partners/accounts/{account_ref}/payin/{dep_account_ref}/balances","href":"/api-reference/partners/list-deposit-account-balances"},{"title":"Create Pay-In Deposit Wallet","deprecated":null,"version":null,"openapi":"/openapi.yaml post /partners/accounts/{account_ref}/payin/address","href":"/api-reference/partners/create-pay-in-deposit-wallet"},{"title":"Create Payout","deprecated":null,"version":null,"openapi":"/openapi.yaml post /partners/accounts/{account_ref}/payout/address","href":"/api-reference/partners/create-payout"},{"title":"Create Virtual Account","deprecated":null,"version":null,"openapi":"/openapi.yaml post /partners/accounts/create-virtual-account","href":"/api-reference/partners/create-virtual-account"},{"title":"Get Account By ID","deprecated":null,"version":null,"openapi":"/openapi.yaml get /partners/accounts/id/{accountId}","href":"/api-reference/partners/get-account-by-id"},{"title":"Update Virtual Account","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /partners/accounts/update-virtual-account","href":"/api-reference/partners/update-virtual-account"},{"title":"Get Virtual Account","deprecated":null,"version":null,"openapi":"/openapi.yaml get /partners/accounts/virtual-account","href":"/api-reference/partners/get-virtual-account"},{"title":"Update Sub-Merchant Fees","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /partners/orgs/{orgId}/fees","href":"/api-reference/partners/update-sub-merchant-fees"}]},{"group":"Partner Balance Monitoring","pages":[{"title":"List Balance Monitoring","deprecated":null,"version":null,"openapi":"/openapi.yaml get /partners/accounts/id/{accountId}/automations/maintain-balance","href":"/api-reference/partner-balance-monitoring/list-balance-monitoring"},{"title":"Create Balance Monitoring","deprecated":null,"version":null,"openapi":"/openapi.yaml post /partners/accounts/id/{accountId}/automations/maintain-balance","href":"/api-reference/partner-balance-monitoring/create-balance-monitoring"},{"title":"Update Balance Monitoring","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /partners/accounts/id/{accountId}/automations/maintain-balance","href":"/api-reference/partner-balance-monitoring/update-balance-monitoring"},{"title":"Delete Balance Monitoring","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /partners/accounts/id/{accountId}/automations/maintain-balance/{currency}","href":"/api-reference/partner-balance-monitoring/delete-balance-monitoring"}]},{"group":"Checkout Sessions","pages":[{"title":"List checkout origins","deprecated":null,"version":null,"openapi":"/openapi.yaml get /checkout/origins","href":"/api-reference/checkout-sessions/list-checkout-origins"},{"title":"Register checkout origin","deprecated":null,"version":null,"openapi":"/openapi.yaml post /checkout/origins","href":"/api-reference/checkout-sessions/register-checkout-origin"},{"title":"Disable checkout origin","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /checkout/origins/{originId}","href":"/api-reference/checkout-sessions/disable-checkout-origin"},{"title":"List checkout sessions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /checkout/sessions","href":"/api-reference/checkout-sessions/list-checkout-sessions"},{"title":"Create checkout session","deprecated":null,"version":null,"openapi":"/openapi.yaml post /checkout/sessions","href":"/api-reference/checkout-sessions/create-checkout-session"},{"title":"Get checkout session","deprecated":null,"version":null,"openapi":"/openapi.yaml get /checkout/sessions/{sessionId}","href":"/api-reference/checkout-sessions/get-checkout-session"},{"title":"Expire checkout session","deprecated":null,"version":null,"openapi":"/openapi.yaml post /checkout/sessions/{sessionId}/expire","href":"/api-reference/checkout-sessions/expire-checkout-session"}]}]}]},"basePath":"","title":"Create Paylink - BoomFi","buildId":"dpl_GRSyrvXT6FFTpZZTGz5iZPp3D2zE","deploymentId":"dpl_GRSyrvXT6FFTpZZTGz5iZPp3D2zE","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BFmjTMeT.js","utils-BWr-sjpP.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-LafIDf0N.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-MJNzuxek.js","snippetPresets-DPZEtUvW.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DQ2UhGIs.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DUUJTUkE.js","shallow-BTf5bw35.js","getApiPlaygroundDisplay-h2POYYOO.js","CodeSnippet-C4qEftRe.js","CodeSnippets-CsSrOqMC.js","Page-CWFqNdGh.js","getPastedJson-DU6W6y78.js","icon-2ZYNQ78y.js","MethodPill-BMXJzYMm.js","DuplicateIcon-DNjdEpYZ.js","createIcon-WdPVhKxl.js","DynamicMarkdown-Z_y464fM.js","SectionHeading-Bcrd8azU.js","axios-vUo_bRtp.js","Markdown-BnvucbFu.js","dist-D7YyC486.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-D1I8TPjt.js"]}