Charge Invoice
Charges an open invoice now to one of its customer’s saved payment methods, canceling any charge scheduled for later. The charge completes asynchronously: the invoice becomes paid, or, if declined, stays open and its recipients are emailed the checkout_link. Refused for drafts and while another payment is in progress.
Authorizations
An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.
Headers
A unique key that makes this request safe to retry. See Idempotent requests.
255"d9105228-4a08-46b1-8b91-42fed586d383"
Pins the request to a dated API version.
"2026-10-29-8"
Path Parameters
The invoice's pay_ ID.
Body
The saved payment method to charge, prefixed payt_. It must belong to the invoice's customer and be chargeable without the customer present. Omit it to charge the invoice's own payment_method_id.
"payt_xxxxxxxxxxxxxx"
Response
charge started
"biz_xxxxxxxxxxxxxx"
0
A signed link that opens this invoice in a checkout session so the buyer can pay it: pass it as link to POST /checkout_sessions. Present while the invoice is open; null in any other status, for an invoice billed to a business buyer or whose membership was canceled, and unless you have payment:charge, or invoice:create or invoice:update on an invoice with no payment_method_id.
"pay_xxxxxxxxxxxxxx.eyJfcmFpbHMiOnsiZGF0YSI6WzEsZmFsc2VdLCJwdXIiOiJSZWNlaXB0XG5jaGVja291dF9tb3VudFxuIn19--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
"2026-01-01T12:00:00.000Z"
"Dana"
null
"marcus@shinetime.example"
"pay_xxxxxxxxxxxxxx"
null
null
"mber_xxxxxxxxxxxxxx"
"#xxxxxxxx"
invoice "invoice"
false
null
"payt_xxxxxxxxxxxxxx"
Invoice email recipients, independent of the billed customer.
When the invoice's saved payment method will be charged, as an ISO 8601 timestamp: the charge_at it was sent or issued with, or due_at when an invoice with a payment_method_id is sent or issued before it is due without one. On a draft, the charge_at of its scheduled send. null otherwise, once the charge starts, and once the invoice is paid, void, or uncollectible.
null
null
draft, open, authorized, paid, pending, uncollectible, unresolved, void "open"
estimated, final "final"
"2026-01-01T12:00:00.000Z"

