Skip to main content

Getting Started

Getting started with BillaBear is meant to be easy.

Support

Firstly, if you're struggling at all please reach out and we'll help you.

You can get support from:

Setting Up Application

We've documented various ways of setting up the application. You can read how to in the Install Docs.

API

There are many features you will want to use if you're building a SaaS where the subscriptions are managed by BillaBear.

The API is available in the routes /api/v1.

Create Customer

You want to need to register a customer with BillBear. This should probably be done on registration - however this is up to you.

To do this is you use the POST /api/v1/customer endpoint.

Add Payment Card - Stripe.JS

To add the a payment card via the Stripe.js library. You fetch the token required for it via the API and then send the response you get from Stripe to the API.

To get the token you use GET /api/v1/customer/{customerId}/payment-details/frontend-payment-token

To save the payment details you use POST /api/v1/customer/{customerId}/payment-details/frontend-payment-token

Fetch Customer limits

You can fetch limits based on the plans GET /api/v1/customer/{customerId}/limits

Fetch Prices

To show prices that are managed by BillaBear GET /api/v1/product/{productId}/price

To List Products

To show products that are managed by BillaBear GET /api/v1/product

Create Subscription

To create a subscription you can use GET /api/v1/customer/{customerId}/subscription/start

Rest of the functionality

Check out https://swagger.billabear.com.

Request functionality

You can request a feature via https://github.com/billabear/billabear/discussions/categories/ideas