Merchant-provided invoice number shown to customers instead of the system order number when present. Free-form, not unique. Forwarded to the payment order on charge.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Cheqpay","colors":{"primary":"#16A34A","light":"#07C983","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/cheqpay/WjCfb-k6AR5eUe0H/logo/logo.svg?fit=max\u0026auto=format\u0026n=WjCfb-k6AR5eUe0H\u0026q=85\u0026s=6e22e4768984a8158b3094e120aaf1ff","dark":"https://mintcdn.com/cheqpay/WjCfb-k6AR5eUe0H/logo/logo.svg?fit=max\u0026auto=format\u0026n=WjCfb-k6AR5eUe0H\u0026q=85\u0026s=6e22e4768984a8158b3094e120aaf1ff","href":"https://www.cheqpay.mx/"},"favicon":"https://mintlify.s3.us-west-1.amazonaws.com/cheqpay/logo/logo.avif","navbar":{},"footer":{"socials":{"x":"https://x.com/cheqpay","github":"https://github.com/cheqpay","linkedin":"https://linkedin.com/company/cheqpay"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"cheqpay","hasAudioNarration":false,"actualSubdomain":"cheqpay","customDomains":["docs.cheqpay.mx"],"gitSource":{"type":"github","owner":"cheqpay","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6aac66185343956ba6628a63","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"default","tag":"Payment Orchestrator API","count":37},{"language":"default","tag":"Features","count":14},{"language":"default","tag":"Link Product API","count":13},{"language":"default","tag":"Payment Order","count":9},{"language":"default","tag":"Products","count":6},{"language":"default","tag":"Subscription","count":6},{"language":"default","tag":"Customer V2","count":5},{"language":"default","tag":"Payment Method","count":5},{"language":"default","tag":"Subscription Plan","count":5},{"language":"default","tag":"Guides","count":4}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"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":"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":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/payment-links/get-payment-link","slug":"/api-reference/payment-links/get-payment-link","pageMetadata":{"title":"Get payment link","description":"Retrieve a payment link by ID","deprecated":null,"version":null,"openapi":"/api-reference/link-product-openapi.json get /payment-links/{id}","href":"/api-reference/payment-links/get-payment-link","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: \"Retrieve a payment link by ID\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get payment link","description":"Retrieve a payment link by ID","deprecated":null,"version":null,"openapi":"/api-reference/link-product-openapi.json get /payment-links/{id}","href":"/api-reference/payment-links/get-payment-link","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/cheqpay/bdac4afbee45d6cc/scripts/sync-openapi.js"],"openApiReferenceData":{"operation":{"tags":["Payment Links"],"summary":"Get payment link","description":"Retrieve a payment link by ID","parameters":["8053dae1-1614-466a-b51d-fc27d6f980e3"],"responses":{"200":"6651f194-719c-40aa-b0d4-d69ba9e81ed4","404":"cb658f33-6065-4698-9d36-7426dd71db93","500":"5e8d147b-e759-4a10-992d-b21e2d459565"},"method":"get","type":"path","servers":["ee30a8d1-4607-4822-8023-57c60b4cd7d6","9e31f532-8a84-4880-a741-97cd3481ff79"],"security":[],"path":"/payment-links/{id}","baseUrlOptions":["https://api.sandbox.cheqpay.mx/lps","https://prod.cheqpay.mx/lps"],"title":"Get payment link","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"8053dae1-1614-466a-b51d-fc27d6f980e3":{"name":"id","in":"path","required":true,"schema":{"type":"string","isRequired":true,"description":"Payment link ID","uniqueKey":"","typeLabel":"string"},"description":"Payment link ID"}},"responses":{"6651f194-719c-40aa-b0d4-d69ba9e81ed4":{"description":"Payment link retrieved successfully","content":{"application/json":{"schema":{"type":"object","description":"Payment link entity","required":["id","merchantId","type","currency","totals","paymentMethods","isDraft","isEnabled"],"properties":{"id":{"type":"string","description":"Unique payment link identifier","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"merchantId":{"type":"string","description":"Merchant identifier","isRequired":true,"uniqueKey":"merchantId","typeLabel":"string"},"type":{"type":"string","enum":["products_subscriptions","customer_choice","products","subscription"],"description":"Payment link type","isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"currency":{"type":"string","pattern":"^[A-Z]{3}$","description":"Currency code (3 letters)","isRequired":true,"uniqueKey":"currency","typeLabel":"string"},"totals":{"type":"object","description":"Payment link totals","required":["total"],"properties":{"total":{"type":"number","minimum":0,"description":"Total amount","isRequired":true,"uniqueKey":"totals.total","typeLabel":"number"},"taxes":{"type":"number","minimum":0,"description":"Tax amount","uniqueKey":"totals.taxes","typeLabel":"number"},"shipping":{"type":"number","minimum":0,"description":"Shipping amount","uniqueKey":"totals.shipping","typeLabel":"number"},"fees":{"type":"number","minimum":0,"description":"Fees amount","uniqueKey":"totals.fees","typeLabel":"number"},"discounts":{"type":"number","minimum":0,"description":"Discount amount","uniqueKey":"totals.discounts","typeLabel":"number"}},"isRequired":true,"uniqueKey":"totals","typeLabel":"object"},"paymentMethods":{"type":"array","items":{"type":"string","enum":["card","spei","cie_cash_net","paycash"],"uniqueKey":"paymentMethods.items.[INDEX]","typeLabel":"enum\u003cstring>"},"minItems":1,"description":"Available payment methods","isRequired":true,"uniqueKey":"paymentMethods","typeLabel":"enum\u003cstring>[]"},"isDraft":{"type":"boolean","description":"Whether the payment link is a draft","isRequired":true,"uniqueKey":"isDraft","typeLabel":"boolean"},"isEnabled":{"type":"boolean","description":"Whether the payment link is enabled","isRequired":true,"uniqueKey":"isEnabled","typeLabel":"boolean"},"_id":{"type":"string","description":"MongoDB ObjectId","uniqueKey":"_id","typeLabel":"string"},"name":{"type":"string","maxLength":255,"description":"Payment link name","uniqueKey":"name","typeLabel":"string"},"url":{"type":"string","description":"Payment link URL","uniqueKey":"url","typeLabel":"string"},"products":{"type":"array","items":{"type":"object","description":"Product in a payment link","required":["name","qty","price","total"],"properties":{"name":{"type":"string","description":"Product name","isRequired":true,"uniqueKey":"products.items.[INDEX].name","typeLabel":"string"},"qty":{"type":"number","minimum":1,"description":"Product quantity","isRequired":true,"uniqueKey":"products.items.[INDEX].qty","typeLabel":"number"},"price":{"type":"number","minimum":0,"description":"Product price","isRequired":true,"uniqueKey":"products.items.[INDEX].price","typeLabel":"number"},"total":{"type":"number","minimum":0,"description":"Total price for this product","isRequired":true,"uniqueKey":"products.items.[INDEX].total","typeLabel":"number"},"id":{"type":"string","description":"Product identifier (optional for new products)","uniqueKey":"products.items.[INDEX].id","typeLabel":"string"},"description":{"type":"string","description":"Product description","uniqueKey":"products.items.[INDEX].description","typeLabel":"string"},"imageUrl":{"type":"string","description":"Product image URL","uniqueKey":"products.items.[INDEX].imageUrl","typeLabel":"string"},"isQtyAdjustable":{"type":"boolean","description":"Whether the quantity is adjustable by the customer","uniqueKey":"products.items.[INDEX].isQtyAdjustable","typeLabel":"boolean"},"minQty":{"type":"number","description":"Minimum quantity if adjustable","uniqueKey":"products.items.[INDEX].minQty","typeLabel":"number"},"maxQty":{"type":"number","description":"Maximum quantity if adjustable","uniqueKey":"products.items.[INDEX].maxQty","typeLabel":"number"}},"uniqueKey":"products.items.[INDEX]","typeLabel":"object"},"description":"Products in the payment link","uniqueKey":"products","typeLabel":"object[]"},"plans":{"type":"array","maxItems":1,"items":{"type":"object","description":"Full subscription plan details","properties":{"id":{"type":"string","description":"Plan identifier","uniqueKey":"plans.items.[INDEX].id","typeLabel":"string"},"merchantId":{"type":"string","description":"Merchant identifier","uniqueKey":"plans.items.[INDEX].merchantId","typeLabel":"string"},"externalId":{"type":"string","description":"External identifier","uniqueKey":"plans.items.[INDEX].externalId","typeLabel":"string"},"name":{"type":"string","description":"Plan name","uniqueKey":"plans.items.[INDEX].name","typeLabel":"string"},"description":{"type":"string","description":"Plan description","uniqueKey":"plans.items.[INDEX].description","typeLabel":"string"},"amount":{"type":"number","description":"Plan amount","uniqueKey":"plans.items.[INDEX].amount","typeLabel":"number"},"currency":{"type":"string","enum":["MXN","USD"],"description":"Plan currency","uniqueKey":"plans.items.[INDEX].currency","typeLabel":"enum\u003cstring>"},"interval":{"type":"string","enum":["DAY","WEEK","MONTH","YEAR"],"description":"Billing interval","uniqueKey":"plans.items.[INDEX].interval","typeLabel":"enum\u003cstring>"},"intervalCount":{"type":"number","description":"Number of intervals between billings","uniqueKey":"plans.items.[INDEX].intervalCount","typeLabel":"number"},"trialDays":{"type":"number","description":"Number of trial days","uniqueKey":"plans.items.[INDEX].trialDays","typeLabel":"number"},"active":{"type":"boolean","description":"Whether the plan is active","uniqueKey":"plans.items.[INDEX].active","typeLabel":"boolean"},"metadata":{"type":"object","description":"Additional metadata","uniqueKey":"plans.items.[INDEX].metadata","typeLabel":"object"},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp","uniqueKey":"plans.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"Last update timestamp","uniqueKey":"plans.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"plans.items.[INDEX]","typeLabel":"object"},"description":"Subscription plans (required when type is subscription, max 1)","uniqueKey":"plans","typeLabel":"object[]"},"options":{"type":"object","description":"Payment link options","properties":{"collectShippingAddress":{"type":"boolean","default":false,"description":"Whether to collect shipping address","uniqueKey":"options.collectShippingAddress","typeLabel":"boolean"},"taxIdCollection":{"type":"object","description":"Tax ID collection settings for checkout","properties":{"enabled":{"type":"boolean","description":"Whether checkout should ask for tax ID","isRequired":true,"uniqueKey":"options.taxIdCollection.enabled","typeLabel":"boolean"},"required":{"type":"boolean","default":false,"description":"When enabled is true, whether tax ID is mandatory","uniqueKey":"options.taxIdCollection.required","typeLabel":"boolean"}},"required":["enabled"],"uniqueKey":"options.taxIdCollection","typeLabel":"object"}},"uniqueKey":"options","typeLabel":"object"},"customFields":{"type":"array","items":{"type":"object","description":"Custom field asked of the customer at checkout. `options` is required when `type` is `radio`, `checkbox`, or `select`, and must be omitted for all other types.","required":["type","label"],"properties":{"type":{"type":"string","enum":["text","number","email","phone","date","switch","radio","checkbox","select"],"description":"Field input type","isRequired":true,"uniqueKey":"customFields.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"label":{"type":"string","minLength":1,"maxLength":255,"description":"Label shown to the customer","isRequired":true,"uniqueKey":"customFields.items.[INDEX].label","typeLabel":"string"},"required":{"type":"boolean","default":false,"description":"Whether the customer must provide a value","uniqueKey":"customFields.items.[INDEX].required","typeLabel":"boolean"},"options":{"type":"array","items":{"type":"string","minLength":1,"maxLength":255,"uniqueKey":"customFields.items.[INDEX].options.items.[INDEX]","typeLabel":"string"},"minItems":1,"maxItems":50,"description":"Available choices; required for `radio`, `checkbox`, and `select`","uniqueKey":"customFields.items.[INDEX].options","typeLabel":"string[]"}},"uniqueKey":"customFields.items.[INDEX]","typeLabel":"object"},"minItems":1,"maxItems":20,"description":"Additional questions to ask the customer at checkout","uniqueKey":"customFields","typeLabel":"object[]"},"numberOfPayments":{"type":"number","minimum":1,"description":"Number of payments for subscription","uniqueKey":"numberOfPayments","typeLabel":"number"},"redirectUrl":{"type":"string","description":"URL to redirect after payment completion","uniqueKey":"redirectUrl","typeLabel":"string"},"cancelUrl":{"oneOf":[{"type":"string","format":"uri","description":"URL the customer returns to when cancelling the checkout","uniqueKey":"cancelUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"URL the customer returns to when cancelling the checkout","uniqueKey":"cancelUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"cancelUrl","typeLabel":"string\u003curi> | null"},"reference":{"type":"string","maxLength":128,"description":"Merchant reference for the payment link","uniqueKey":"reference","typeLabel":"string"},"invoiceNumber":{"type":"string","maxLength":64,"description":"Merchant-provided invoice number shown to customers instead of the system order number when present. Free-form, not unique. Forwarded to the payment order on charge.","uniqueKey":"invoiceNumber","typeLabel":"string"},"description":{"type":"string","maxLength":500,"description":"Payment link description. Forwarded to the payment order on charge unless overridden in the charge request.","uniqueKey":"description","typeLabel":"string"},"externalId":{"type":"string","maxLength":128,"description":"External identifier for idempotent payment link creation","uniqueKey":"externalId","typeLabel":"string"},"defaults":{"type":"object","description":"Default values for customer choice payment links","properties":{"persistPaymentMethod":{"type":"boolean","description":"Whether to persist the customer's payment method for future purchases","default":false,"uniqueKey":"defaults.persistPaymentMethod","typeLabel":"boolean"},"billingAddress":{"type":"object","description":"Address information","properties":{"firstName":{"type":"string","description":"First name","uniqueKey":"defaults.billingAddress.firstName","typeLabel":"string"},"lastName":{"type":"string","description":"Last name","uniqueKey":"defaults.billingAddress.lastName","typeLabel":"string"},"organizationName":{"type":"string","description":"Organization name","uniqueKey":"defaults.billingAddress.organizationName","typeLabel":"string"},"email":{"type":"string","format":"email","description":"Email address","uniqueKey":"defaults.billingAddress.email","typeLabel":"string\u003cemail>"},"phone":{"type":"string","description":"Phone number","uniqueKey":"defaults.billingAddress.phone","typeLabel":"string"},"addressLine1":{"type":"string","description":"Street address","uniqueKey":"defaults.billingAddress.addressLine1","typeLabel":"string"},"addressLine2":{"type":"string","description":"Additional address information (apartment, suite, unit, etc.)","uniqueKey":"defaults.billingAddress.addressLine2","typeLabel":"string"},"city":{"type":"string","description":"City","uniqueKey":"defaults.billingAddress.city","typeLabel":"string"},"state":{"type":"string","description":"State","uniqueKey":"defaults.billingAddress.state","typeLabel":"string"},"postalCode":{"type":"string","description":"Postal code","uniqueKey":"defaults.billingAddress.postalCode","typeLabel":"string"},"country":{"type":"string","pattern":"^[A-Z]{2}$","description":"Country code (2 letters)","uniqueKey":"defaults.billingAddress.country","typeLabel":"string"},"isSameAsShipping":{"type":"boolean","description":"Whether billing address is same as shipping","uniqueKey":"defaults.billingAddress.isSameAsShipping","typeLabel":"boolean"}},"uniqueKey":"defaults.billingAddress","typeLabel":"object"},"shippingAddress":{"type":"object","description":"Address information","properties":{"firstName":{"type":"string","description":"First name","uniqueKey":"defaults.shippingAddress.firstName","typeLabel":"string"},"lastName":{"type":"string","description":"Last name","uniqueKey":"defaults.shippingAddress.lastName","typeLabel":"string"},"organizationName":{"type":"string","description":"Organization name","uniqueKey":"defaults.shippingAddress.organizationName","typeLabel":"string"},"email":{"type":"string","format":"email","description":"Email address","uniqueKey":"defaults.shippingAddress.email","typeLabel":"string\u003cemail>"},"phone":{"type":"string","description":"Phone number","uniqueKey":"defaults.shippingAddress.phone","typeLabel":"string"},"addressLine1":{"type":"string","description":"Street address","uniqueKey":"defaults.shippingAddress.addressLine1","typeLabel":"string"},"addressLine2":{"type":"string","description":"Additional address information (apartment, suite, unit, etc.)","uniqueKey":"defaults.shippingAddress.addressLine2","typeLabel":"string"},"city":{"type":"string","description":"City","uniqueKey":"defaults.shippingAddress.city","typeLabel":"string"},"state":{"type":"string","description":"State","uniqueKey":"defaults.shippingAddress.state","typeLabel":"string"},"postalCode":{"type":"string","description":"Postal code","uniqueKey":"defaults.shippingAddress.postalCode","typeLabel":"string"},"country":{"type":"string","pattern":"^[A-Z]{2}$","description":"Country code (2 letters)","uniqueKey":"defaults.shippingAddress.country","typeLabel":"string"}},"uniqueKey":"defaults.shippingAddress","typeLabel":"object"}},"uniqueKey":"defaults","typeLabel":"object"},"metadata":{"type":"object","additionalProperties":true,"description":"Additional metadata","uniqueKey":"metadata","typeLabel":"object"},"expiresAt":{"type":"string","format":"date-time","description":"Expiration date","uniqueKey":"expiresAt","typeLabel":"string\u003cdate-time>"},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp","uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"Last update timestamp","uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"invoiceCount":{"type":"integer","description":"Number of invoices generated from this payment link","uniqueKey":"invoiceCount","typeLabel":"integer"},"merchant":{"type":"object","properties":{"name":{"type":"string","description":"Merchant name","uniqueKey":"merchant.name","typeLabel":"string"},"logo":{"type":"string","description":"Merchant logo URL","uniqueKey":"merchant.logo","typeLabel":"string"},"refundPolicyUrl":{"type":"string","description":"Refund policy URL","uniqueKey":"merchant.refundPolicyUrl","typeLabel":"string"},"returnsAndExchangesPolicyUrl":{"type":"string","description":"Returns and exchanges policy URL","uniqueKey":"merchant.returnsAndExchangesPolicyUrl","typeLabel":"string"},"country":{"type":"string","pattern":"^[A-Z]{2}$","description":"Merchant country code (2 letters)","uniqueKey":"merchant.country","typeLabel":"string"},"language":{"type":"string","pattern":"^[a-z]{2}$","default":"en","description":"Merchant language code (2 letters)","uniqueKey":"merchant.language","typeLabel":"string"},"transactionFees":{"type":"object","description":"Customer-facing transaction fee configuration. Defines how fees or discounts are presented to the customer at checkout. The four modes (cashDiscount, convenience, service, surcharge) are mutually exclusive at most one of them can have `active: true` at a time. If none are active, no extra fee is applied (the \"None\" mode).","properties":{"cashDiscount":{"type":"object","description":"Cash discount transaction fee mode. The merchant offers a discount when the customer pays with cash or ACH instead of a card.","properties":{"available":{"type":"boolean","description":"Whether this fee mode is available for the merchant to select.","uniqueKey":"merchant.transactionFees.cashDiscount.available","typeLabel":"boolean"},"active":{"type":"boolean","description":"Whether this fee mode is currently active. At most one transactionFees mode can be active at a time.","uniqueKey":"merchant.transactionFees.cashDiscount.active","typeLabel":"boolean"},"rate":{"type":"string","description":"Cash discount rate as a percentage string with up to 2 decimals (e.g., \"3\", \"3.00\", \"50.00\").","pattern":"^\\d+(\\.\\d{1,2})?$","example":"50.00","uniqueKey":"merchant.transactionFees.cashDiscount.rate","typeLabel":"string"},"displayStyle":{"type":"string","enum":["subtle","sideBySide"],"description":"How the cash discount is presented to the customer. `subtle` shows the standard Cash Discount layout; `sideBySide` shows Dual Pricing (card price and cash price side by side).","uniqueKey":"merchant.transactionFees.cashDiscount.displayStyle","typeLabel":"enum\u003cstring>"},"autoAdjustPrices":{"type":"boolean","description":"When true, the merchant's listed price is treated as the cash price and the card price is computed as `basePrice * (1 + rate)`. When false, the listed price is the card price and the cash price is computed as `basePrice / (1 + rate)`.","uniqueKey":"merchant.transactionFees.cashDiscount.autoAdjustPrices","typeLabel":"boolean"},"cardPriceLabel":{"type":"string","description":"Label shown for the card price at checkout. Defaults to \"Card Price\" at the render layer if not set.","uniqueKey":"merchant.transactionFees.cashDiscount.cardPriceLabel","typeLabel":"string"},"cashPriceLabel":{"type":"string","description":"Label shown for the cash/ACH price at checkout. Defaults to \"Cash/ACH Price\" at the render layer if not set.","uniqueKey":"merchant.transactionFees.cashDiscount.cashPriceLabel","typeLabel":"string"}},"uniqueKey":"merchant.transactionFees.cashDiscount","typeLabel":"object"},"convenience":{"type":"object","description":"Convenience fee transaction mode. A flat fee is added to every transaction.","properties":{"available":{"type":"boolean","description":"Whether this fee mode is available for the merchant to select.","uniqueKey":"merchant.transactionFees.convenience.available","typeLabel":"boolean"},"active":{"type":"boolean","description":"Whether this fee mode is currently active. At most one transactionFees mode can be active at a time.","uniqueKey":"merchant.transactionFees.convenience.active","typeLabel":"boolean"},"amount":{"type":"string","description":"Convenience fee amount as a non-negative integer in cents (e.g., \"500\" for $5.00).","pattern":"^\\d+$","example":"500","uniqueKey":"merchant.transactionFees.convenience.amount","typeLabel":"string"}},"uniqueKey":"merchant.transactionFees.convenience","typeLabel":"object"},"service":{"type":"object","description":"Service fee transaction mode. A percentage-based fee is applied to all transactions.","properties":{"available":{"type":"boolean","description":"Whether this fee mode is available for the merchant to select.","uniqueKey":"merchant.transactionFees.service.available","typeLabel":"boolean"},"active":{"type":"boolean","description":"Whether this fee mode is currently active. At most one transactionFees mode can be active at a time.","uniqueKey":"merchant.transactionFees.service.active","typeLabel":"boolean"},"rate":{"type":"string","description":"Service fee rate as a percentage string with up to 2 decimals (e.g., \"5.00\").","pattern":"^\\d+(\\.\\d{1,2})?$","example":"5.00","uniqueKey":"merchant.transactionFees.service.rate","typeLabel":"string"}},"uniqueKey":"merchant.transactionFees.service","typeLabel":"object"},"surcharge":{"type":"object","description":"Surcharge transaction mode. A percentage-based surcharge is added at checkout as a separate line item when a card is used.","properties":{"available":{"type":"boolean","description":"Whether this fee mode is available for the merchant to select.","uniqueKey":"merchant.transactionFees.surcharge.available","typeLabel":"boolean"},"active":{"type":"boolean","description":"Whether this fee mode is currently active. At most one transactionFees mode can be active at a time.","uniqueKey":"merchant.transactionFees.surcharge.active","typeLabel":"boolean"},"rate":{"type":"string","description":"Surcharge rate as a percentage string with up to 2 decimals (e.g., \"3.00\").","pattern":"^\\d+(\\.\\d{1,2})?$","example":"3.00","uniqueKey":"merchant.transactionFees.surcharge.rate","typeLabel":"string"},"maxAmount":{"type":"string","description":"Optional per-transaction surcharge cap as a non-negative integer in cents (e.g., \"5000\" caps the surcharge at $50.00).","pattern":"^\\d+$","example":"5000","uniqueKey":"merchant.transactionFees.surcharge.maxAmount","typeLabel":"string"},"appliesTo":{"type":"string","enum":["credit_only","credit_and_amex","all"],"description":"Which card types the surcharge applies to. Defaults to `credit_only` to avoid illegally surcharging debit cards under US Durbin rules.","uniqueKey":"merchant.transactionFees.surcharge.appliesTo","typeLabel":"enum\u003cstring>"},"lineItemLabel":{"type":"string","description":"Label used on the receipt for the surcharge line item. Defaults to \"Surcharge\" at the render layer if not set.","uniqueKey":"merchant.transactionFees.surcharge.lineItemLabel","typeLabel":"string"}},"uniqueKey":"merchant.transactionFees.surcharge","typeLabel":"object"}},"uniqueKey":"merchant.transactionFees","typeLabel":"object"}},"uniqueKey":"merchant","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","merchantId":"\u003cstring>","type":"products_subscriptions","currency":"\u003cstring>","totals":{"total":1,"taxes":1,"shipping":1,"fees":1,"discounts":1},"paymentMethods":["card"],"isDraft":true,"isEnabled":true,"_id":"\u003cstring>","name":"\u003cstring>","url":"\u003cstring>","products":[{"name":"\u003cstring>","qty":2,"price":1,"total":1,"id":"\u003cstring>","description":"\u003cstring>","imageUrl":"\u003cstring>","isQtyAdjustable":true,"minQty":123,"maxQty":123}],"plans":[{"id":"\u003cstring>","merchantId":"\u003cstring>","externalId":"\u003cstring>","name":"\u003cstring>","description":"\u003cstring>","amount":123,"currency":"MXN","interval":"DAY","intervalCount":123,"trialDays":123,"active":true,"metadata":{},"createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z"}],"options":{"collectShippingAddress":false,"taxIdCollection":{"enabled":true,"required":false}},"customFields":[{"type":"text","label":"\u003cstring>","required":false,"options":["\u003cstring>"]}],"numberOfPayments":2,"redirectUrl":"\u003cstring>","cancelUrl":"\u003cstring>","reference":"\u003cstring>","invoiceNumber":"\u003cstring>","description":"\u003cstring>","externalId":"\u003cstring>","defaults":{"persistPaymentMethod":false,"billingAddress":{"firstName":"\u003cstring>","lastName":"\u003cstring>","organizationName":"\u003cstring>","email":"jsmith@example.com","phone":"\u003cstring>","addressLine1":"\u003cstring>","addressLine2":"\u003cstring>","city":"\u003cstring>","state":"\u003cstring>","postalCode":"\u003cstring>","country":"\u003cstring>","isSameAsShipping":true},"shippingAddress":{"firstName":"\u003cstring>","lastName":"\u003cstring>","organizationName":"\u003cstring>","email":"jsmith@example.com","phone":"\u003cstring>","addressLine1":"\u003cstring>","addressLine2":"\u003cstring>","city":"\u003cstring>","state":"\u003cstring>","postalCode":"\u003cstring>","country":"\u003cstring>"}},"metadata":{},"expiresAt":"2023-11-07T05:31:56Z","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","invoiceCount":123,"merchant":{"name":"\u003cstring>","logo":"\u003cstring>","refundPolicyUrl":"\u003cstring>","returnsAndExchangesPolicyUrl":"\u003cstring>","country":"\u003cstring>","language":"en","transactionFees":{"cashDiscount":{"available":true,"active":true,"rate":"50.00","displayStyle":"subtle","autoAdjustPrices":true,"cardPriceLabel":"\u003cstring>","cashPriceLabel":"\u003cstring>"},"convenience":{"available":true,"active":true,"amount":"500"},"service":{"available":true,"active":true,"rate":"5.00"},"surcharge":{"available":true,"active":true,"rate":"3.00","maxAmount":"5000","appliesTo":"credit_only","lineItemLabel":"\u003cstring>"}}}}}},"exampleType":"generated"}},"exampleType":"generated"},"cb658f33-6065-4698-9d36-7426dd71db93":{"description":"Payment link not found","content":{"application/json":{"schema":{"type":"object","description":"Not found error response","properties":{"message":{"type":"string","description":"Error message","example":"Resource not found","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Resource not found"}}},"exampleType":"generated"}},"exampleType":"generated"},"5e8d147b-e759-4a10-992d-b21e2d459565":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","description":"Internal server error response","properties":{"message":{"type":"string","description":"Error message","example":"Internal server error","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Internal server error"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"ee30a8d1-4607-4822-8023-57c60b4cd7d6":{"url":"https://api.sandbox.cheqpay.mx/lps","description":"Sandbox environment"},"9e31f532-8a84-4880-a741-97cd3481ff79":{"url":"https://prod.cheqpay.mx/lps","description":"Production environment"}}},"originalFileLocation":"api-reference/link-product-openapi.json"},"subdomain":"cheqpay","siteName":"Cheqpay","title":"Get payment link - Cheqpay","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-27T21:53:20.438Z","originalFileLocation":"api-reference/payment-links/get-payment-link.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=\"Retrieve a payment link by ID\">\u003cmeta data-mint-head name=\"application-name\" content=\"Cheqpay\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/cheqpay/logo/logo.avif\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/cheqpay/logo/logo.avif\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/cheqpay/logo/logo.avif\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/png\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/cheqpay/logo/logo.avif\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get payment link - Cheqpay\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve a payment link by ID\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Cheqpay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.cheqpay.mx/api-reference/payment-links/get-payment-link\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cheqpay.mintlify.site/_mintlify/api/og/v2?division=Payment+Links\u0026amp;title=Get+payment+link\u0026amp;description=Retrieve+a+payment+link+by+ID\u0026amp;theme=6e0753f2de9f986dbda32f79\u0026amp;signature=fa7258c49fdb07cba5b5a8d17565f4ae444acc5e0299ffd7e9a72a84453e70fe\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get payment link - Cheqpay\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve a payment link by ID\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cheqpay.mintlify.site/_mintlify/api/og/v2?division=Payment+Links\u0026amp;title=Get+payment+link\u0026amp;description=Retrieve+a+payment+link+by+ID\u0026amp;theme=6e0753f2de9f986dbda32f79\u0026amp;signature=fa7258c49fdb07cba5b5a8d17565f4ae444acc5e0299ffd7e9a72a84453e70fe\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"https://mintlify.s3.us-west-1.amazonaws.com/cheqpay/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Cheqpay\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#16A34A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.cheqpay.mx/api-reference/payment-links/get-payment-link\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/payment-links/get-payment-link.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.cheqpay.mx/#organization\",\"name\":\"Cheqpay\",\"url\":\"https://docs.cheqpay.mx\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/cheqpay/WjCfb-k6AR5eUe0H/logo/logo.svg?fit=max\u0026auto=format\u0026n=WjCfb-k6AR5eUe0H\u0026q=85\u0026s=6e22e4768984a8158b3094e120aaf1ff\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.cheqpay.mx#website\",\"name\":\"Cheqpay\",\"url\":\"https://docs.cheqpay.mx\",\"publisher\":{\"@id\":\"https://docs.cheqpay.mx/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.cheqpay.mx/api-reference/payment-links/get-payment-link#webpage\",\"url\":\"https://docs.cheqpay.mx/api-reference/payment-links/get-payment-link\",\"name\":\"Get payment link\",\"description\":\"Retrieve a payment link by ID\",\"dateModified\":\"2026-08-27T21:53:20.438Z\",\"isPartOf\":{\"@id\":\"https://docs.cheqpay.mx#website\"},\"breadcrumb\":{\"@id\":\"https://docs.cheqpay.mx/api-reference/payment-links/get-payment-link#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.cheqpay.mx/api-reference/payment-links/get-payment-link#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Link Product API\",\"item\":\"https://docs.cheqpay.mx/api-reference/payment-links/create-payment-link\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Payment Links\",\"item\":\"https://docs.cheqpay.mx/api-reference/payment-links/create-payment-link\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get payment link\",\"item\":\"https://docs.cheqpay.mx/api-reference/payment-links/get-payment-link\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.cheqpay.mx/api-reference/payment-links/get-payment-link#apireference\",\"headline\":\"Get payment link\",\"name\":\"Get payment link\",\"description\":\"Retrieve a payment link by ID\",\"url\":\"https://docs.cheqpay.mx/api-reference/payment-links/get-payment-link\",\"mainEntityOfPage\":{\"@id\":\"https://docs.cheqpay.mx/api-reference/payment-links/get-payment-link#webpage\"},\"dateModified\":\"2026-08-27T21:53:20.438Z\",\"publisher\":{\"@id\":\"https://docs.cheqpay.mx/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.cheqpay.mx#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Cheqpay\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Cheqpay","nav":{"global":{"anchors":[]},"groups":[{"group":"Getting Started","pages":[{"title":"Welcome to Cheqpay","href":"/index"}]},{"group":"Essentials","pages":[{"title":"Authentication","href":"/essentials/authentication"},{"title":"Environments","href":"/essentials/environments"},{"title":"Quickstart","href":"/essentials/quickstart"}]},{"group":"Features","pages":[{"title":"Customers","href":"/features/customers"},{"title":"Payment Methods","href":"/features/payment-methods"},{"title":"Payment Orders","href":"/features/payment-orders"},{"title":"Pending Orders","href":"/features/pending-orders"},{"title":"Card Payments","href":"/features/card-payments"},{"title":"SPEI Transfers","href":"/features/spei-transfers"},{"title":"PayCash Payments","href":"/features/paycash-payments"},{"title":"CIE Cash Net Payments","href":"/features/cie-cash-net-payments"},{"title":"Hosted Payment Page","href":"/features/hosted-payment-page"},{"title":"Integrate via SDK","href":"/features/integrate-via-sdk"},{"title":"3D Secure","href":"/features/3d-secure"},{"title":"Refunds","href":"/features/refunds"},{"title":"Subscriptions","href":"/features/subscriptions"},{"title":"Webhooks","href":"/features/webhooks"}]},{"group":"Testing","pages":[{"title":"Webhook Simulators","href":"/testing/webhook-simulators"}]},{"group":"Guides","pages":[{"title":"Testing Guide","href":"/guides/testing"},{"title":"Error Handling","href":"/guides/error-handling"},{"title":"Best Practices","href":"/guides/best-practices"},{"title":"Going Live","href":"/guides/going-live"}]},{"group":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/introduction"},{"title":"API Endpoints","href":"/api-reference/endpoints"},{"title":"Error Codes","href":"/api-reference/errors"}]},{"group":"Payment Orchestrator API","pages":[{"group":"Customer","pages":[{"title":"Get customer by external ID","deprecated":null,"version":null,"openapi":"/api-reference/orchestrator-openapi.json get /customers/{id}","href":"/api-reference/customer/get-customer-by-external-id"}]},{"group":"Customer V2","pages":[{"title":"List customers with pagination and filtering (v2)","deprecated":null,"version":null,"openapi":"/api-reference/orchestrator-openapi.json get /v2/customers","href":"/api-reference/customer-v2/list-customers-with-pagination-and-filtering-v2"},{"title":"Create a new customer (v2)","deprecated":null,"version":null,"openapi":"/api-reference/orchestrator-openapi.json post /v2/customers","href":"/api-reference/customer-v2/create-a-new-customer-v2"},{"title":"Get customer by ID (v2)","deprecated":null,"version":null,"openapi":"/api-reference/orchestrator-openapi.json get /v2/customers/{id}","href":"/api-reference/customer-v2/get-customer-by-id-v2"},{"title":"Update customer (v2)","deprecated":null,"version":null,"openapi":"/api-reference/orchestrator-openapi.json put /v2/customers/{id}","href":"/api-reference/customer-v2/update-customer-v2"},{"title":"Delete customer (v2)","deprecated":null,"version":null,"openapi":"/api-reference/orchestrator-openapi.json delete /v2/customers/{id}","href":"/api-reference/customer-v2/delete-customer-v2"}]},{"group":"Checkout","pages":[{"title":"Pay with card, spei, or cie cash net","deprecated":null,"version":null,"openapi":"/api-reference/orchestrator-openapi.json post /checkout/pay","href":"/api-reference/checkout/pay-with-card-spei-or-cie-cash-net"},{"title":"Pay with transfer batch","deprecated":null,"version":null,"openapi":"/api-reference/orchestrator-openapi.json post /checkout/pay-batch","href":"/api-reference/checkout/pay-with-transfer-batch"}]},{"group":"Payment Order","pages":[{"title":"List all payment orders","deprecated":null,"version":null,"openapi":"/api-reference/orchestrator-openapi.json get /v2/payment-orders","href":"/api-reference/payment-order/list-all-payment-orders"},{"title":"Create a payment order (v2)","deprecated":null,"version":null,"openapi":"/api-reference/orchestrator-openapi.json post /v2/payment-orders","href":"/api-reference/payment-order/create-a-payment-order-v2"},{"title":"Get payment order by ID or external ID","deprecated":null,"version":null,"openapi":"/api-reference/orchestrator-openapi.json get /v2/payment-orders/{id}","href":"/api-reference/payment-order/get-payment-order-by-id-or-external-id"},{"title":"Soft delete a payment order","deprecated":null,"version":null,"openapi":"/api-reference/orchestrator-openapi.json delete /v2/payment-orders/{id}","href":"/api-reference/payment-order/soft-delete-a-payment-order"},{"title":"Update a pending payment order","deprecated":null,"version":null,"openapi":"/api-reference/orchestrator-openapi.json patch /v2/payment-orders/{id}","href":"/api-reference/payment-order/update-a-pending-payment-order"},{"title":"Charge a pending payment order","deprecated":null,"version":null,"openapi":"/api-reference/orchestrator-openapi.json post /v2/payment-orders/{id}/charge","href":"/api-reference/payment-order/charge-a-pending-payment-order"},{"title":"Refund a Payment of a payment order (v2)","deprecated":null,"version":null,"openapi":"/api-reference/orchestrator-openapi.json post /v2/payment-orders/{id}/refund","href":"/api-reference/payment-order/refund-a-payment-of-a-payment-order-v2"},{"title":"Initiate 3DS payer authentication","deprecated":null,"version":null,"openapi":"/api-reference/orchestrator-openapi.json post /v2/payment-orders/{id}/payer-authentication","href":"/api-reference/payment-order/initiate-3ds-payer-authentication"},{"title":"Validate 3DS payer authentication","deprecated":null,"version":null,"openapi":"/api-reference/orchestrator-openapi.json post /v2/payment-orders/{id}/payer-authentication/validate","href":"/api-reference/payment-order/validate-3ds-payer-authentication"}]},{"group":"Payment Method","pages":[{"title":"Create a payment method","deprecated":null,"version":null,"openapi":"/api-reference/orchestrator-openapi.json post /payment-methods","href":"/api-reference/payment-method/create-a-payment-method"},{"title":"Get a payment method by ID","deprecated":null,"version":null,"openapi":"/api-reference/orchestrator-openapi.json get /payment-methods/{id}","href":"/api-reference/payment-method/get-a-payment-method-by-id"},{"title":"Update a payment method","deprecated":null,"version":null,"openapi":"/api-reference/orchestrator-openapi.json put /payment-methods/{id}","href":"/api-reference/payment-method/update-a-payment-method"},{"title":"Delete a payment method","deprecated":null,"version":null,"openapi":"/api-reference/orchestrator-openapi.json delete /payment-methods/{id}","href":"/api-reference/payment-method/delete-a-payment-method"},{"title":"List payment methods for a customer","deprecated":null,"version":null,"openapi":"/api-reference/orchestrator-openapi.json get /v2/customers/{customerId}/payment-methods","href":"/api-reference/payment-method/list-payment-methods-for-a-customer"}]},{"group":"Subscription Plan","pages":[{"title":"List subscription plans","deprecated":null,"version":null,"openapi":"/api-reference/orchestrator-openapi.json get /v1/plans","href":"/api-reference/subscription-plan/list-subscription-plans"},{"title":"Create a subscription plan","deprecated":null,"version":null,"openapi":"/api-reference/orchestrator-openapi.json post /v1/plans","href":"/api-reference/subscription-plan/create-a-subscription-plan"},{"title":"Get a subscription plan by ID","deprecated":null,"version":null,"openapi":"/api-reference/orchestrator-openapi.json get /v1/plans/{id}","href":"/api-reference/subscription-plan/get-a-subscription-plan-by-id"},{"title":"Archive a subscription plan","deprecated":null,"version":null,"openapi":"/api-reference/orchestrator-openapi.json delete /v1/plans/{id}","href":"/api-reference/subscription-plan/archive-a-subscription-plan"},{"title":"Update a subscription plan","deprecated":null,"version":null,"openapi":"/api-reference/orchestrator-openapi.json patch /v1/plans/{id}","href":"/api-reference/subscription-plan/update-a-subscription-plan"}]},{"group":"Subscription","pages":[{"title":"List subscriptions","deprecated":null,"version":null,"openapi":"/api-reference/orchestrator-openapi.json get /v1/subscriptions","href":"/api-reference/subscription/list-subscriptions"},{"title":"Create a subscription","deprecated":null,"version":null,"openapi":"/api-reference/orchestrator-openapi.json post /v1/subscriptions","href":"/api-reference/subscription/create-a-subscription"},{"title":"Get a subscription by ID","deprecated":null,"version":null,"openapi":"/api-reference/orchestrator-openapi.json get /v1/subscriptions/{id}","href":"/api-reference/subscription/get-a-subscription-by-id"},{"title":"Update a subscription","deprecated":null,"version":null,"openapi":"/api-reference/orchestrator-openapi.json patch /v1/subscriptions/{id}","href":"/api-reference/subscription/update-a-subscription"},{"title":"Change subscription plan","deprecated":null,"version":null,"openapi":"/api-reference/orchestrator-openapi.json patch /v1/subscriptions/{id}/plan","href":"/api-reference/subscription/change-subscription-plan"},{"title":"Cancel a subscription","deprecated":null,"version":null,"openapi":"/api-reference/orchestrator-openapi.json post /v1/subscriptions/{id}/cancel","href":"/api-reference/subscription/cancel-a-subscription"}]},{"group":"Subscription Invoice","pages":[{"title":"List invoices for a subscription","deprecated":null,"version":null,"openapi":"/api-reference/orchestrator-openapi.json get /v1/subscriptions/{id}/invoices","href":"/api-reference/subscription-invoice/list-invoices-for-a-subscription"},{"title":"Get an invoice by ID","deprecated":null,"version":null,"openapi":"/api-reference/orchestrator-openapi.json get /v1/subscription-invoices/{id}","href":"/api-reference/subscription-invoice/get-an-invoice-by-id"},{"title":"Process payment for an invoice","deprecated":null,"version":null,"openapi":"/api-reference/orchestrator-openapi.json post /v1/subscription-invoices/{id}/pay","href":"/api-reference/subscription-invoice/process-payment-for-an-invoice"},{"title":"Void an invoice","deprecated":null,"version":null,"openapi":"/api-reference/orchestrator-openapi.json post /v1/subscription-invoices/{id}/void","href":"/api-reference/subscription-invoice/void-an-invoice"}]}]},{"group":"Link Product API","pages":[{"group":"Payment Links","pages":[{"title":"Create payment link","deprecated":null,"version":null,"openapi":"/api-reference/link-product-openapi.json post /payment-links","href":"/api-reference/payment-links/create-payment-link"},{"title":"List payment links","description":"List payment links with pagination, filtering, and sorting. Results are automatically filtered by the authenticated merchant unless a different merchantId is provided in the filter.","deprecated":null,"version":null,"openapi":"/api-reference/link-product-openapi.json post /payment-links/list","href":"/api-reference/payment-links/list-payment-links"},{"title":"Get payment link","deprecated":null,"version":null,"openapi":"/api-reference/link-product-openapi.json get /payment-links/{id}","href":"/api-reference/payment-links/get-payment-link"},{"title":"Update payment link","description":"Update an existing payment link","deprecated":null,"version":null,"openapi":"/api-reference/link-product-openapi.json put /payment-links/{id}","href":"/api-reference/payment-links/update-payment-link"}]},{"group":"Products","pages":[{"title":"Create product","deprecated":null,"version":null,"openapi":"/api-reference/link-product-openapi.json post /products","href":"/api-reference/products/create-product"},{"title":"Get product","deprecated":null,"version":null,"openapi":"/api-reference/link-product-openapi.json get /products/{id}","href":"/api-reference/products/get-product"},{"title":"Update product","deprecated":null,"version":null,"openapi":"/api-reference/link-product-openapi.json put /products/{id}","href":"/api-reference/products/update-product"},{"title":"Delete product","deprecated":null,"version":null,"openapi":"/api-reference/link-product-openapi.json delete /products/{id}","href":"/api-reference/products/delete-product"},{"title":"List products","deprecated":null,"version":null,"openapi":"/api-reference/link-product-openapi.json post /products/list","href":"/api-reference/products/list-products"},{"title":"Bulk import products","deprecated":null,"version":null,"openapi":"/api-reference/link-product-openapi.json post /products/bulk-import","href":"/api-reference/products/bulk-import-products"}]},{"group":"Invoices","pages":[{"title":"List invoices","deprecated":null,"version":null,"openapi":"/api-reference/link-product-openapi.json get /invoices","href":"/api-reference/invoices/list-invoices"},{"title":"Get invoice","deprecated":null,"version":null,"openapi":"/api-reference/link-product-openapi.json get /invoices/{id}","href":"/api-reference/invoices/get-invoice"},{"title":"Refund invoice","deprecated":null,"version":null,"openapi":"/api-reference/link-product-openapi.json post /invoices/{id}/refund","href":"/api-reference/invoices/refund-invoice"}]}]}]},"basePath":"","title":"Get payment link - Cheqpay","buildId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","deploymentId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CBsVopKK.js","utils-DZAk68jJ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-D32AYZrP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D_A5_cny.js","snippetPresets-xNRfS9th.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BIB25-tq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CydJ4w4j.js","shallow-CYPBeQSG.js","getApiPlaygroundDisplay-A5xJVBOu.js","CodeSnippet-BVRTgi3m.js","CodeSnippets-DjD6BSlt.js","Page-Dr40SSJq.js","getPastedJson-D4V4JyrR.js","icon-uhcnG22T.js","MethodPill-CM-ZQdGH.js","DuplicateIcon-B_WnOiNf.js","createIcon-CJsb8utt.js","DynamicMarkdown-D-2HDKEp.js","SectionHeading-KP5xmMgQ.js","axios-vUo_bRtp.js","Markdown-D_k0dg6k.js","clsx-DK3K4Z1S.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DE3EVdvd.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-fN9H9n9g.js"]}