createInvoiceCharge
createInvoiceChargeCreate an auto-charge on an invoice to collect payment using the customer's configured payment method. Optionally specify payment provider, method types, or skip due date checks.
Instructions
Create an auto-charge for an invoice. Triggers payment collection via the customer's configured payment method.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| invoiceId | Yes | The unique identifier (UUID) of the invoice to charge. | |
| connector | No | Optional payment provider connector config object (e.g., {"name": "stripe", "reference_id": "cus_xxx"}). Backend auto-detects if omitted. | |
| source | No | Optional source identifier for the charge. | |
| payment_method_types | No | Optional list of allowed payment method types (e.g., ["card", "ach"]). | |
| skip_invoice_due_date_check | No | If true, charge proceeds even if the invoice is not yet due. Defaults to false. | |
| __userContext | No | Internal user context for multi-tenant authentication and approval workflow |