LogoLogo
Using BunnyDeveloper
  • Overview
  • Integration points
  • Using the GraphQL API
    • New to GraphQL?
    • Using the API
    • Queries
      • account
      • accountBalance
      • accountBalances
      • accountType
      • accountTypes
      • accountingTable
      • accounts
      • apiClient
      • apiClients
      • approvalRule
      • approvalRules
      • approver
      • approvers
      • billRun
      • billRuns
      • billingDetails
      • campaign
      • campaigns
      • company
      • contact
      • contacts
      • coupon
      • coupons
      • creditNote
      • creditNoteItem
      • creditNoteItems
      • creditNotes
      • currencies
      • currency
      • currentUser
      • deal
      • dealStage
      • dealStages
      • deals
      • deepEvents
      • disputeReason
      • disputeReasons
      • draftCreditNotes
      • draftInvoices
      • email
      • emails
      • enabledOnlyForUsers
      • entities
      • entity
      • entityBranding
      • event
      • eventDetails
      • events
      • feature
      • featureUsage
      • featureUsageHistogram
      • featureUsages
      • features
      • field
      • fields
      • financialAccount
      • financialAccounts
      • formattedCreditNote
      • formattedInvoice
      • formattedQuote
      • group
      • groups
      • industries
      • industry
      • intracomVats
      • invoice
      • invoiceItem
      • invoiceItems
      • invoiceTemplate
      • invoiceTemplates
      • invoices
      • isolateTos
      • job
      • jobs
      • journalEntries
      • journalEntry
      • journalEntryLine
      • journalEntryLines
      • lead
      • leadSource
      • leadSources
      • leadStatus
      • leadStatuses
      • leads
      • monthlyReport
      • notification
      • notifications
      • owners
      • payment
      • paymentApplication
      • paymentApplications
      • paymentMethod
      • paymentMethods
      • paymentPlugins
      • payments
      • period
      • periods
      • plan
      • planChangeOptions
      • planFeature
      • planFeatures
      • plans
      • platform
      • platforms
      • plugin
      • pluginDefinition
      • pluginDefinitions
      • pluginEntities
      • pluginEntity
      • pluginParameter
      • pluginParameters
      • pluginVendor
      • pluginVendors
      • plugins
      • priceList
      • priceListChangeOptions
      • priceListCharge
      • priceListChargeOptions
      • priceListCharges
      • priceLists
      • product
      • productCategories
      • productCategory
      • products
      • quote
      • quoteChange
      • quoteChanges
      • quoteCharge
      • quoteCharges
      • quotes
      • recurringRevenue
      • recurringRevenues
      • revenueMovement
      • revenueMovements
      • revenueRecognitionExport
      • revenueRecognitionTable
      • role
      • roleScopes
      • roles
      • search
      • subscription
      • subscriptionCharge
      • subscriptionCharges
      • subscriptionFeatures
      • subscriptions
      • taxationEntityUseCodes
      • template
      • templates
      • tenant
      • tenantProvisioningChange
      • tenantProvisioningChanges
      • tenants
      • transaction
      • transactions
      • user
      • users
      • validCoupon
      • view
      • views
      • webhookEvent
      • webhookEvents
      • workflow
      • workflowActions
      • workflowCategories
      • workflowCategory
      • workflowJobLog
      • workflowJobLogs
      • workflows
    • Query filters
    • Mutations
      • accountCreate
      • accountDelete
      • accountReset
      • accountSignup
      • accountUpdate
      • accountValidateAddress
      • apiAccessTokenCreate
      • apiClientCreate
      • apiClientDelete
      • apiClientSecretRenew
      • apiClientUpdate
      • approvalRuleCreate
      • approvalRuleDelete
      • approvalRuleUpdate
      • approverCreate
      • approverDelete
      • approverUpdate
      • billingDetailsUpdate
      • campaignCreate
      • campaignDelete
      • campaignUpdate
      • checkout
      • companyUpdate
      • contactCreate
      • contactDelete
      • contactUpdate
      • couponCreate
      • couponDelete
      • couponUpdate
      • creditNoteApplyToInvoices
      • creditNoteCreate
      • creditNoteDelete
      • creditNoteIssue
      • creditNoteUpdate
      • creditNoteUpdateTaxes
      • currencyCreate
      • currencyUpdate
      • currentUserUpdate
      • dealCreate
      • dealDelete
      • dealStageCreate
      • dealStageDelete
      • dealStageUpdate
      • dealUpdate
      • demoDataCreate
      • demoDataDelete
      • disputeReasonCreate
      • disputeReasonDelete
      • disputeReasonUpdate
      • emailBrandingReset
      • emailRetry
      • entityCreate
      • entityDelete
      • entityDuplicate
      • entityUpdate
      • entityValidateAddress
      • featureCreate
      • featureDelete
      • featureUpdate
      • featureUsageCreate
      • featureUsageDelete
      • featureUsageUpdate
      • fieldCreate
      • fieldDelete
      • fieldUpdate
      • financialAccountCreate
      • financialAccountDelete
      • financialAccountUpdate
      • groupCreate
      • groupDelete
      • groupUpdate
      • industryCreate
      • invoiceAddCredit
      • invoiceCredit
      • invoiceDeleteCredit
      • invoiceGenerateNextPeriod
      • invoiceRefund
      • invoiceRegenerate
      • invoiceReissue
      • invoiceRelease
      • invoiceRetryTax
      • invoiceSendEmail
      • invoiceTemplateCreate
      • invoiceTemplateDelete
      • invoiceTemplateUpdate
      • invoiceUpdate
      • invoiceUpdateComment
      • invoiceUpdateCredit
      • invoiceUpdateCredits
      • invoiceUpdateNotes
      • invoiceUpdateTaxes
      • invoiceVoid
      • invoiceWriteOff
      • leadConvert
      • leadCreate
      • leadDelete
      • leadSourceCreate
      • leadUpdate
      • legacyCreditNoteCreate
      • legacyInvoiceCreate
      • legacyPaymentCreate
      • legacyRecurringRevenueImport
      • mutationBatch
      • paymentApplyToAccount
      • paymentApplyToInvoice
      • paymentApplyToInvoices
      • paymentUnapplyFromInvoices
      • planCreate
      • planDelete
      • planDuplicate
      • planFeatureUpdate
      • planUpdate
      • platformCreate
      • platformDelete
      • platformUpdate
      • pluginCreate
      • pluginDelete
      • pluginUpdate
      • pluginValueCreate
      • pluginValueDelete
      • pluginValueUpdate
      • portalSessionCreate
      • priceListChargeCreate
      • priceListChargeDelete
      • priceListChargeUpdate
      • priceListCreate
      • priceListDelete
      • priceListDuplicate
      • priceListUpdate
      • productCategoryCreate
      • productCategoryDelete
      • productCategoryUpdate
      • productCreate
      • productDelete
      • productDuplicate
      • productImport
      • productUpdate
      • provisioningWorkflowTest
      • quoteAccept
      • quoteAccountSignup
      • quoteAddCoupon
      • quoteApplyChanges
      • quoteApplyPriceAdjustments
      • quoteApprovalCancel
      • quoteApprovalStart
      • quoteApprove
      • quoteChangeAdd
      • quoteChangeApplyPriceAdjustment
      • quoteChangeCreate
      • quoteChangeCreateRampUp
      • quoteChangeCreateRampUpPreview
      • quoteChangeDelete
      • quoteChangeDiscountCreate
      • quoteChangeRevertPriceAdjustment
      • quoteChangeUpdate
      • quoteChangeUpdateRampUp
      • quoteChargeCreate
      • quoteChargeDelete
      • quoteChargeFreeMonthsCreate
      • quoteChargeUpdate
      • quoteCompose
      • quoteCreate
      • quoteCreateWithDeal
      • quoteDelete
      • quoteDuplicate
      • quotePlanPreview
      • quotePollSigningUrl
      • quotePreview
      • quoteRecalculateTaxes
      • quoteReject
      • quoteRemoveCoupons
      • quoteSendEmail
      • quoteSigningUrlCreate
      • quoteSubscriptionReinstate
      • quoteSubscriptionRenew
      • quoteSubscriptionUpdate
      • quoteSubscriptionUpgrade
      • quoteUndo
      • quoteUnshare
      • quoteUpdate
      • roleCreate
      • roleDelete
      • roleUpdate
      • subscriptionCancel
      • subscriptionCreate
      • subscriptionDelete
      • subscriptionReinstate
      • subscriptionSetAutoRenew
      • subscriptionTenantUpdate
      • subscriptionTrialConvert
      • subscriptionTrialConvertPreview
      • subscriptionTrialExtend
      • subscriptionUpdate
      • templateUpdate
      • tenantCreate
      • tenantDelete
      • tenantMetricsUpdate
      • tenantProvisioningChangeUpdate
      • tenantUpdate
      • userCreate
      • userDelete
      • userUpdate
      • viewCreate
      • viewDelete
      • viewUpdate
      • webhookEventRetry
      • widgetTokenCreate
      • workflowCategoryCreate
      • workflowCategoryDelete
      • workflowCategoryUpdate
      • workflowCreate
      • workflowDelete
      • workflowDuplicate
      • workflowUpdate
      • workflowsDefaultCreate
    • Authorizing API requests
    • Scopes
  • Portal session token
  • Webhooks
    • Enable webhooks
    • Tenant provisioning change
    • Checkout validation
  • Bunny SDK
    • Install the SDK
    • Create a subscription
    • Track usage for billing
    • Track tenant metrics
    • Get subscription features
  • Bunny components
    • Installation
    • Components overview
  • <Signup />
  • Customer portal
    • Portal overview
    • Popup customer portal
    • Standalone customer portal
    • Signup page
  • Sample SaaS App
    • See how it's done
  • API Reference
    • Queries
      • account
      • accountBalance
      • accountBalances
      • accountType
      • accountTypes
      • accountingTable
      • accounts
      • apiClient
      • apiClients
      • approvalRule
      • approvalRules
      • approver
      • approvers
      • billRun
      • billRuns
      • billingDetails
      • campaign
      • campaigns
      • company
      • contact
      • contacts
      • coupon
      • coupons
      • creditNote
      • creditNoteItem
      • creditNoteItems
      • creditNotes
      • currencies
      • currency
      • currentUser
      • deal
      • dealStage
      • dealStages
      • deals
      • deepEvents
      • disputeReason
      • disputeReasons
      • draftCreditNotes
      • draftInvoices
      • email
      • emails
      • enabledOnlyForUsers
      • entities
      • entity
      • entityBranding
      • event
      • eventDetails
      • events
      • feature
      • featureUsage
      • featureUsageHistogram
      • featureUsages
      • features
      • field
      • fields
      • financialAccount
      • financialAccounts
      • formattedCreditNote
      • formattedInvoice
      • formattedQuote
      • group
      • groups
      • industries
      • industry
      • intracomVats
      • invoice
      • invoiceItem
      • invoiceItems
      • invoiceTemplate
      • invoiceTemplates
      • invoices
      • isolateTos
      • job
      • jobs
      • journalEntries
      • journalEntry
      • journalEntryLine
      • journalEntryLines
      • lead
      • leadSource
      • leadSources
      • leadStatus
      • leadStatuses
      • leads
      • monthlyReport
      • notification
      • notifications
      • owners
      • payment
      • paymentApplication
      • paymentApplications
      • paymentMethod
      • paymentMethods
      • paymentPlugins
      • payments
      • period
      • periods
      • plan
      • planChangeOptions
      • planFeature
      • planFeatures
      • plans
      • platform
      • platforms
      • plugin
      • pluginDefinition
      • pluginDefinitions
      • pluginEntities
      • pluginEntity
      • pluginParameter
      • pluginParameters
      • pluginVendor
      • pluginVendors
      • plugins
      • priceList
      • priceListChangeOptions
      • priceListCharge
      • priceListChargeOptions
      • priceListCharges
      • priceLists
      • product
      • productCategories
      • productCategory
      • products
      • quote
      • quoteChange
      • quoteChanges
      • quoteCharge
      • quoteCharges
      • quotes
      • recurringRevenue
      • recurringRevenues
      • revenueMovement
      • revenueMovements
      • revenueRecognitionExport
      • revenueRecognitionTable
      • role
      • roleScopes
      • roles
      • search
      • subscription
      • subscriptionCharge
      • subscriptionCharges
      • subscriptionFeatures
      • subscriptions
      • taxationEntityUseCodes
      • template
      • templates
      • tenant
      • tenantProvisioningChange
      • tenantProvisioningChanges
      • tenants
      • transaction
      • transactions
      • user
      • users
      • validCoupon
      • view
      • views
      • webhookEvent
      • webhookEvents
      • workflow
      • workflowActions
      • workflowCategories
      • workflowCategory
      • workflowJobLog
      • workflowJobLogs
      • workflows
    • Mutations
      • accountCreate
      • accountDelete
      • accountReset
      • accountSignup
      • accountUpdate
      • accountValidateAddress
      • apiAccessTokenCreate
      • apiClientCreate
      • apiClientDelete
      • apiClientSecretRenew
      • apiClientUpdate
      • approvalRuleCreate
      • approvalRuleDelete
      • approvalRuleUpdate
      • approverCreate
      • approverDelete
      • approverUpdate
      • billingDetailsUpdate
      • campaignCreate
      • campaignDelete
      • campaignUpdate
      • checkout
      • companyUpdate
      • contactCreate
      • contactDelete
      • contactUpdate
      • couponCreate
      • couponDelete
      • couponUpdate
      • creditNoteApplyToInvoices
      • creditNoteCreate
      • creditNoteDelete
      • creditNoteIssue
      • creditNoteUpdate
      • creditNoteUpdateTaxes
      • currencyCreate
      • currencyUpdate
      • currentUserUpdate
      • dealCreate
      • dealDelete
      • dealStageCreate
      • dealStageDelete
      • dealStageUpdate
      • dealUpdate
      • demoDataCreate
      • demoDataDelete
      • disputeReasonCreate
      • disputeReasonDelete
      • disputeReasonUpdate
      • emailBrandingReset
      • emailRetry
      • entityCreate
      • entityDelete
      • entityDuplicate
      • entityUpdate
      • entityValidateAddress
      • featureCreate
      • featureDelete
      • featureUpdate
      • featureUsageCreate
      • featureUsageDelete
      • featureUsageUpdate
      • fieldCreate
      • fieldDelete
      • fieldUpdate
      • financialAccountCreate
      • financialAccountDelete
      • financialAccountUpdate
      • groupCreate
      • groupDelete
      • groupUpdate
      • industryCreate
      • invoiceAddCredit
      • invoiceCredit
      • invoiceDeleteCredit
      • invoiceGenerateNextPeriod
      • invoiceRefund
      • invoiceRegenerate
      • invoiceReissue
      • invoiceRelease
      • invoiceRetryTax
      • invoiceSendEmail
      • invoiceTemplateCreate
      • invoiceTemplateDelete
      • invoiceTemplateUpdate
      • invoiceUpdate
      • invoiceUpdateComment
      • invoiceUpdateCredit
      • invoiceUpdateCredits
      • invoiceUpdateNotes
      • invoiceUpdateTaxes
      • invoiceVoid
      • invoiceWriteOff
      • leadConvert
      • leadCreate
      • leadDelete
      • leadSourceCreate
      • leadUpdate
      • legacyCreditNoteCreate
      • legacyInvoiceCreate
      • legacyPaymentCreate
      • legacyRecurringRevenueImport
      • mutationBatch
      • paymentApplyToAccount
      • paymentApplyToInvoice
      • paymentApplyToInvoices
      • paymentUnapplyFromInvoices
      • planCreate
      • planDelete
      • planDuplicate
      • planFeatureUpdate
      • planUpdate
      • platformCreate
      • platformDelete
      • platformUpdate
      • pluginCreate
      • pluginDelete
      • pluginUpdate
      • pluginValueCreate
      • pluginValueDelete
      • pluginValueUpdate
      • portalSessionCreate
      • priceListChargeCreate
      • priceListChargeDelete
      • priceListChargeUpdate
      • priceListCreate
      • priceListDelete
      • priceListDuplicate
      • priceListUpdate
      • productCategoryCreate
      • productCategoryDelete
      • productCategoryUpdate
      • productCreate
      • productDelete
      • productDuplicate
      • productImport
      • productUpdate
      • provisioningWorkflowTest
      • quoteAccept
      • quoteAccountSignup
      • quoteAddCoupon
      • quoteApplyChanges
      • quoteApplyPriceAdjustments
      • quoteApprovalCancel
      • quoteApprovalStart
      • quoteApprove
      • quoteChangeAdd
      • quoteChangeApplyPriceAdjustment
      • quoteChangeCreate
      • quoteChangeCreateRampUp
      • quoteChangeCreateRampUpPreview
      • quoteChangeDelete
      • quoteChangeDiscountCreate
      • quoteChangeRevertPriceAdjustment
      • quoteChangeUpdate
      • quoteChangeUpdateRampUp
      • quoteChargeCreate
      • quoteChargeDelete
      • quoteChargeFreeMonthsCreate
      • quoteChargeUpdate
      • quoteCompose
      • quoteCreate
      • quoteCreateWithDeal
      • quoteDelete
      • quoteDuplicate
      • quotePlanPreview
      • quotePollSigningUrl
      • quotePreview
      • quoteRecalculateTaxes
      • quoteReject
      • quoteRemoveCoupons
      • quoteSendEmail
      • quoteSigningUrlCreate
      • quoteSubscriptionReinstate
      • quoteSubscriptionRenew
      • quoteSubscriptionUpdate
      • quoteSubscriptionUpgrade
      • quoteUndo
      • quoteUnshare
      • quoteUpdate
      • roleCreate
      • roleDelete
      • roleUpdate
      • subscriptionCancel
      • subscriptionCreate
      • subscriptionDelete
      • subscriptionReinstate
      • subscriptionSetAutoRenew
      • subscriptionTenantUpdate
      • subscriptionTrialConvert
      • subscriptionTrialConvertPreview
      • subscriptionTrialExtend
      • subscriptionUpdate
      • templateUpdate
      • tenantCreate
      • tenantDelete
      • tenantMetricsUpdate
      • tenantProvisioningChangeUpdate
      • tenantUpdate
      • userCreate
      • userDelete
      • userUpdate
      • viewCreate
      • viewDelete
      • viewUpdate
      • webhookEventRetry
      • widgetTokenCreate
      • workflowCategoryCreate
      • workflowCategoryDelete
      • workflowCategoryUpdate
      • workflowCreate
      • workflowDelete
      • workflowDuplicate
      • workflowUpdate
      • workflowsDefaultCreate
    • Types
      • Account
      • AccountAttributes
      • AccountBalance
      • AccountBalanceConnection
      • AccountBalanceEdge
      • AccountConnection
      • AccountEdge
      • AccountType
      • AccountTypeConnection
      • AccountTypeEdge
      • AccountingTable
      • AccountingTableCell
      • AccountingTableRow
      • ApiClient
      • ApiClientAttributes
      • ApiClientConnection
      • ApiClientEdge
      • ApprovalDecision
      • ApprovalRequest
      • ApprovalRule
      • ApprovalRuleAttributes
      • ApprovalRuleConnection
      • ApprovalRuleEdge
      • Approver
      • ApproverAttributes
      • ApproverConnection
      • ApproverEdge
      • Attachment
      • BatchMutation
      • BatchMutationAttributes
      • BillRun
      • BillRunConnection
      • BillRunEdge
      • BillingCycle
      • BillingDetails
      • BillingDetailsAttributes
      • BillingPeriodAmount
      • Campaign
      • CampaignAttributes
      • CampaignConnection
      • CampaignEdge
      • CheckoutPaymentMethodAttributes
      • Company
      • CompanyAttributes
      • Contact
      • ContactAttributes
      • ContactConnection
      • ContactEdge
      • Coupon
      • CouponAttributes
      • CouponConnection
      • CouponEdge
      • CouponValidate
      • CreditItemAttributes
      • CreditNote
      • CreditNoteAttributes
      • CreditNoteConnection
      • CreditNoteEdge
      • CreditNoteItem
      • CreditNoteItemAttributes
      • CreditNoteItemConnection
      • CreditNoteItemEdge
      • Currency
      • CurrencyAttributes
      • CurrencyConnection
      • CurrencyEdge
      • CurrentUser
      • CurrentUserAttributes
      • DateOption
      • Deal
      • DealAttributes
      • DealConnection
      • DealEdge
      • DealStage
      • DealStageAttributes
      • DealStageConnection
      • DealStageEdge
      • DisputeReason
      • DisputeReasonAttributes
      • DisputeReasonConnection
      • DisputeReasonEdge
      • Document
      • DynamicComponentAttributes
      • Email
      • EmailConnection
      • EmailEdge
      • EmailRecipient
      • Entity
      • EntityAttributes
      • EntityBranding
      • EntityConnection
      • EntityEdge
      • Event
      • EventConnection
      • EventDetail
      • EventDetailChange
      • EventDetailItem
      • EventEdge
      • Feature
      • FeatureAttributes
      • FeatureConnection
      • FeatureEdge
      • FeatureUsage
      • FeatureUsageAttributes
      • FeatureUsageConnection
      • FeatureUsageEdge
      • Field
      • FieldAttributes
      • FieldConnection
      • FieldEdge
      • FieldValue
      • FinancialAccount
      • FinancialAccountAttributes
      • FinancialAccountConnection
      • FinancialAccountEdge
      • FormattedChargePriceTier
      • FormattedCreditNote
      • FormattedInvoice
      • FormattedLine
      • FormattedQuote
      • Group
      • GroupAttributes
      • GroupConnection
      • GroupEdge
      • Histogram
      • HistogramData
      • HistogramDataInterval
      • Industry
      • IndustryAttributes
      • IndustryConnection
      • IndustryEdge
      • IntracomVat
      • IntracomVatConnection
      • IntracomVatEdge
      • Invoice
      • InvoiceAttributes
      • InvoiceConnection
      • InvoiceEdge
      • InvoiceItem
      • InvoiceItemConnection
      • InvoiceItemEdge
      • InvoiceMessage
      • InvoiceTemplate
      • InvoiceTemplateAttributes
      • InvoiceTemplateConnection
      • InvoiceTemplateEdge
      • InvoiceUpdateCreditsAttributes
      • Job
      • JobConnection
      • JobEdge
      • JournalEntry
      • JournalEntryConnection
      • JournalEntryEdge
      • JournalEntryLine
      • JournalEntryLineConnection
      • JournalEntryLineEdge
      • Lead
      • LeadAttributes
      • LeadConnection
      • LeadEdge
      • LeadSource
      • LeadSourceAttributes
      • LeadSourceConnection
      • LeadSourceEdge
      • LeadStatus
      • LeadStatusConnection
      • LeadStatusEdge
      • LegacyCreditNoteAttributes
      • LegacyInvoiceAttributes
      • Macro
      • Method
      • MonthlyReport
      • MonthlyReportAccount
      • MonthlyReportCategory
      • NotificationConnection
      • NotificationEdge
      • Output
      • PageInfo
      • Payment
      • PaymentApplication
      • PaymentApplicationConnection
      • PaymentApplicationEdge
      • PaymentAttributes
      • PaymentConnection
      • PaymentEdge
      • PaymentMethod
      • PaymentMethodConnection
      • PaymentMethodEdge
      • PaymentMethodMetadata
      • PaymentPlugin
      • Period
      • PeriodAmount
      • PeriodConnection
      • PeriodEdge
      • Plan
      • PlanAttributes
      • PlanChangeOptions
      • PlanConnection
      • PlanEdge
      • PlanFeature
      • PlanFeatureAttributes
      • PlanFeatureConnection
      • PlanFeatureEdge
      • Platform
      • PlatformAttributes
      • PlatformConnection
      • PlatformEdge
      • Plugin
      • PluginActionMenuItem
      • PluginAttributes
      • PluginConnection
      • PluginDefinition
      • PluginDefinitionConnection
      • PluginDefinitionEdge
      • PluginEdge
      • PluginEntity
      • PluginEntityConnection
      • PluginEntityEdge
      • PluginParameter
      • PluginParameterConnection
      • PluginParameterEdge
      • PluginValue
      • PluginValueAttributes
      • PluginVendor
      • PluginVendorConnection
      • PluginVendorEdge
      • PriceList
      • PriceListAttributes
      • PriceListChangeOptions
      • PriceListCharge
      • PriceListChargeAttributes
      • PriceListChargeConnection
      • PriceListChargeDefault
      • PriceListChargeEdge
      • PriceListChargeOptions
      • PriceListChargeTier
      • PriceListChargeTierAttributes
      • PriceListConnection
      • PriceListEdge
      • Product
      • ProductAttributes
      • ProductCategory
      • ProductCategoryAttributes
      • ProductCategoryConnection
      • ProductCategoryEdge
      • ProductConnection
      • ProductEdge
      • Quote
      • QuoteAttributes
      • QuoteChange
      • QuoteChangeConnection
      • QuoteChangeEdge
      • QuoteCharge
      • QuoteChargeAttributes
      • QuoteChargeConnection
      • QuoteChargeEdge
      • QuoteConnection
      • QuoteEdge
      • QuoteLine
      • QuotePlan
      • QuotePlanPreview
      • QuotePriceTier
      • QuotePriceTierAttributes
      • RecurringRevenue
      • RecurringRevenueConnection
      • RecurringRevenueEdge
      • RelatedObject
      • RenewalTermOption
      • RevenueMovement
      • RevenueMovementConnection
      • RevenueMovementEdge
      • RevenueRecognitionAccount
      • RevenueRecognitionDateLabel
      • RevenueRecognitionDocument
      • RevenueRecognitionExport
      • RevenueRecognitionExportRow
      • RevenueRecognitionItem
      • RevenueRecognitionMonths
      • RevenueRecognitionTable
      • Role
      • RoleAttributes
      • RoleConnection
      • RoleEdge
      • RoleScope
      • RoleScopeConnection
      • RoleScopeEdge
      • SearchResult
      • Subscription
      • SubscriptionAttributes
      • SubscriptionCharge
      • SubscriptionChargeConnection
      • SubscriptionChargeEdge
      • SubscriptionConnection
      • SubscriptionEdge
      • SubscriptionPriceTier
      • SubscriptionTenantUpdateAttributes
      • SubscriptionTieredPrice
      • TaxationEntityUseCode
      • Template
      • TemplateAttributes
      • TemplateConnection
      • TemplateEdge
      • Tenant
      • TenantAttributes
      • TenantConnection
      • TenantEdge
      • TenantMetricsAttributes
      • TenantProvisioningChange
      • TenantProvisioningChangeAttributes
      • TenantProvisioningChangeConnection
      • TenantProvisioningChangeEdge
      • TieredAmount
      • Transaction
      • TransactionConnection
      • TransactionEdge
      • UsageSubscriptionCharge
      • UsageSubscriptionChargeConnection
      • UsageSubscriptionChargeEdge
      • User
      • UserAttributes
      • UserConnection
      • UserEdge
      • UserProfile
      • UserProfileAttributes
      • View
      • ViewAttributes
      • ViewConnection
      • ViewEdge
      • WebPushAttributes
      • WebhookEvent
      • WebhookEventConnection
      • WebhookEventEdge
      • Workflow
      • WorkflowAction
      • WorkflowAttributes
      • WorkflowCategory
      • WorkflowCategoryAttributes
      • WorkflowCategoryConnection
      • WorkflowCategoryEdge
      • WorkflowConnection
      • WorkflowEdge
      • WorkflowJobLog
      • WorkflowJobLogConnection
      • WorkflowJobLogEdge
    • Enums
Powered by GitBook
On this page
  • Setting it up
  • Configure a new platform in Bunny
  • Configure a new product in Bunny
  • Configure an API key
  • Install and configure the Sample SaaS app

Was this helpful?

Edit on GitHub
  1. Sample SaaS App

See how it's done

To demonstrate integrating your SaaS application with Bunny, we provide a sample SaaS application written in Node.JS. This page will cover installation and configuration as well as next steps.

PreviousSignup pageNextQueries

Last updated 1 month ago

Was this helpful?

The Sample Saas application demonstrates the following integration features:

  • Generating a new account and contact in Bunny based on signups to your app.

  • Controlling features and limits in the SaaS app based on subscriptions in Bunny.

  • Self-service upgrade and payment through the Bunny portal.

The Sample SaaS App is a multi-tenant note taking app. The app relies on Bunny to control how many notes can be stored in each tenant. For the sake of simplicity, users are not prompted for a password when signing into the account.

Setting it up

Configure a new platform in Bunny

A platform in Bunny holds the integration settings for your SaaS product, such as webhook URLs, tokens and signing keys.

Since we will later install and run the Sample SaaS App locally, and Bunny will need access to it's API, we suggest installing or similar to fascilitate routing the traffic to your local app. Launch ngrok with the following command to setup a tunnel:

ngrok http 3030

  1. In Products -> Platforms click New Platform.

  2. Configure it as following:

    1. Make sure to choose your own signing key.

    2. Copy the ngrok forwarding URL to the webhook URL field: https://{your ngrok forwarding URL}/api/hook

Configure a new product in Bunny

When you sign up for your Bunny account, it will be preloaded with demo data (accounts, contacts, products, deals etc). This can be removed by going to Other -> Settings and clicking Remove demo data in the sidebar.

  1. Setup a new product in your Bunny account. Your trial account may already have a default one with your company name. Note: It's important to select the platform created in the previous step.

  2. Create a new feature called "Notes". Use the following settings:

  3. On the Plans and Add-Ons tab, create a new plan named "Basic". Enable Self-service purchase.

  4. Hit Save.

  5. In the Plan features section, add the newly created feature to the plan.

  6. On the Price Lists tab, create a new price list named "Monthly":

  7. Create a new Price List Charge with the following settings:

Configure an API key

  1. Go to Other -> API Clients and click New API Client

  2. Use the following settings:

Install and configure the Sample SaaS app

  1. In a suitable folder on your local environment, clone the Sample SaaS repository: git clone git@github.com:bunnyapp/sample-saas.git

  2. Copy .env.example to .env and open the .env file in an editor.

  3. Replace {subdomain} with the subdomain of your Bunny account.

  4. Replace {access_token} with the access token generated when configuring the API Client earlier.

  5. Replace {webhook_signing_token} with the Webhook signing key chosen when configuring the platform earlier.

  6. Replace {price_list_code} with the code from the price list created earlier - notes_monthly

  7. Your .env file should look something like this:

  8. In a Terminal, start the app with the following command: docker-compose up

You're all set! Navigate to http://localhost:3030 to sign up for your Sample SaaS Notes app account.

The Sample SaaS app runs in Docker, so ensure you have Docker Desktop installed and running. You can download it from .

here
ngrok