Welcome friend!

Welcome to Upodi Docs. You'll find comprehensive help, guides and developer information to help you get started with the basics and move to the advanced flows. Let's jump right in!

I am a User I am a Developer

Setting up Upodi

The first time you sign into Upodi, you will have to setup a few settings. The platform needs these settings in order to manage your customers and their subscriptions.

You will be asked for the Name and VAT of your company. In addition you need to select your Base currency and Timezone.

You can always change the settings later under Setup > General with the exception of the base currency.


Setting the base currency cannot be changed

Upodi is a multicurrency platform, in which invoice & subscription records can be associated with a currency. This currency is called the transaction currency.

Once you have defined the base currency you cannot change this setting due to the multicurrency nature of the platform.

What's Next

Once set, you will enter the welcome page of Upodi. From here the next steps are as follows:

  1. Finalizing the General Settings under Setup > General
  2. Setting up your payment infrastructure. Please read the documentation of the supported payment gateways.
  3. Setting up default dunning schemes.
  4. Adding your first product plan(s).
  5. Adding your first customer(s).
  6. Adding your first subscription(s).

Sandbox and Production mode

By default your Upodi tenant starts in Sandbox mode, a mode in which no transactions are carried through and no emails are sent to customers. This allows you to safely set up and test your Upodi system before you make the final switch into Production mode

What the Upodi client does in each mode:


Sandbox mode

Production mode


  • No emails are sent to customers, but BCC emails to main receiver (defined in general settings) are sent
  • All emails are sent

Upodi Transactions

  • Transactions are marked as successful unless a card with CVC '123' is used, which will result in a failed transaction.
  • Transactions are carried through (Authorize and instant capture).

Payment gateway

  • Transactions through a payment gateway which supports it will authorize and instantly release, which results in no payment being made.
  • Transactions are carried through (Authorize and instant capture).

ERP Systems

  • Integration to an ERP system will book invoices, create customers and send out invoices if set up in Upodi
  • Integration to an ERP system will book invoices, create customers and send out invoices if set up in Upodi

Updated 2 years ago

Setting up Upodi

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.