Record an excess payment for a customer

Idempotency Supported

Records an offline payment for a customer and adds it to the customer's excess payments balance.

Invoices

Chargebee automatically applies excess payments to future invoices, subject to limits set at the site level or overridden for subscriptions via subscription.billing_override.
Use the Apply payments to an invoice API to apply excess payments to an invoice on an ad-hoc basis.

Apply payments for an invoice

Sample Request

POST https://[site].chargebee.com/api/v2/customers/{customer-id}/record_excess_payment

comment

optional, string, max chars=300

Remarks, if any, on the payment.

transaction

Parameters for transaction

pass parameters as transaction[<param name>]

Customer object

Resource object representing customer

Transaction object

Resource object representing transaction