Octobat is a billing-as-a-service provider, which help companies to build an automatic billing flow, which includes collecting money easily, solving global tax issues and delivering tax receipts and invoices to customers.
In this section, you'll learn some basics about how to use Octobat and find resources that can help you as you work.
Octobat's automated flow relies on the Stripe payment platform. You're required to have a Stripe account to use Octobat.
To be able to automate the tax calculation and to produce worldwide compliant invoices, Octobat requires you send particular data to Stripe.
There are two ways to deal with this, the simplest one is to rely on our <checkout /> or custom forms, that replace your Stripe API calls and don't require you to code a backend to collect money. The second one, more relevant if you have particular needs, is to handle Stripe API calls on your own, and customize them in a Octobat-compliant way.
The following documentation gives you all the insights to build a proper Octobat implementation.
To use Octobat built-in components or integrations, you are required to create an account first.
When subscribing, Octobat will require read/write access to your Stripe account to be able to fetch the required data to compute tax calculations and generate/send the tax receipts and invoices. Write access will never be used to create/alter/delete data. When using Octobat built-in
When not using a direct integration, you must use an appropriate API key to fetch/create/update a resource managed by Octobat.
API keys are available for both livemode and testmode with exactly the same purpose. We strongly advise you to use testmode keys while developing your app, so when switching to production, you'll only have to change each API key to the corresponding livemode one.
Secret and publishable keys are the two ways used to identify your Octobat account. The publishable key is used to create charge and subscriptions when using Octobat built-in <checkout /> and custom forms and should be included with the HTML form. The secret key is used for all other API calls on the server-side. The secret key should never be visible by a visitor.
You can grab the test and live API keys for your account under the API Keys / Webhooks section
There are two ways to implement Stripe + Octobat to your app/website. You can use our built-in forms, or rely on your own Stripe implementation and our direct integration.