Issue Invoice
Resolves final tax and opens a draft invoice without emailing it. An invoice with a payment_method_id is charged to it off-session, as POST /payments charges a saved payment method: at charge_at if given, otherwise on due_at while it is still ahead, otherwise right away (see scheduled_charge_at). With a future due_at and no charge_at, the customer is charged on the due date without being emailed first. Issuing an open invoice again retains its totals and charges nothing.
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-11-04-1"
Path Parameters
The invoice's pay_ ID.
Body
When to charge the draft's payment_method_id, as an ISO 8601 timestamp in the future. Only for a draft with a payment_method_id and a total above zero. Omit to charge on due_at if it is still ahead, or right away otherwise.
How the subscription this invoice starts collects each renewal. charge_automatically charges the payment method that paid the invoice each period: the draft's payment_method_id, or the one the customer pays the invoice link with. send_invoice issues a numbered invoice each period, due on the renewal date and emailed with its payment link to the latest invoice's recipient_emails, so it needs at least one recipient and isn't available for invoices billed to a business. Defaults to charge_automatically. Only for a draft with a recurring item. A scheduled send applies it when it fires (see scheduled_collection_method).
charge_automatically, send_invoice, null "charge_automatically"
Response
invoice issued
"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"
The membership this invoice bills, prefixed mem_: the subscription a renewal invoice renews, or the one created when an invoice with a recurring item is issued. Null for one-off invoices, for a draft not yet issued, and without the member:basic:read permission.
"mem_xxxxxxxxxxxxxx"
A note to the customer, shown on the invoice email, PDF, and checkout page with its line breaks kept. null when none is set.
null
"#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
The collection_method a draft's scheduled send applies when it fires. null when the draft has no scheduled send or it was scheduled without one, and once the invoice is issued.
charge_automatically, send_invoice, null "charge_automatically"
null
draft, open, authorized, paid, pending, uncollectible, unresolved, void "open"
estimated, final "final"
"2026-01-01T12:00:00.000Z"

