charge_now_scheduled_charge
Force-bill a scheduled charge's current cycle immediately, dispatching email, webhook, and timeline events. Idempotent and safe to retry, it reports outcomes like 'dispatched' or 'already_sent' to avoid double charges.
Instructions
Force-bill the current cycle right now instead of waiting for its due date. Runs the same dispatch the daily billing cron would: customer email/notification + outbound webhook + timeline event. Allowed only from a billable status (scheduled / due_today); a recurring series must also have an open cycle (otherwise the gateway returns 400). IDEMPOTENT — NOT a re-charge: if this cycle's d-day was already dispatched it reports outcome 'already_sent' and does nothing, so retries are safe and never double-bill. Read the returned outcome ('dispatched' | 'already_sent' | 'not_sent' | 'failed'), the optional reason (e.g. no_email, no_saved_payment_method, card_expired, or a gateway decline code), and the pt-BR message to decide what to tell the user.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Scheduled charge ID |