UsageCharge

You can use UsageCharge resources to add variable usage charges to existing periodic bills, while using these resources to support different monthly billing plans, with or without monthly periodic charges.

Create Usage Charge

If you want to use the UsageCharge resource, you first need to set up a periodic application billing. This will return the ID needed to associate the UsageCharge.

To create usage charge, send a Post request, where {id} represents the ID of the previously created recurring application charge.

Charging for usage only

A common billing scenario is to charge only usage-based fees, without a flat recurring monthly fee. To charge only usage-based fees without a recurring monthly fee, first create a recurring application charge with a price of $0.00 and then apply the usage charge.

You need to include the capped_amount and terms properties in the body of your request when you create a recurring application charge with a price of $0.00.

Setting capped amounts

You can use RecurringApplicationCharge resources to specified applied to usage-based billing the upper limit of amount. This prevents customers from being charged for any usage that exceeds the cap. To implement capped amount billing, create a recurring application charge with the capped dollar amount, and then create an associated usage charge.

Note:

The capped amount setting is applicable on a per billing cycle basis (30 days), and remains in effect unless updated.

At the end of each billing period, the current usage charge will be charged. For the failure to collect the usage charge due to various circumstances, the last bad debt will be collected when the merchant re-establishes the recurring application charge

UsageCharge

NameTypeDescription
idstringThe ID of the application charge.
descriptionstringThe description of the usage charge.
pricestringThe price of the recurring application charge.
created_atdateThe time this fulfillment created, ISO-8601 format
updated_atdateThe time this fulfillment last updated, ISO-8601 format