Skip to content

Bridge Payments Docs

Main Navigation Home Getting Started API Reference Guides Providers Pubflow

Appearance

Sidebar Navigation

Introduction

What is Bridge Payments?

Getting Started

Core Concepts

Architecture

Configuration

Environment Setup

Module Hub & extensions

Pubflow Integration

Payment Providers

Database Setup

API Reference

Overview

Memberships

Public products listing

Orders

Account Balance

Database Schema

Payments

POST Create Payment Intent

GET List Payments

GET Get Payment by ID

PUT Update Payment Intent

POST Confirm Payment Intent

POST Sync Payment Intent Status

Payment Methods

GET List Payment Methods

POST Create Payment Method (Token-based)

POST Create Payment Method Setup Intent

GET Get Payment Method by ID

PUT Update Payment Method

DELETE Delete Payment Method

PATCH Link or unlink billing address (provider sync)

Customers

GET List Customers

POST Create Customer

GET Get Customer by ID

PUT Update Customer

DELETE Delete Customer

Addresses

GET List Addresses

POST Create Address

GET Get Address by ID

PUT Update Address

DELETE Delete Address

Products

GET List Products

GET Get Product by ID

Subscriptions

GET List Subscriptions

POST Create Subscription

GET Get Subscription by ID

PUT Update Subscription

PATCH Link or unlink billing address on subscription

POST Cancel Subscription

Guest Conversion

POST Convert Guest to Authenticated User

GET Preview Guest Data

GET List My Guest Data

Health

GET Basic Health Check

GET Detailed Health Check

GET Database Health Check

GET Payment Providers Health

GET Flowless Bridge Health

Admin - Products

GET List Products (Admin)

POST Create Product (Admin)

GET Get Product by ID (Admin)

PUT Update Product (Admin)

DELETE Delete Product (Admin)

POST Sync Product with Provider (Admin)

GET Get Product Sync Status (Admin)

Admin - Sync

POST Sync All Products with All Providers (Admin)

POST Sync All Products with Specific Provider (Admin)

GET Get Overall Sync Status (Admin)

POST Migrate Product Prices (Admin)

POST Sync Specific Products (Admin)

GET Sync System Health Check (Admin)

Admin - Subscriptions

GET Subscription Analytics (Admin)

POST Bulk Update Subscriptions (Admin)

POST Migrate Subscription Prices (Admin)

GET Subscription System Health (Admin)

GET Generate Subscription Reports (Admin)

Admin - Renewals

GET Get Renewal System Status (Admin)

POST Manually Trigger Renewal Processing (Admin)

POST Pause Renewal Processing (Admin)

POST Resume Renewal Processing (Admin)

POST Pause Retry Processing (Admin)

POST Resume Retry Processing (Admin)

GET Get Subscriptions Due for Renewal (Admin)

GET Get Subscriptions in Retry Queue (Admin)

GET Get Billing Configurations (Admin)

GET Renewal System Health Check (Admin)

GET Admin Dashboard Overview (Admin)

Admin - Module Hub

GET Get Module Hub bootstrap status (Admin)

POST Dry-run Module Hub bootstrap (Admin)

POST Run Module Hub bootstrap (Admin)

GET List discoverable modules (Admin)

GET Get module install status (Admin)

GET Get module registry rows and recent events (Admin)

POST Dry-run module install or upgrade plan (Admin)

POST Run module install or upgrade (Admin)

POST Dry-run module component updates (Admin)

POST Run module component updates (Admin)

Organizations

GET List Organizations

POST Create Organization

GET Get Organization

PUT Update Organization

DELETE Delete Organization

GET List Organization Members

POST Add Organization Member

PUT Update Member Role

DELETE Remove Organization Member

POST Leave Organization

Bridge Pages

GET Get current user (Flowless proxy)

GET Payment checkout page

GET Session login page

POST Email/password login (Flowless proxy)

GET Customer portal (tabs)

GET Subscriptions manager page

GET Payment methods page

GET Addresses page

GET Billing history page

Bridge Embeds

GET Embed payment widget

GET Embed session login

GET Embed portal widget

GET Embed subscriptions list

GET Embed payment methods widget

GET Embed pay button

GET Embed payments history widget

Projects

GET Look up project invite (public)

GET List projects for current user

POST Create project

GET Get project

POST Invite project member

POST Accept project invite

GET List project members

DELETE Remove project member

PATCH Update project member role

Memberships

GET List active membership tiers

GET Get membership tier

GET List current user's memberships

GET Get current user's membership

POST Cancel current user membership

GET List memberships for user (ownership enforced)

GET Get membership for user

POST Cancel membership for user

GET List organization memberships

GET Get organization membership

POST Cancel organization membership

GET Verify feature access for current user

GET List memberships for project

GET Get project membership

POST Cancel project membership

Admin - Memberships

POST Create membership tier

PUT Update membership tier

DELETE Deactivate membership tier

GET List all memberships (paginated)

GET List memberships for user (admin)

POST Create user membership (admin)

PUT Update membership record

POST Extend membership by days

GET Membership analytics overview

GET Membership churn analytics

Webhooks

GET Get external webhook configuration

POST Send a test external webhook

POST Simulate an external webhook event

Orders

GET List orders

POST Create order

GET Get order by ID

Account Balance

GET List my balances

GET List balances for specific user (admin)

GET Get my total balance

GET Get user total balance (admin)

POST Create balance

GET Get balance by ID

POST Credit balance

POST Debit balance

GET List balance transactions

GET Get balance statistics

GET List expiring balances (admin)

Cost Tracking

GET List costs for product

GET Get active product cost at date

GET Total product cost at date

POST Create product cost

PUT Update product cost row

DELETE Delete product cost

POST Close product cost (set effective_until)

GET Order cost analysis

GET Subscription cost analysis

GET Profitability statistics

GET Low margin orders

GET Loss orders

GET Top profitable orders

Billing Schedules

GET Current user's schedules

GET User's schedules (admin)

GET Active schedules (admin)

GET Due schedules (admin)

POST Create billing schedule

GET Get schedule by ID

DELETE Delete schedule

POST Pause schedule

POST Resume schedule

POST Cancel schedule

GET Execution history

GET Execution statistics

GET Failed executions (admin)

Invoices

GET List invoices

POST Create invoice

GET Get invoice

Receipts

GET List my receipts

GET List receipts for user (admin)

GET Get receipt by receipt number

GET Get receipt by ID

DELETE Delete receipt

POST Create receipt

POST Mark receipt as sent

POST Void receipt

GET Unsent receipts (admin)

GET Receipt revenue analytics (admin)

Payment Providers

Polar

Stripe

PayPal

Authorize.net

Request New Provider

Integration Examples

React Native

Next.js

React

Community Libraries

Guides

Guest Checkout

Saved Payment Methods

Subscriptions

Organizations

External Webhooks

Performance Optimization

Testing

🤖 AI Context

Documentation Overview

Full Developer Context

Embed portal widget

GET

/embed/portal

Requires EMBED_ENABLED. Compact portal with subscriptions, payment methods, addresses tabs.

Responses

Embed portal HTML

Content-Type

text/html

JSON

"string"

GET

/embed/portal

Playground

Samples

Powered by VitePress OpenAPI

Pager

Previous page GET Embed session login

Next page GET Embed subscriptions list

Part of the Pubflow Ecosystem: Flowless • Flowfull • Clients

Copyright © 2026 Pubflow, Inc.