Configuring Add-On (Credit) Based Billing

This guide covers how to set up and configure Add-On Based Billing for your products. This feature allows you to sell specific product add-ons (such as credits, usage blocks, or supplementary services) as a specific billing model.

Step 1: Enabling Add-On Billing

To get started, you must first enable this specific billing type at the product level.

1. Navigate to the → Campaigns section in your main sidebar.

2. Locate the specific campaign and click on the Product dropdown menu.

3. Find the product you wish to modify and select Edit.

4. Click on the Pricing tab in the product settings.

5. Under the "Payment Type" or billing options, select "Add on".

Note: Once "Add on" is selected, the system will reveal specific configuration options for credit amounts and pricing.

Step 2: Configuring Pricing & Credits

After selecting the "Add on" billing type, you will need to define how the add-on functions:

• Price: Enter the cost for this add-on.

• Credit Amount: Specify how many credits/units the customer receives for this price.

• Auto Top-Up: Define if this add-on is a one-time purchase, or if Credit Top-ups are allowed, where if the customer’s balance reaches a specific amount, they will automatically be billed to add-on the credits back to full usage.

Step 3: Saving Your Changes

Once you have configured the pricing and credit amounts:

1. Review your settings to ensure the billing frequency and amounts are correct.

2. Click Save in the top right corner of the product settings.

Your product is now configured as an Add-On and is ready to be purchased via your checkout forms or API.

Step 4: Automating Usage via API

For SaaS platforms or automated services, you likely want credits to be deducted automatically when a customer uses your software. This functions similarly to the existing PayKickstart Usage feature.

You can use the PayKickstart API to:

• Check Balance [Retrieve buyer addon usage]:
  Retrieve the current credit balance for a specific customer.
  POST   /buyer-addon/usage
  

  

  
  

• Record Usage [Add addon credits to the buyer]:
  Programmatically deduct credits (using a negative value) or add credits (using a positive value) based on activity in your app.
  POST /buyer-addon/usage/add
  

  

For full technical details and endpoints, please refer to the "Addons" section located towards the end of our API documentation.

• → View API Documentation: https://docs.paykickstart.com

Step 5: Customer Auto Top-Up

To ensure uninterrupted service, your can enable and offer the Auto Top-Up option for your customers.

When a customer's credit balance drops below a specific threshold (determined by the customer), the system can automatically charge their payment method on file to purchase a new "bank" of credits.