Create a payment link
Creates a reusable, shareable payment link.
checkout.session.completed. See Which action fires which event.Authorizations
Your secret key, from app.agentaos.ai -> Settings -> Developers -> API Keys. The key's prefix is both its identity and its environment: sk_test_... (sandbox, free, no verification) or sk_live_... (real money, requires business verification). A missing or invalid key returns 401.
Body
Amount in currency units, e.g. 49.99.
0.01 <= x <= 1000000Defaults to your org's settlement currency. A fiat code is mapped to your org's default settlement token internally; the link stores the resolved token.
EUR, USD, EURC, EURe, USDC 1000Product name, for the catalog-style link surfaces. Separate from description.
120HTTPS only.
2048A subscription link requires billingInterval and settles on the card/bank rail (Merchant of Record); it can't be a crypto-settlement link.
one_time, subscription Required when type is subscription, must be omitted for one_time.
month, year Free-trial length in days. Subscription links only. The buyer's card is saved with nothing due today; the first charge happens when the trial ends.
1 <= x <= 730Price of the trial period in currency units, e.g. 1.00. Only with trialPeriodDays. Omit it, or send null, for a free trial.
0.01 <= x <= 10000001 for single-use, N for a limited quantity, omitted for unlimited.
1 <= x <= 100000Must belong to your organization.
204820482048Arbitrary key-value data, returned unchanged on webhooks. Up to 8KB serialized.
CAIP-2 network IDs (e.g. eip155:8453), for crypto-settlement links. Ignored (and taken from your key's configuration instead) if your API key is scoped to specific networks.
Whether the price includes VAT (inclusive, the price a buyer sees is the price they pay) or VAT is added at checkout (exclusive). Omitted inherits your org's tax mode setting.
inclusive, exclusive Response
Payment link created.
Payment link UUID.
Public ID used in the checkout URL.
Currency units.
Settlement currency or token.
Your custom data.
active, cancelled Successful payments against this link so far.
null means unlimited.
mor (card + bank) or crypto (on-chain). The snake_case column equivalent of the computed sellerMode.
mor, crypto one_time, subscription month, year, null test, live Full URL to share with buyers. Computed, camelCase, no snake_case equivalent.
mor, crypto This product's own VAT mode override; null when it follows the account setting.
inclusive, exclusive, null Free-trial length in days, or null when the link has no trial.
Price of the trial period in currency units, or null for a free trial (or no trial).