Runtime API Examples
This page demonstrates usage of some of the runtime APIs provided by VitePress.
The main useData() API can be used to access site, theme, and page data for the current page. It works in both .md and .vue files:
md
<script setup>
import { useData } from 'vitepress'
const { theme, page, frontmatter } = useData()
</script>
## Results
### Theme Data
<pre>{{ theme }}</pre>
### Page Data
<pre>{{ page }}</pre>
### Page Frontmatter
<pre>{{ frontmatter }}</pre>Results
Theme Data
{
"logo": "https://cloud.notside.com/pubflow/Pubflow-Favicon.png",
"nav": [
{
"text": "Home",
"link": "/introduction"
},
{
"text": "Getting Started",
"link": "/getting-started"
},
{
"text": "API Reference",
"link": "/api/authentication"
},
{
"text": "Guides",
"link": "/guides/guest-checkout"
},
{
"text": "Providers",
"link": "/providers/polar"
},
{
"text": "Pubflow",
"link": "https://pubflow.com"
}
],
"sidebar": [
{
"text": "Introduction",
"items": [
{
"text": "What is Bridge Payments?",
"link": "/introduction"
},
{
"text": "Getting Started",
"link": "/getting-started"
},
{
"text": "Core Concepts",
"link": "/core-concepts"
},
{
"text": "Architecture",
"link": "/architecture"
}
]
},
{
"text": "Configuration",
"items": [
{
"text": "Environment Setup",
"link": "/configuration/environment"
},
{
"text": "Module Hub & extensions",
"link": "/configuration/module-hub"
},
{
"text": "Pubflow Integration",
"link": "/configuration/pubflow"
},
{
"text": "Payment Providers",
"link": "/configuration/providers"
},
{
"text": "Database Setup",
"link": "/configuration/database"
}
]
},
{
"text": "API Reference",
"items": [
{
"text": "Overview",
"link": "/api/authentication"
},
{
"text": "Memberships",
"link": "/api/memberships"
},
{
"text": "Public products listing",
"link": "/api/products-listing"
},
{
"text": "Orders",
"link": "/api/orders"
},
{
"text": "Account Balance",
"link": "/api/account-balance"
},
{
"text": "Database Schema",
"link": "/api/schema"
},
{
"text": "Payments",
"items": [
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Create Payment Intent</span>\n </span>",
"link": "/operations/createPaymentIntent"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">List Payments</span>\n </span>",
"link": "/operations/listPayments"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Get Payment by ID</span>\n </span>",
"link": "/operations/getPaymentById"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--put\">PUT</span>\n <span class=\"OASidebarItem-text text\">Update Payment Intent</span>\n </span>",
"link": "/operations/updatePaymentIntent"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Confirm Payment Intent</span>\n </span>",
"link": "/operations/confirmPaymentIntent"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Sync Payment Intent Status</span>\n </span>",
"link": "/operations/syncPaymentIntent"
}
],
"collapsed": true
},
{
"text": "Payment Methods",
"items": [
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">List Payment Methods</span>\n </span>",
"link": "/operations/listPaymentMethods"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Create Payment Method (Token-based)</span>\n </span>",
"link": "/operations/createPaymentMethod"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Create Payment Method Setup Intent</span>\n </span>",
"link": "/operations/createPaymentMethodSetupIntent"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Get Payment Method by ID</span>\n </span>",
"link": "/operations/getPaymentMethodById"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--put\">PUT</span>\n <span class=\"OASidebarItem-text text\">Update Payment Method</span>\n </span>",
"link": "/operations/updatePaymentMethod"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--delete\">DELETE</span>\n <span class=\"OASidebarItem-text text\">Delete Payment Method</span>\n </span>",
"link": "/operations/deletePaymentMethod"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--patch\">PATCH</span>\n <span class=\"OASidebarItem-text text\">Link or unlink billing address (provider sync)</span>\n </span>",
"link": "/operations/patchPaymentMethodBillingAddress"
}
],
"collapsed": true
},
{
"text": "Customers",
"items": [
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">List Customers</span>\n </span>",
"link": "/operations/listCustomers"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Create Customer</span>\n </span>",
"link": "/operations/createCustomer"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Get Customer by ID</span>\n </span>",
"link": "/operations/getCustomerById"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--put\">PUT</span>\n <span class=\"OASidebarItem-text text\">Update Customer</span>\n </span>",
"link": "/operations/updateCustomer"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--delete\">DELETE</span>\n <span class=\"OASidebarItem-text text\">Delete Customer</span>\n </span>",
"link": "/operations/deleteCustomer"
}
],
"collapsed": true
},
{
"text": "Addresses",
"items": [
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">List Addresses</span>\n </span>",
"link": "/operations/listAddresses"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Create Address</span>\n </span>",
"link": "/operations/createAddress"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Get Address by ID</span>\n </span>",
"link": "/operations/getAddressById"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--put\">PUT</span>\n <span class=\"OASidebarItem-text text\">Update Address</span>\n </span>",
"link": "/operations/updateAddress"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--delete\">DELETE</span>\n <span class=\"OASidebarItem-text text\">Delete Address</span>\n </span>",
"link": "/operations/deleteAddress"
}
],
"collapsed": true
},
{
"text": "Products",
"items": [
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">List Products</span>\n </span>",
"link": "/operations/listProducts"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Get Product by ID</span>\n </span>",
"link": "/operations/getProductById"
}
],
"collapsed": true
},
{
"text": "Subscriptions",
"items": [
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">List Subscriptions</span>\n </span>",
"link": "/operations/listSubscriptions"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Create Subscription</span>\n </span>",
"link": "/operations/createSubscription"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Get Subscription by ID</span>\n </span>",
"link": "/operations/getSubscriptionById"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--put\">PUT</span>\n <span class=\"OASidebarItem-text text\">Update Subscription</span>\n </span>",
"link": "/operations/updateSubscription"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--patch\">PATCH</span>\n <span class=\"OASidebarItem-text text\">Link or unlink billing address on subscription</span>\n </span>",
"link": "/operations/patchSubscriptionBillingAddress"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Cancel Subscription</span>\n </span>",
"link": "/operations/cancelSubscription"
}
],
"collapsed": true
},
{
"text": "Guest Conversion",
"items": [
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Convert Guest to Authenticated User</span>\n </span>",
"link": "/operations/convertGuest"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Preview Guest Data</span>\n </span>",
"link": "/operations/previewGuest"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">List My Guest Data</span>\n </span>",
"link": "/operations/listMyGuestData"
}
],
"collapsed": true
},
{
"text": "Health",
"items": [
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Basic Health Check</span>\n </span>",
"link": "/operations/getHealth"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Detailed Health Check</span>\n </span>",
"link": "/operations/getDetailedHealth"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Database Health Check</span>\n </span>",
"link": "/operations/getDatabaseHealth"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Payment Providers Health</span>\n </span>",
"link": "/operations/getProvidersHealth"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Flowless Bridge Health</span>\n </span>",
"link": "/operations/getFlowlessHealth"
}
],
"collapsed": true
},
{
"text": "Admin - Products",
"items": [
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">List Products (Admin)</span>\n </span>",
"link": "/operations/adminListProducts"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Create Product (Admin)</span>\n </span>",
"link": "/operations/adminCreateProduct"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Get Product by ID (Admin)</span>\n </span>",
"link": "/operations/adminGetProduct"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--put\">PUT</span>\n <span class=\"OASidebarItem-text text\">Update Product (Admin)</span>\n </span>",
"link": "/operations/adminUpdateProduct"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--delete\">DELETE</span>\n <span class=\"OASidebarItem-text text\">Delete Product (Admin)</span>\n </span>",
"link": "/operations/adminDeleteProduct"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Sync Product with Provider (Admin)</span>\n </span>",
"link": "/operations/adminSyncProduct"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Get Product Sync Status (Admin)</span>\n </span>",
"link": "/operations/adminGetProductSyncStatus"
}
],
"collapsed": true
},
{
"text": "Admin - Sync",
"items": [
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Sync All Products with All Providers (Admin)</span>\n </span>",
"link": "/operations/adminSyncAll"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Sync All Products with Specific Provider (Admin)</span>\n </span>",
"link": "/operations/adminSyncProvider"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Get Overall Sync Status (Admin)</span>\n </span>",
"link": "/operations/adminGetSyncStatus"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Migrate Product Prices (Admin)</span>\n </span>",
"link": "/operations/adminMigratePrices"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Sync Specific Products (Admin)</span>\n </span>",
"link": "/operations/adminSyncProducts"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Sync System Health Check (Admin)</span>\n </span>",
"link": "/operations/adminGetSyncHealth"
}
],
"collapsed": true
},
{
"text": "Admin - Subscriptions",
"items": [
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Subscription Analytics (Admin)</span>\n </span>",
"link": "/operations/adminGetSubscriptionAnalytics"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Bulk Update Subscriptions (Admin)</span>\n </span>",
"link": "/operations/adminBulkUpdateSubscriptions"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Migrate Subscription Prices (Admin)</span>\n </span>",
"link": "/operations/adminMigrateSubscriptionPrices"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Subscription System Health (Admin)</span>\n </span>",
"link": "/operations/adminGetSubscriptionHealth"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Generate Subscription Reports (Admin)</span>\n </span>",
"link": "/operations/adminGetSubscriptionReports"
}
],
"collapsed": true
},
{
"text": "Admin - Renewals",
"items": [
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Get Renewal System Status (Admin)</span>\n </span>",
"link": "/operations/adminGetRenewalStatus"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Manually Trigger Renewal Processing (Admin)</span>\n </span>",
"link": "/operations/adminTriggerRenewal"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Pause Renewal Processing (Admin)</span>\n </span>",
"link": "/operations/adminPauseRenewal"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Resume Renewal Processing (Admin)</span>\n </span>",
"link": "/operations/adminResumeRenewal"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Pause Retry Processing (Admin)</span>\n </span>",
"link": "/operations/adminPauseRetries"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Resume Retry Processing (Admin)</span>\n </span>",
"link": "/operations/adminResumeRetries"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Get Subscriptions Due for Renewal (Admin)</span>\n </span>",
"link": "/operations/adminGetDueRenewals"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Get Subscriptions in Retry Queue (Admin)</span>\n </span>",
"link": "/operations/adminGetRetryQueue"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Get Billing Configurations (Admin)</span>\n </span>",
"link": "/operations/adminGetBillingConfigs"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Renewal System Health Check (Admin)</span>\n </span>",
"link": "/operations/adminGetRenewalHealth"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Admin Dashboard Overview (Admin)</span>\n </span>",
"link": "/operations/adminGetDashboard"
}
],
"collapsed": true
},
{
"text": "Admin - Module Hub",
"items": [
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Get Module Hub bootstrap status (Admin)</span>\n </span>",
"link": "/operations/adminGetModuleHubStatus"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Dry-run Module Hub bootstrap (Admin)</span>\n </span>",
"link": "/operations/adminModuleHubBootstrapDryRun"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Run Module Hub bootstrap (Admin)</span>\n </span>",
"link": "/operations/adminModuleHubBootstrapRun"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">List discoverable modules (Admin)</span>\n </span>",
"link": "/operations/adminListModuleHubModules"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Get module install status (Admin)</span>\n </span>",
"link": "/operations/adminGetModuleHubModuleStatus"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Get module registry rows and recent events (Admin)</span>\n </span>",
"link": "/operations/adminGetModuleHubModuleRegistry"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Dry-run module install or upgrade plan (Admin)</span>\n </span>",
"link": "/operations/adminModuleHubInstallDryRun"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Run module install or upgrade (Admin)</span>\n </span>",
"link": "/operations/adminModuleHubInstallRun"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Dry-run module component updates (Admin)</span>\n </span>",
"link": "/operations/adminModuleHubUpdateDryRun"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Run module component updates (Admin)</span>\n </span>",
"link": "/operations/adminModuleHubUpdateRun"
}
],
"collapsed": true
},
{
"text": "Organizations",
"items": [
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">List Organizations</span>\n </span>",
"link": "/operations/listOrganizations"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Create Organization</span>\n </span>",
"link": "/operations/createOrganization"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Get Organization</span>\n </span>",
"link": "/operations/getOrganization"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--put\">PUT</span>\n <span class=\"OASidebarItem-text text\">Update Organization</span>\n </span>",
"link": "/operations/updateOrganization"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--delete\">DELETE</span>\n <span class=\"OASidebarItem-text text\">Delete Organization</span>\n </span>",
"link": "/operations/deleteOrganization"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">List Organization Members</span>\n </span>",
"link": "/operations/listOrganizationMembers"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Add Organization Member</span>\n </span>",
"link": "/operations/addOrganizationMember"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--put\">PUT</span>\n <span class=\"OASidebarItem-text text\">Update Member Role</span>\n </span>",
"link": "/operations/updateOrganizationMemberRole"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--delete\">DELETE</span>\n <span class=\"OASidebarItem-text text\">Remove Organization Member</span>\n </span>",
"link": "/operations/removeOrganizationMember"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Leave Organization</span>\n </span>",
"link": "/operations/leaveOrganization"
}
],
"collapsed": true
},
{
"text": "Bridge Pages",
"items": [
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Get current user (Flowless proxy)</span>\n </span>",
"link": "/operations/getPagesMe"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Payment checkout page</span>\n </span>",
"link": "/operations/getPagesPay"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Session login page</span>\n </span>",
"link": "/operations/getPagesLogin"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Email/password login (Flowless proxy)</span>\n </span>",
"link": "/operations/postPagesLogin"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Customer portal (tabs)</span>\n </span>",
"link": "/operations/getPagesPortal"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Subscriptions manager page</span>\n </span>",
"link": "/operations/getPagesSubscriptions"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Payment methods page</span>\n </span>",
"link": "/operations/getPagesPaymentMethods"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Addresses page</span>\n </span>",
"link": "/operations/getPagesAddresses"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Billing history page</span>\n </span>",
"link": "/operations/getPagesInvoices"
}
],
"collapsed": true
},
{
"text": "Bridge Embeds",
"items": [
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Embed payment widget</span>\n </span>",
"link": "/operations/getEmbedPay"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Embed session login</span>\n </span>",
"link": "/operations/getEmbedLogin"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Embed portal widget</span>\n </span>",
"link": "/operations/getEmbedPortal"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Embed subscriptions list</span>\n </span>",
"link": "/operations/getEmbedSubscriptions"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Embed payment methods widget</span>\n </span>",
"link": "/operations/getEmbedPaymentMethods"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Embed pay button</span>\n </span>",
"link": "/operations/getEmbedButton"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Embed payments history widget</span>\n </span>",
"link": "/operations/getEmbedPayments"
}
],
"collapsed": true
},
{
"text": "Projects",
"items": [
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Look up project invite (public)</span>\n </span>",
"link": "/operations/getProjectInviteByToken"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">List projects for current user</span>\n </span>",
"link": "/operations/listProjects"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Create project</span>\n </span>",
"link": "/operations/createProject"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Get project</span>\n </span>",
"link": "/operations/getProjectById"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Invite project member</span>\n </span>",
"link": "/operations/createProjectInvite"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Accept project invite</span>\n </span>",
"link": "/operations/acceptProjectInvite"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">List project members</span>\n </span>",
"link": "/operations/listProjectMembers"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--delete\">DELETE</span>\n <span class=\"OASidebarItem-text text\">Remove project member</span>\n </span>",
"link": "/operations/removeProjectMember"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--patch\">PATCH</span>\n <span class=\"OASidebarItem-text text\">Update project member role</span>\n </span>",
"link": "/operations/updateProjectMemberRole"
}
],
"collapsed": true
},
{
"text": "Memberships",
"items": [
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">List active membership tiers</span>\n </span>",
"link": "/operations/listMembershipTiers"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Get membership tier</span>\n </span>",
"link": "/operations/getMembershipTierById"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">List current user's memberships</span>\n </span>",
"link": "/operations/listMyMemberships"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Get current user's membership</span>\n </span>",
"link": "/operations/getMyMembershipById"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Cancel current user membership</span>\n </span>",
"link": "/operations/cancelMyMembership"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">List memberships for user (ownership enforced)</span>\n </span>",
"link": "/operations/listMembershipsForUser"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Get membership for user</span>\n </span>",
"link": "/operations/getMembershipForUser"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Cancel membership for user</span>\n </span>",
"link": "/operations/cancelMembershipForUser"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">List organization memberships</span>\n </span>",
"link": "/operations/listOrganizationMemberships"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Get organization membership</span>\n </span>",
"link": "/operations/getOrganizationMembership"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Cancel organization membership</span>\n </span>",
"link": "/operations/cancelOrganizationMembership"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Verify feature access for current user</span>\n </span>",
"link": "/operations/verifyMembershipFeatureAccess"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">List memberships for project</span>\n </span>",
"link": "/operations/listProjectMemberships"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Get project membership</span>\n </span>",
"link": "/operations/getProjectMembership"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Cancel project membership</span>\n </span>",
"link": "/operations/cancelProjectMembership"
}
],
"collapsed": true
},
{
"text": "Admin - Memberships",
"items": [
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Create membership tier</span>\n </span>",
"link": "/operations/adminCreateMembershipTier"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--put\">PUT</span>\n <span class=\"OASidebarItem-text text\">Update membership tier</span>\n </span>",
"link": "/operations/adminUpdateMembershipTier"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--delete\">DELETE</span>\n <span class=\"OASidebarItem-text text\">Deactivate membership tier</span>\n </span>",
"link": "/operations/adminDeactivateMembershipTier"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">List all memberships (paginated)</span>\n </span>",
"link": "/operations/adminListAllMemberships"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">List memberships for user (admin)</span>\n </span>",
"link": "/operations/adminListMembershipsForUser"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Create user membership (admin)</span>\n </span>",
"link": "/operations/adminCreateUserMembership"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--put\">PUT</span>\n <span class=\"OASidebarItem-text text\">Update membership record</span>\n </span>",
"link": "/operations/adminUpdateMembershipRecord"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Extend membership by days</span>\n </span>",
"link": "/operations/adminExtendMembership"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Membership analytics overview</span>\n </span>",
"link": "/operations/adminMembershipAnalyticsOverview"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Membership churn analytics</span>\n </span>",
"link": "/operations/adminMembershipAnalyticsChurn"
}
],
"collapsed": true
},
{
"text": "Webhooks",
"items": [
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Get external webhook configuration</span>\n </span>",
"link": "/operations/getExternalWebhooksConfig"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Send a test external webhook</span>\n </span>",
"link": "/operations/testExternalWebhook"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Simulate an external webhook event</span>\n </span>",
"link": "/operations/simulateExternalWebhook"
}
],
"collapsed": true
},
{
"text": "Orders",
"items": [
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">List orders</span>\n </span>",
"link": "/operations/listOrders"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Create order</span>\n </span>",
"link": "/operations/createOrder"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Get order by ID</span>\n </span>",
"link": "/operations/getOrderById"
}
],
"collapsed": true
},
{
"text": "Account Balance",
"items": [
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">List my balances</span>\n </span>",
"link": "/operations/listMyBalances"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">List balances for specific user (admin)</span>\n </span>",
"link": "/operations/adminListUserBalances"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Get my total balance</span>\n </span>",
"link": "/operations/getMyBalanceTotal"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Get user total balance (admin)</span>\n </span>",
"link": "/operations/adminGetUserBalanceTotal"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Create balance</span>\n </span>",
"link": "/operations/createBalance"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Get balance by ID</span>\n </span>",
"link": "/operations/getBalanceById"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Credit balance</span>\n </span>",
"link": "/operations/creditBalance"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Debit balance</span>\n </span>",
"link": "/operations/debitBalance"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">List balance transactions</span>\n </span>",
"link": "/operations/listBalanceTransactions"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Get balance statistics</span>\n </span>",
"link": "/operations/getBalanceStatistics"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">List expiring balances (admin)</span>\n </span>",
"link": "/operations/adminListExpiringBalances"
}
],
"collapsed": true
},
{
"text": "Cost Tracking",
"items": [
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">List costs for product</span>\n </span>",
"link": "/operations/listProductCosts"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Get active product cost at date</span>\n </span>",
"link": "/operations/getActiveProductCost"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Total product cost at date</span>\n </span>",
"link": "/operations/getProductCostTotal"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Create product cost</span>\n </span>",
"link": "/operations/createProductCost"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--put\">PUT</span>\n <span class=\"OASidebarItem-text text\">Update product cost row</span>\n </span>",
"link": "/operations/updateProductCost"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--delete\">DELETE</span>\n <span class=\"OASidebarItem-text text\">Delete product cost</span>\n </span>",
"link": "/operations/deleteProductCost"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Close product cost (set effective_until)</span>\n </span>",
"link": "/operations/closeProductCost"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Order cost analysis</span>\n </span>",
"link": "/operations/getOrderCostAnalysis"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Subscription cost analysis</span>\n </span>",
"link": "/operations/getSubscriptionCostAnalysis"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Profitability statistics</span>\n </span>",
"link": "/operations/getCostAnalyticsProfitability"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Low margin orders</span>\n </span>",
"link": "/operations/getCostAnalyticsLowMargins"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Loss orders</span>\n </span>",
"link": "/operations/getCostAnalyticsLosses"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Top profitable orders</span>\n </span>",
"link": "/operations/getCostAnalyticsTopProfitable"
}
],
"collapsed": true
},
{
"text": "Billing Schedules",
"items": [
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Current user's schedules</span>\n </span>",
"link": "/operations/listMyBillingSchedules"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">User's schedules (admin)</span>\n </span>",
"link": "/operations/listBillingSchedulesForUser"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Active schedules (admin)</span>\n </span>",
"link": "/operations/listActiveBillingSchedules"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Due schedules (admin)</span>\n </span>",
"link": "/operations/listDueBillingSchedules"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Create billing schedule</span>\n </span>",
"link": "/operations/createBillingSchedule"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Get schedule by ID</span>\n </span>",
"link": "/operations/getBillingScheduleById"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--delete\">DELETE</span>\n <span class=\"OASidebarItem-text text\">Delete schedule</span>\n </span>",
"link": "/operations/deleteBillingSchedule"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Pause schedule</span>\n </span>",
"link": "/operations/pauseBillingSchedule"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Resume schedule</span>\n </span>",
"link": "/operations/resumeBillingSchedule"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Cancel schedule</span>\n </span>",
"link": "/operations/cancelBillingSchedule"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Execution history</span>\n </span>",
"link": "/operations/listBillingScheduleExecutions"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Execution statistics</span>\n </span>",
"link": "/operations/getBillingScheduleStatistics"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Failed executions (admin)</span>\n </span>",
"link": "/operations/listFailedBillingExecutions"
}
],
"collapsed": true
},
{
"text": "Invoices",
"items": [
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">List invoices</span>\n </span>",
"link": "/operations/listInvoices"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Create invoice</span>\n </span>",
"link": "/operations/createInvoice"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Get invoice</span>\n </span>",
"link": "/operations/getInvoiceById"
}
],
"collapsed": true
},
{
"text": "Receipts",
"items": [
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">List my receipts</span>\n </span>",
"link": "/operations/listMyReceipts"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">List receipts for user (admin)</span>\n </span>",
"link": "/operations/listReceiptsForUser"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Get receipt by receipt number</span>\n </span>",
"link": "/operations/getReceiptByNumber"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Get receipt by ID</span>\n </span>",
"link": "/operations/getReceiptById"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--delete\">DELETE</span>\n <span class=\"OASidebarItem-text text\">Delete receipt</span>\n </span>",
"link": "/operations/deleteReceipt"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Create receipt</span>\n </span>",
"link": "/operations/createReceipt"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Mark receipt as sent</span>\n </span>",
"link": "/operations/sendReceipt"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span>\n <span class=\"OASidebarItem-text text\">Void receipt</span>\n </span>",
"link": "/operations/voidReceipt"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Unsent receipts (admin)</span>\n </span>",
"link": "/operations/listUnsentReceipts"
},
{
"text": "<span class=\"OASidebarItem group/oaOperationLink\">\n <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span>\n <span class=\"OASidebarItem-text text\">Receipt revenue analytics (admin)</span>\n </span>",
"link": "/operations/getReceiptRevenueAnalytics"
}
],
"collapsed": true
}
]
},
{
"text": "Payment Providers",
"items": [
{
"text": "Polar",
"link": "/providers/polar"
},
{
"text": "Stripe",
"link": "/providers/stripe"
},
{
"text": "PayPal",
"link": "/providers/paypal"
},
{
"text": "Authorize.net",
"link": "/providers/authorize-net"
},
{
"text": "Request New Provider",
"link": "/providers/request-new"
}
]
},
{
"text": "Integration Examples",
"items": [
{
"text": "React Native",
"link": "/clients/react-native"
},
{
"text": "Next.js",
"link": "/clients/nextjs"
},
{
"text": "React",
"link": "/clients/react"
},
{
"text": "Community Libraries",
"link": "/clients/community"
}
]
},
{
"text": "Guides",
"items": [
{
"text": "Guest Checkout",
"link": "/guides/guest-checkout"
},
{
"text": "Saved Payment Methods",
"link": "/guides/saved-payment-methods"
},
{
"text": "Subscriptions",
"link": "/guides/subscriptions"
},
{
"text": "Organizations",
"link": "/guides/organizations"
},
{
"text": "External Webhooks",
"link": "/guides/external-webhooks"
},
{
"text": "Performance Optimization",
"link": "/guides/performance-optimization"
},
{
"text": "Testing",
"link": "/guides/testing"
}
]
},
{
"text": "🤖 AI Context",
"items": [
{
"text": "Documentation Overview",
"link": "/llms.txt",
"target": "_blank"
},
{
"text": "Full Developer Context",
"link": "/llms-full.txt",
"target": "_blank"
}
]
}
],
"socialLinks": [
{
"icon": "github",
"link": "https://github.com/pubflow"
},
{
"icon": "discord",
"link": "https://discord.gg/EJfPTT6Vh7"
}
],
"footer": {
"message": "Part of the Pubflow Ecosystem: <a href=\"https://flowless.dev\" target=\"_blank\">Flowless</a> • <a href=\"https://flowfull.dev\" target=\"_blank\">Flowfull</a> • <a href=\"https://clients.flowfull.dev\" target=\"_blank\">Clients</a>",
"copyright": "Copyright © 2026 Pubflow, Inc."
},
"search": {
"provider": "local"
}
}Page Data
{
"title": "Runtime API Examples",
"description": "",
"frontmatter": {
"outline": "deep"
},
"headers": [],
"relativePath": "api-examples.md",
"filePath": "api-examples.md"
}Page Frontmatter
{
"outline": "deep"
}More
Check out the documentation for the full list of runtime APIs.