Credit top-ups (Booknetic SaaS)

On Booknetic SaaS, your tenants’ plans include a monthly allowance of SMS, WhatsApp and email messages. Credit top-ups let a tenant buy more from their own Billing page when that runs out, instead of asking you. This module only exists on Booknetic SaaS.

For you: the SaaS admin

Open the SaaS admin, Marketing. The tabs are SMS Plans, WhatsApp Plans and Email Plans (each shown only when that workflow add-on is active), Settings and Licence.

Credit packs

Add packs with ADD SMS PLAN (and the WhatsApp and Email equivalents). Each pack has:

• Plan Name, Price and the number of credits it gives;
• Credit Scope: Workflow credits (the default) for regular notifications, or Marketing credits for campaign sends when that channel is set to Dedicated (see below);
• an optional Description.

Packs are shared by all tenants. Once a pack exists, its price, credits and scope are locked, so past purchases stay accurate. You can still rename it, edit the description, or set it to Inactive.

Settings

• Channel Availability. Turn top-ups on or off per channel, and choose each channel’s campaign policy:
  • Standard workflow limits (default): campaign sends use the same allowance and credits as the tenant’s notifications.
  • Dedicated marketing credits (Campaign only): campaign sends use only purchased marketing credits.
• Widget Visibility. Choose whether the buy window shows remaining credits, each pack’s credits and the descriptions.
• Checkout Flow. Set the default payment method, and the delay before the page reloads after a successful purchase.
• Top-up Button Branding. Set the button label (default TOP-UP CREDIT) and its colour.
• Payment Methods. Choose any of Balance, Stripe (Card) and Mercado Pago.
• Currency & Price Format. Set the currency, an optional custom symbol, and the symbol’s position.
• Stripe Webhook. The webhook URL to add in Stripe (https://your-site/?booknetic_topup_action=stripe_webhook), with the checkout.session.completed event, and its signing secret.
• Mercado Pago Credentials. The access token. This needs Booknetic’s Mercado Pago payment add-on.
• WhatsApp Campaigns. The default Messaging Service SID. See Setting up the channels.

The Quick Presets (Minimal, Balanced, Sales Focus) fill in the display options for you to review. Click SAVE SETTINGS to keep any change.

Currency: the currency setting changes how prices are shown. Card and Mercado Pago payments are charged in the currency of your Booknetic SaaS payment settings, so keep the two the same.

Card payments use the Stripe keys from your Booknetic SaaS payment settings.

For your tenants

A TOP-UP CREDIT button appears on the tenant’s Billing page, with one entry per channel. A channel is offered only when all of these are true:

• top-ups are switched on for that channel;
• the tenant’s plan includes the channel’s workflow (Twilio SMS, Twilio WhatsApp or Email);
• that workflow add-on is active;
• the plan’s monthly limit for the channel isn’t unlimited, unless the channel uses the Dedicated policy;
• there is at least one active pack the tenant can buy.

The tenant picks a pack and pays:

• Pay with Balance takes the price from their account balance at once.
• Pay with Card goes to Stripe Checkout.
• Pay with Mercado Pago goes to Mercado Pago’s checkout.

Credits are added when the payment is confirmed, either on the return to Billing or by the webhook. A confirmation that arrives twice is only counted once. The tenant gets exactly the credits and price shown when they bought, even if you change the pack later.

How credits are used

Under the standard policy, every send — workflow or campaign — draws on:

1. the plan’s monthly allowance first (campaign sends count towards it just like notifications);
2. then the tenant’s purchased workflow credits;
3. and if both are gone, the message is not sent.

Under the dedicated policy, a channel’s campaign sends use only purchased marketing credits. Notifications carry on as standard.

Credits are reserved before the message goes to the provider. The reservation is kept when the provider accepts, and given back when the provider refuses outright. When the outcome is unknown, the credit stays reserved: the message may have gone, so the credit isn’t handed out a second time.

Automations

The module adds workflow events you can use in Booknetic’s Workflows:

• Credit top-up purchased. Shortcodes {topup_plan_name}, {topup_plan_type}, {topup_credits}, {topup_credit_scope}, {topup_price}, {topup_payment_method}.
• SMS credits exhausted, WhatsApp credits exhausted, Email credits exhausted. These fire when the last credit is used.

Common questions

The top-up button isn’t showing for a tenant. Go through the list under For your tenants. The most common reason is an unlimited plan: there is nothing to top up.

A card payment went through but no credits appeared. Check that the Stripe webhook is set up with the signing secret. If the channel’s workflow add-on was switched off when the payment was confirmed, the amount goes to the tenant’s account balance instead of becoming credits.

Do purchased credits expire? No. They stay until they are used.