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:

<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/stripe"
    },
    {
      "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": "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": "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"
            }
          ]
        },
        {
          "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--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": "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"
            }
          ]
        },
        {
          "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"
            }
          ]
        },
        {
          "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--post\">POST</span>\n        <span class=\"OASidebarItem-text text\">Cancel Subscription</span>\n      </span>",
              "link": "/operations/cancelSubscription"
            }
          ]
        },
        {
          "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"
            }
          ]
        },
        {
          "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"
            }
          ]
        },
        {
          "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"
            }
          ]
        },
        {
          "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"
            }
          ]
        },
        {
          "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"
            }
          ]
        },
        {
          "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"
            }
          ]
        },
        {
          "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"
            }
          ]
        }
      ]
    },
    {
      "text": "Payment Providers",
      "items": [
        {
          "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/bridge-payments"
    },
    {
      "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.