Order Details
User History
Prices
Coupons
Products
Licenses
Pay Links
Transactions
Payments
Plans
Users
Modifiers
Payments
Webhooks
post

/2.0/subscription/{id}/charge

Make immediate one-time charges on top of an existing subscription.

This feature is useful for scenarios where buyers need to purchase add-ons on top of a recurring plan.

For example, Charges API provides you with the flexibility to charge buyers, with existing subscriptions, right away for one-time top-ups, rather than waiting for the end of their current billing cycle.

Usage Notes

  • All one-time charges via the API will be made in full i.e. no proration
  • The buyer will be invoiced immediately
  • Charges are independent of the existing billing cycle i.e. they do not affect any existing due payments or future invoices
  • There is no in-built dunning for the Charges API, so you will need to manage error handling and retries on your own
  • Charges API inherits the user subscription’s VAT settings (configurable from the Sales Tax Settings page in the Seller Dashboard)
  • You can only charge a card up to 5 times an hour (including subscriptions and one-off charges)

Request Parameters

1 Path Parameter

Request Body

Form data (application/x-www-form-urlencoded)
vendor_id
integer

The vendor ID identifies your seller account. This can be found in Developer Tools > Authentication.

required
minimum: 1
pattern: \d+
vendor_auth_code
string

The vendor auth code is a private API key for authenticating API requests. This key should never be used in client side code or shared publicly. This can be found in Developer Tools > Authentication.

required
pattern: [0-9a-f]+
amount
number

The amount for the one-time charge.

This amount will be charged in the currency of the subscription.

If the user’s subscription VAT setting is set to add to price, then we will add VAT to this charge amount.

required
pattern: ^\d+\.\d{2}$
charge_name
string

The name of the one-time charge - this will be visible to the buyers and will show up in the invoice as a line item, so that a buyer can always refer back to the invoice to know how much they were charged and what for.

Note: Please put a proper product / charge name here to make it clear what buyers are buying. Here are some examples:

  • [add-on name] x [quantity] e.g. Supercool design plugin x 1
  • [number of credits] credits for [subscription plan] e.g. 200 credits for Monthly talk time
  • [quantity] [units] [product description] e.g. 124 MB data usage
required
maxLength: 50

Responses

1 Example
Schema
object
or
object

An unsuccessful call to the Dashboard API will return a 200 response containing a field success set to false and an error object.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
id
$$.env
No $$.env variables are being used in this request.