API reference
Find the operation you need, then open its request, response and credential details.
Paths are relative to https://api.businessmode.io/v1. Operations and requirements come from the committed OpenAPI contract.
110 of 110 operations
Projects
- GETList projects contained by an account
/accounts/{accountId}/projects - POSTCreate a project in an account
/accounts/{accountId}/projects - GETList projects the developer may access
/projects - GETGet project provisioning configuration
/projects/{projectId}/provisioning - PATCHUpdate project provisioning configuration
/projects/{projectId}/provisioning
Organizations
Entitlements
Licenses
- GETList project licenses
/projects/{projectId}/licenses - POSTCreate a license
/projects/{projectId}/licenses - GETGet a license
/projects/{projectId}/licenses/{licenseId} - PATCHUpdate a license
/projects/{projectId}/licenses/{licenseId} - POSTExtend a License to at least an absolute expiration
/projects/{projectId}/licenses/{licenseId}/extend - POSTRevoke a license
/projects/{projectId}/licenses/{licenseId}/revoke
Seats
- GETCheck effective entitlement access
/access - POSTAssign a seat from a customer backend
/licenses/{licenseId}/assignments - DELETERelease a seat from a customer backend
/licenses/{licenseId}/assignments/{assignmentId} - GETList license seat assignments
/projects/{projectId}/licenses/{licenseId}/assignments - POSTAssign a seat as a developer
/projects/{projectId}/licenses/{licenseId}/assignments - DELETERelease a seat as a developer
/projects/{projectId}/licenses/{licenseId}/assignments/{assignmentId} - GETGet a seat assignment
/projects/{projectId}/licenses/{licenseId}/assignments/{assignmentId} - POSTAssign seats in one atomic batch
/projects/{projectId}/licenses/{licenseId}/bulk-assignments - POSTRelease seats in one atomic batch
/projects/{projectId}/licenses/{licenseId}/bulk-releases - POSTPreview a CSV roster
/projects/{projectId}/licenses/{licenseId}/roster-preview - GETList effective organization members
/projects/{projectId}/organizations/{organizationId}/members
Invitations
- POSTRedeem a customer invitation
/invitations/redeem - GETList customer invitations
/projects/{projectId}/licenses/{licenseId}/invitations - POSTCreate a customer invitation
/projects/{projectId}/licenses/{licenseId}/invitations - POSTRevoke a customer invitation
/projects/{projectId}/licenses/{licenseId}/invitations/{invitationId}/revoke
Access Codes
- POSTRedeem an access code
/access-codes/redeem - GETList access codes
/projects/{projectId}/licenses/{licenseId}/access-codes - POSTCreate an access code
/projects/{projectId}/licenses/{licenseId}/access-codes - GETGet access-code metadata
/projects/{projectId}/licenses/{licenseId}/access-codes/{accessCodeId} - GETList access-code redemptions
/projects/{projectId}/licenses/{licenseId}/access-codes/{accessCodeId}/redemptions - POSTRevoke an access code
/projects/{projectId}/licenses/{licenseId}/access-codes/{accessCodeId}/revoke
Organization Admins
- POSTAccept an organization-admin invitation
/organization-admin/invitations/accept - GETList organization-admin invitations
/projects/{projectId}/organizations/{organizationId}/admin-invitations - POSTInvite an organization administrator
/projects/{projectId}/organizations/{organizationId}/admin-invitations - POSTRevoke an organization-admin invitation
/projects/{projectId}/organizations/{organizationId}/admin-invitations/{invitationId}/revoke - GETList organization administrators
/projects/{projectId}/organizations/{organizationId}/admins - DELETERemove an organization administrator
/projects/{projectId}/organizations/{organizationId}/admins/{userId}
Portal
- GETList organizations administered by the human
/portal/organizations - GETGet an administered organization
/portal/organizations/{organizationId} - GETList licenses for an administered organization
/portal/organizations/{organizationId}/licenses - GETList access codes through the portal
/portal/organizations/{organizationId}/licenses/{licenseId}/access-codes - POSTCreate an access code through the portal
/portal/organizations/{organizationId}/licenses/{licenseId}/access-codes - GETGet access-code metadata through the portal
/portal/organizations/{organizationId}/licenses/{licenseId}/access-codes/{accessCodeId} - GETList access-code redemptions through the portal
/portal/organizations/{organizationId}/licenses/{licenseId}/access-codes/{accessCodeId}/redemptions - POSTRevoke an access code through the portal
/portal/organizations/{organizationId}/licenses/{licenseId}/access-codes/{accessCodeId}/revoke - GETList assignments for an administered license
/portal/organizations/{organizationId}/licenses/{licenseId}/assignments - DELETERelease a seat from an administered license
/portal/organizations/{organizationId}/licenses/{licenseId}/assignments/{assignmentId} - GETList customer invitations through the portal
/portal/organizations/{organizationId}/licenses/{licenseId}/invitations - POSTCreate a customer invitation through the portal
/portal/organizations/{organizationId}/licenses/{licenseId}/invitations - POSTRevoke a customer invitation through the portal
/portal/organizations/{organizationId}/licenses/{licenseId}/invitations/{invitationId}/revoke - GETList members of an administered organization
/portal/organizations/{organizationId}/members
API Keys
Webhooks
- GETList webhook deliveries
/projects/{projectId}/webhook-deliveries - GETGet webhook-delivery diagnostics
/projects/{projectId}/webhook-deliveries/{deliveryId} - POSTRetry a failed webhook delivery
/projects/{projectId}/webhook-deliveries/{deliveryId}/retry - GETList webhook endpoints
/projects/{projectId}/webhook-endpoints - POSTCreate a webhook endpoint
/projects/{projectId}/webhook-endpoints - POSTDisable a webhook endpoint
/projects/{projectId}/webhook-endpoints/{webhookEndpointId}/disable
Audit
Customer Payments
- GETRead optional merchant connection status
/accounts/{accountId}/customer-payments - GETBrowse one page or an exact merchant Customer or fixed Price
/accounts/{accountId}/customer-payments/catalog - POSTCreate a Customer in the authorized merchant account
/accounts/{accountId}/customer-payments/customers - POSTIssue a fresh single-use hosted onboarding link
/accounts/{accountId}/customer-payments/onboarding-link - POSTPause renewal synchronization; Stripe may continue billing
/accounts/{accountId}/customer-payments/pause - POSTCreate a fixed Price with a customer-visible product name
/accounts/{accountId}/customer-payments/prices - POSTRetrieve canonical capability and requirements status
/accounts/{accountId}/customer-payments/refresh - POSTResume the same merchant; disabled bindings require explicit resume
/accounts/{accountId}/customer-payments/resume - POSTDurably provision one merchant; replay contains no onboarding link
/accounts/{accountId}/customer-payments/setup - POSTDurably accept a signed connected-merchant Stripe event
/customer-payments/stripe/webhook - POSTDurably accept a signed Accounts v2 thin notification
/customer-payments/stripe/webhook/account-events - GETRead payment facts separately from License fulfillment
/projects/{projectId}/licenses/{licenseId}/payments - POSTDisable automatic renewal without cancelling the Stripe subscription
/projects/{projectId}/licenses/{licenseId}/payments/bindings/{sourceId}/disable - POSTReconcile canonical settled coverage without creating a charge
/projects/{projectId}/licenses/{licenseId}/payments/bindings/{sourceId}/reconcile - POSTResume a known Checkout-created binding after canonical verification
/projects/{projectId}/licenses/{licenseId}/payments/bindings/{sourceId}/resume - POSTCreate hosted one-off or recurring direct-charge Checkout
/projects/{projectId}/licenses/{licenseId}/payments/requests - POSTRecover canonical Checkout and settlement without creating a charge
/projects/{projectId}/licenses/{licenseId}/payments/requests/{sourceId}/reconcile
Accounts
Billing
- GETGet account billing and organization-user usage
/accounts/{accountId}/billing - POSTStart a self-service Stripe subscription Checkout
/accounts/{accountId}/billing/checkout - POSTOpen the Stripe Billing Portal
/accounts/{accountId}/billing/portal - GETList the public BusinessMode plan catalog
/billing/plans - POSTReceive a signed Stripe subscription callback
/stripe/webhook
Privacy
- GETRead your privacy requests and account ownership
/privacy - POSTCreate a private download link for your own export
/privacy/exports/{requestId}/download - POSTTransfer your ownership to another account member
/privacy/ownership/transfer - POSTRequest a personal export, profile deletion or account deletion
/privacy/requests
Trust
- DELETEDelete your review and avatar
/reviews/me - GETRead your account-level review
/reviews/me - POSTSubmit or edit your review
/reviews/me - POSTWithdraw public review consent
/reviews/me/withdraw - GETReview the moderation queue
/reviews/moderation - PATCHApprove, reject or unpublish a review
/reviews/moderation/{reviewId} - GETRead public-safe usage aggregates
/trust/metrics - GETRead an approved review avatar
/trust/review-avatars/{avatarId} - GETRead consented and moderated reviews
/trust/reviews