Enabling Usage-Based Billing for Recurring products.

For Growth and Scale Plan Vendor’s

Vendors selling recurring priced products have the ability to enable usage-based billing to charge customers overage fees if they go over their allotted usage amount in the billing period.

Important Notes:

  • Vendors will need to utilize our API so coding knowledge is required.
  • The product MUST be a recurring priced product.
  • Coupons do not apply on the Overage cost
  • Overrides for Units & Overage Cost are not available at this time
  • Commissions calculate the overage cost on related transactions and will credit the affiliate based on the final transaction price.
  • Checkouts related to overage costs will show "* Subject to overage fees“ on the checkout order summary before the customer purchases.
  • Related Invoices will include the overage cost as a separate line item on the invoice

Step 1:

Go to ‘Campaigns’ on the left sidebar of your dashboard. Here, you’ll see your campaigns listed.

Choose the PRODUCT that you want to enable the usage-based overage with and select “edit product settings“.

Step 2:

Inside of the related product, settings enable the "Enable Usage Billing" feature.

You will then need to set up the Units Included and Overage Cost for the product.

  • Units included: What you offer the customer as standard per billing period.
    Users, Credits, Calls, Texts, etc. 
  • Overage Cost: Is the additional charge per unit once the customer exceeds the base units included.
  • Trials(optional): If you offer a free or paid trial, you can also set up usage-based overages for the trial period.

Trial overages will be added to the first normal subscription price billing.

Once set up for the product, select save to save the new overage settings.

Step 3:

After saving the unit & overage settings for the product vendors will need to use the API call to report to PayKickstart how many units were used for the related customer subscription in the billing or trial period.


API call variables:

  • Auth Token: Vendor API key from platform settings
  • Invoice ID: Customer subscription. PK-Pxxxxxxx
  • Units: The number of units you are reporting the customer has used.
  • Notes: Optional field to add reference notes if needed.

Vendors should use the API call as soon as they need to report a unit was used in order to ensure the most up to date usage was provided for the customer.

Multiple calls can be sent in the same billing period to continue to update the subscription based on how many units have been used.

After sending the API calls with the unit usage data, PayKickstart will store all usage information for the customers related subscription to properly charge the customer the base product price as well as the additional overage cost per unit on the customers next paid billing transaction if they exceed their included units in the billing period.

Related Transaction Invoices will include the overage cost as a separate line item on the invoice.

Upgrade/Downgrade and Cancel options and Usage Based Overages

If you or the customer use the up/downgrades options related to subscriptions,  PayKickstart will  provide options to help prorate the remaining units from the previous subscription to the new subscription

Vendor: Manual or API Up/Downgrade

If using the option to up/downgrade a subscription in the PK UI, PayKickstart will offer vendors the option to manually add the "allowed # of units" you want pass to the new subscription to be used.

If you leave this "allowed units" field blank, the calculation would be done automatically by the PK system.

If using the API options to up/downgrade the subscription there will be a variable to include the allowed # of units you are passing to the new subscription to be used as pronation.


Vendor: Manual or API Cancellation

When canceling a customer subscription in the PK UI, you have the ability to charge the remaining usage overage fees while canceling if needed.

If you are using the API Subscription cancellation event, you also have this option available in the API Call.

Customer self service - automatic.

If you are using the customer billing portal options and allowing customers to change subscription plans on their own, PayKickstart will automatically calculate the used units from the previous subscription if the customer is downgrading to a lower priced product and calculate the price of the new product to provide the correct amount of remaining units for the current billing period on the customers new subscription. If applicable, the customers new subscription will have a Credit amount associated to use for their billing charges.

If the customer upgrades to a higher priced product, then they would be charged a prorated amount to pay the upgraded subscription cost on the next billing charge date automatically factoring in allowed units.

If customer cancels their plan on their own via the billing portal, they will be charged any unpaid coverage fees.


Each customer subscription will show the current usage amount for the current billing period

Was this article helpful?

Related Articles