ZapAPI Docs
Get StartedConceptsAI GatewayGuidesPayment GatewaySDKAPI ReferenceResources

Changelog

Notable changes to the ZapAPI platform — new features, breaking changes, deprecations and fixes.

All notable changes to the ZapAPI platform are documented here. The format is based on Keep a Changelog, and this project adheres to Semantic Versioning for the TypeScript SDK.

Subscribe to changelog updates via the dashboard notification settings, or watch the GitHub repository.

[Unreleased]

Added

  • Coupons & Offers — one discount engine, two modes: coupon (code-gated at checkout, Stripe-style) and offer (auto-applied in its validity window, Razorpay-style). Percent or fixed-sats, validity windows, max-redemption caps (CAS-enforced). Applies to invoices (couponCode on POST /v1/invoices) and payment-link checkouts (offers auto-apply, coupon field in the UI). Public validate/resolve endpoints for custom checkouts. Dashboard: Project → Coupons & Offers.
  • Gift cards — prepaid sats codes with real money movement at every step: paid issuance collects the purchase into your settlement wallet up front (classic gift-card sale), free issuance is merchant-funded; recipients redeem REAL sats into their own wallet via LNURL-withdraw (partial redemptions supported, CAS balance accounting). Public redemption page at /gift-card. Dashboard: Project → Gift Cards. SDK: zap.giftCards.*.
  • Project subscription billing — full recurring billing for projects (Stripe-Billing-style): POST/GET/PATCH/DELETE /v1/plans and GET /v1/subscriptions (+ /revenue, /:id/cancel) with new API-key scopes plans:* and subscriptions:*. Hosted checkout at /subscribe/:planId, magic-link subscriber portal (pause / cancel / NWC auto-pay), trials, scarcity caps, 3-day grace → past_due → 7-day cancel dunning ladder, and renewals that settle to the project's settlement wallet (including NWC wallets — non-custodial end to end).
  • Project CRM — customers are now auto-built from settled project invoices and payment links (customers.projectId): LTV, payment counts, segments (vip/whale/new/churned/subscribed). Filter via GET /v1/customers?projectId=…. New dashboard page: Project → Customers.
  • Project dashboard pages — Plans, Subscriptions, Customers, Refunds (with refund creation from the invoice detail view), and a rewritten Analytics page (project revenue, invoice funnel, MRR) replacing the mis-scoped API-quota page. Project webhooks page now shows a project-scoped delivery log with manual retry.
  • Webhook delivery filter — GET /v1/webhooks/deliveries?projectId=….
  • SDK — new zap.plans and zap.subscriptions resources, plus zap.customers.list({ projectId }) / zap.customers.stats(projectId).
  • Settlement-wallet invoices — POST /v1/invoices now resolves settlement from the project's settlement wallet. projectId is optional for project-scoped API keys and providerId is deprecated — an API key is all an integrator needs.
  • NWC project settlement — link "My own wallet (NWC)" as a project's settlement wallet (Dashboard → Project → Settlement Wallet); project invoices and payment links settle directly into your own external wallet, fully non-custodial.
  • AI Gateway — 500+ AI models (chat, image, video, TTS, STT, embeddings) through one OpenAI-compatible endpoint, billed per query in Bitcoin sats over Lightning. Vision input, web search, thinking levels, routing suffixes, live sats pricing, Lightning topups with +5% bonus, NWC auto-topup, and a public model catalog at zapapi.com/models.
  • AI Tools — pay-per-call tools: image & video generation, TTS in 600+ languages, translation, OCR, comms and more. Live sats quotes before every call, explicit confirmation for destructive actions, automatic refunds on upstream failures. Docs at AI Tools.
  • SDK v0.2.0 — adds zap.aiTools (list, quote, execute, jobs, waitForCompletion, history) alongside the full platform surface.
  • AI documentation — new AI Gateway section: quickstart, models & pricing, chat completions, tools, billing, and NWC auto-topup.
  • SDK v0.2.0 — the full platform in @zapapi/sdk: projects, payments, API keys, FX, providers, wallet, NWC connections, lightning addresses, paywalls, swaps, withdrawals, directory, marketplace, watch-only, and the complete AI resource (chat streaming, topups, usage, auto-topup).
  • Docs restructure — removed internal planning pages; professional product documentation across the board.

Changed

  • Platform architecture page rewritten to cover all three product surfaces (Payments, Creator, AI Gateway).

[2026-10-25]

Added

  • NWC service mode — your ZapAPI wallet can act as a NIP-47 wallet service. Apps connect to ZapAPI (the inverse of connecting an NWC wallet as a provider), with per-connection budgets and permissions.
  • LNDHub — point any LNDHub-compatible wallet app (BlueWallet, Zeus, BitBanana) at your ZapAPI wallet as a remote control.
  • Auto-forward / Scrub — sweep incoming sats to cold storage automatically, keeping a configurable liquidity reserve in the hot wallet.
  • Revenue Splits — auto-pay a percentage of every settled project invoice to up to 5 lightning addresses (affiliate / marketplace fee payouts).
  • Tabs — running customer bills with a public settlement link.
  • Paid Calendar — sell your time in slots; buyers pay to book.
  • Event Tickets — paid ticket sales with QR check-in.
  • Paywalls — paid URL unlocks; the destination is revealed only after payment.

Changed

  • Webhook delivery log now records manual: true for dashboard-triggered retries and replays.
  • invoice.paid payloads now include the preimage for custodial verification.

Deprecated

  • GET /api/v1/payments/:id (singular) — use GET /api/v1/invoices/:id. Sunset date: 2027-04-25.

[2026-09-12]

Added

  • Lightning Address Marketplace — claim you@zapapi.app or buy a premium address on any registered provider domain.
  • NIP-05 verification — every Lightning Address doubles as a verifiable Nostr identity.
  • NIP-57 zaps — full zap server: kind 9734 validation, kind 9735 receipt publication to relays.

Fixed

  • Race condition in concurrent invoice settlement that could cause double-counted analytics.

[2026-08-01]

Added

  • Public launch of the ZapAPI platform.
  • TypeScript SDK @zapapi/sdk@1.0.0.
  • Hosted checkout at pay.zapapi.com.

On this page