Roles & PermissionsPermission Matrix

Permission Matrix

This page provides the complete access matrix for all BillHive resources, scopes, and roles. Use this as a reference when deciding which role to assign to a team member.

Resource Access by Role

The table below shows which roles have access to each resource. Access is granted at the resource level — if a role has access to a resource, it can perform all scopes (actions) on that resource.

ResourceOwnerAdministratorCSMFinance ManagerPricing StrategistSupport Agent
AccountXXXX-X
AddonXX--X-
AnalyticsXX-XX-
API KeyXX----
ChargeXX--X-
ContactXXX--X
InvoiceXX-X-X
NotificationXXX--X
OfferXX--X-
OrderXXX---
PaymentXX-X--
Payment GatewayXX-X--
ProductXX--X-
Rate PlanXX--X-
SubscriptionXXXX-X
TemplateXX----
ThemeXX--X-
UserXX----
WebhookXX----

Legend: X = Full access, - = No access

Resource Scopes (Detailed)

Each resource has specific scopes (actions). When a role has access to a resource, it can perform all scopes listed below.

Account (8 scopes)

ScopeDescription
Account.findList and search customer accounts
Account.findByIdView a specific customer account
Account.createCreate a new customer account
Account.updateByIdUpdate customer account details
Account.deleteByIdDelete a customer account
Account.addBillingAddressAdd billing address to an account
Account.getBillingAddressesView billing addresses
Account.createPaymentMethodAdd a payment method to an account

Addon (11 scopes)

ScopeDescription
Addon.findAllList all addons
Addon.findByIdView a specific addon
Addon.createCreate a new addon
Addon.updateByIdUpdate addon details
Addon.deleteByIdDelete an addon
Addon.deactivateByIdDeactivate an addon
Addon.createPriceCreate a price for an addon
Addon.findAllAddonPricesList all addon prices
Addon.findAllPricesByIdView prices for a specific addon
Addon.findPriceByIdView a specific addon price
Addon.activatePriceByIdActivate an addon price
Addon.deactivatePriceByIdDeactivate an addon price

Analytics (7 scopes)

ScopeDescription
Analytics.annualRecurringRevenueView ARR metrics
Analytics.paymentSuccessRateView payment success/failure rates
Analytics.subscriptionChangeView subscription change metrics
Analytics.subscriptionRenewalRateView renewal rate metrics
Analytics.subscriptionStatusBreakdownView subscription status distribution
Analytics.trialConversionRateView trial-to-paid conversion metrics
Analytics.reportByQuestionTypeGenerate reports by question type

API Key (5 scopes)

ScopeDescription
ApiKey.findAllList all API keys
ApiKey.findAllPermissionsView API key permissions
ApiKey.createCreate a new API key
ApiKey.deleteByIdDelete an API key
ApiKey.refreshApiKeyRegenerate an API key

Charge (15 scopes)

ScopeDescription
Charge.findSearch charges
Charge.findAllList all charges
Charge.findByIdView a specific charge
Charge.createCreate a new charge
Charge.updateByIdUpdate charge details
Charge.deleteByIdDelete a charge
Charge.deactivateByIdDeactivate a charge
Charge.createPriceCreate a price for a charge
Charge.findAllPricesList all charge prices
Charge.findAllPricesByIdView prices for a specific charge
Charge.findPriceByIdView a specific charge price
Charge.updatePriceByPriceIdUpdate a charge price
Charge.activatePriceByIdActivate a charge price
Charge.deactivatePriceByIdDeactivate a charge price

Contact (4 scopes)

ScopeDescription
Contact.findList and search contacts
Contact.createCreate a new contact
Contact.updateUpdate contact details
Contact.deleteByIdDelete a contact

Invoice (7 scopes)

ScopeDescription
Invoice.findList and search invoices
Invoice.findByIdView a specific invoice
Invoice.CreateCreate a new invoice
Invoice.deleteByIdDelete an invoice
Invoice.generateGenerate an invoice
Invoice.downloadByInvoiceIdDownload invoice PDF
Invoice.InvoiceItem.findByInvoiceIdView line items for an invoice

Notification (4 scopes)

ScopeDescription
Notification.findList notifications
Notification.sendSend a notification
Notification.getEmailPreferencesView email preference settings
Notification.updateEmailPreferenceByTypeUpdate email preferences

Offer (10 scopes)

ScopeDescription
Offer.findAllList all offers
Offer.findByIdView a specific offer
Offer.createCreate a new offer
Offer.updateByIdUpdate offer details
Offer.deleteByIdDelete an offer
Offer.activateOfferByIdActivate an offer
Offer.deactivateOfferByIdDeactivate an offer
Offer.findAllOfferLinksList offer links
Offer.offerLinkByIdView a specific offer link
Offer.getApplicableOffersGet offers applicable to a subscription

Order (4 scopes)

ScopeDescription
Order.findList and search orders
Order.findByIdView a specific order
Order.createCreate a new order
Order.estimateGenerate an order estimate

Payment (1 scope)

ScopeDescription
Payment.Mandate.findList and view payment mandates

Payment Gateway (2 scopes)

ScopeDescription
PaymentGateway.createMerchantCreate a merchant account on a gateway
PaymentGateway.getMerchantOnboardingLinkGet gateway onboarding link

Product (8 scopes)

ScopeDescription
Product.findList and search products
Product.findByIdView a specific product
Product.createCreate a new product
Product.updateByIdUpdate product details
Product.deleteByIdDelete a product
Product.launchLaunch a product
Product.findAllPricesByIdView prices for a product
Product.getPricingTableView the pricing table for a product

Rate Plan (18 scopes)

ScopeDescription
RatePlan.findAllList all rate plans
RatePlan.findByIdView a specific rate plan
RatePlan.createCreate a new rate plan
RatePlan.deleteByIdDelete a rate plan
RatePlan.createPriceCreate a price for a rate plan
RatePlan.findAllPricesByIdView prices for a rate plan
RatePlan.findPriceByIdView a specific rate plan price
RatePlan.getRatePlanPricesList all rate plan prices
RatePlan.activatePriceByIdActivate a rate plan price
RatePlan.deactivatePriceByIdDeactivate a rate plan price
RatePlan.attachAddonAttach an addon to a rate plan
RatePlan.attachChargeAttach a charge to a rate plan
RatePlan.getAddonsByRatePlanIdView addons for a rate plan
RatePlan.getAddonsByRatePlanPriceIdView addons for a rate plan price
RatePlan.getChargesByRatePlanIdView charges for a rate plan
RatePlan.findCouponsByRatePlanIdView coupons for a rate plan
RatePlan.RatePlanPrice.deleteByIdDelete a rate plan price

Subscription (17 scopes)

ScopeDescription
Subscription.findList and search subscriptions
Subscription.findByIdView a specific subscription
Subscription.createCreate a new subscription
Subscription.deleteDelete a subscription
Subscription.cancelCancel a subscription
Subscription.pausePause a subscription
Subscription.resumeResume a paused subscription
Subscription.renewRenew a subscription
Subscription.changePlanChange subscription plan
Subscription.changeFrequencyChange billing frequency
Subscription.addAddonAdd an addon to a subscription
Subscription.getAddonsView subscription addons
Subscription.getTermsView subscription terms
Subscription.getAuditLogView subscription audit log
Subscription.calculateCostToPayNowCalculate immediate payment amount
Subscription.findSettingsView subscription settings
Subscription.saveSettingsUpdate subscription settings

Template (4 scopes)

ScopeDescription
Template.findList and search templates
Template.findByIdView a specific template
Template.createCreate a new template
Template.updateByIdUpdate a template

Theme (5 scopes)

ScopeDescription
Theme.updateByIdUpdate theme settings
Theme.ThemeConfig.createCreate a theme configuration
Theme.ThemeConfig.findByProductIdView theme config for a product
Theme.ThemeConfig.findByProductIdCategoryView theme config by category
Theme.ThemeConfig.upsertPricingTableRatePlanConfigConfigure pricing table display

User (6 scopes)

ScopeDescription
User.findList and search users
User.findByEmailFind a user by email
User.createCreate a new user
User.updateByEmailUpdate user details
User.deleteByIdDelete a user
Role.findList available roles

Webhook (5 scopes)

ScopeDescription
Webhook.findAllList all webhooks
Webhook.findByIdView a specific webhook
Webhook.createCreate a new webhook
Webhook.updateByIdUpdate a webhook
Webhook.deleteByIdDelete a webhook