Add a payment to a metered order

Adds one payment to a metered order, to charge the customer for usage. The payment joins the order's schedule as a new scheduled payment.

A scheduled payment is a planned future collection on an instalment, subscription or metered order. It shows as one billing event in the order's payment timeline. A metered order has no schedule of its own: each payment you add here is one scheduled payment.

  1. Send the product_id of a product on the order. Choose when to collect with process_date.
  2. BillPro works out the amount from the product's price on this order, with its fees, discounts and tax. The currency is always the order's currency.
  3. You get back the new scheduled payment, with status scheduled. Nothing is charged in this request.
  4. BillPro collects it on its date. With now, the next collection run charges it. To charge it straight away and see the result, execute it with the returned id.
  • Send amount to confirm the figure you showed. If it's off by more than one cent, you get a 422 with the right amount. It never changes the price.
  • The product and your note are saved in the order's notes. They aren't stored on the payment.
  • Only metered orders accept this request. Other order types return 422.
  • There's no currency field. One sent is ignored.

To cancel the payment before it's collected, skip it.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
≥ 1

Your merchant profile ID. Required in every request.

Find it in the BillPro dashboard address, after /profiles/. For example, in /profiles/1234/orders the profile ID is 1234.

string
required

ID of the order.

Body Params
integer
required

The product to charge for. It must be a product on this order. Any other ID returns 422.

string
enum
required

When to collect. now: schedule it for the current time, for the next collection run. specific: on the date in scheduled_at.

Allowed:
date-time

Optional. When to collect, in ISO 8601, such as 2026-11-30T09:00:00.000Z. Required when process_date is specific.

integer
≥ 1

Optional. How many units to charge for, such as hours. A whole number of 1 or more.

number

Optional. The amount you expect, such as 120.00. It's checked against BillPro's amount. A difference of more than one cent returns 422. It's never used as the price.

string

Optional. A note about the charge, such as the period it covers. It's saved on the order, with the product added.

Responses

Language
Credentials
Bearer
API token
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json