Send Invoice
Issues a draft and emails it to its recipients, with reminders after the due date. A draft with no payment_method_id needs invoice:update, invoice:create, or payment:charge, and is never charged. A draft with a payment_method_id needs payment:charge: with a charge_at, or when its due_at is still ahead, it is emailed now and charged to that method at that time (see scheduled_charge_at); otherwise it is charged right away instead of emailed. Voiding the invoice, marking it uncollectible, or paying it first cancels the scheduled charge, and its recipients get the payment link if a charge fails. Sending an open invoice needs payment:charge and emails it again, up to three emails a day including the first send. With send_at, the draft is sent at that time instead, and cannot be edited, except its recipients, until it is sent or unscheduled. Each email, reminders included, is sent separately to the customer email shown on the invoice and to each address in recipient_emails, so recipients never see each other’s addresses.
Yetkilendirmeler
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.
Başlıklar
A unique key that makes this request safe to retry. See Idempotent requests.
255"d9105228-4a08-46b1-8b91-42fed586d383"
Gövde
When to charge the draft's payment_method_id, as an ISO 8601 timestamp in the future and no earlier than send_at. 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 when the draft is sent, or right away otherwise. A scheduled send that runs after charge_at charges right away.
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"
Yanıt
invoice sent
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, and for an invoice whose membership was canceled. Also null unless you have payment:charge, or invoice:create or invoice:update on an invoice with no payment_method_id.
"pay_xxxxxxxxxxxxxx.eyJfcmFpbHMiOnsiZGF0YSI6WzEsZmFsc2VdLCJwdXIiOiJSZWNlaXB0XG5jaGVja291dF9tb3VudFxuIn19--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
The membership this invoice bills, prefixed mem_. For a renewal invoice, it is the subscription that renews. For an invoice with a recurring item, it is the membership created when the invoice is issued. Null for one-off invoices, for a draft not yet issued, and without the member:basic:read permission.
"mem_xxxxxxxxxxxxxx"
When the invoice's saved payment method will be charged, as an ISO 8601 timestamp. It is the charge_at the invoice was sent or issued with. Without one, it is due_at when an invoice with a payment_method_id is sent or issued before it is due. On a draft, it is 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"
Whether this draft is issued automatically when its due_at arrives. Issuing it charges its payment_method_id, or emails its payment link to its recipient_emails. false for an invoice that is not a draft and for a draft with a scheduled send. false while sending the draft would fail for missing recipients or an unavailable payment link. false for a draft that had no future due_at when it was last saved. false for a draft created before 2026-11-12T22:00:00Z.
false
When the first billing period of the invoice's recurring items starts, as an ISO 8601 timestamp. Renewals count from this moment. null starts the period when the invoice is paid, and so does a time that has passed by then. An invoice with a start date skips its variants' free trial.
null

