Skip to main content
POST
Send Invoice

Autorisaties

Authorization
string
header
vereist

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.

Scopes

invoice:update
invoice:create
payment:charge

Headers

Idempotency-Key
string

A unique key that makes this request safe to retry. See Idempotent requests.

Maximum string length: 255
Voorbeeld:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date
string

Pins the request to a dated API version.

Voorbeeld:

"2026-11-17"

Padparameters

id
string
vereist

The invoice's pay_ ID.

Body

application/json
charge_at
string<date-time> | null

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.

collection_method
enum<string> | null

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).

Beschikbare opties:
charge_automatically,
send_invoice,
null
Voorbeeld:

"charge_automatically"

send_at
string<date-time> | null

When to send the draft, as an ISO 8601 timestamp in the future. Omit to send now.

Respons

invoice sent

account_id
string
vereist
Voorbeeld:

"biz_xxxxxxxxxxxxxx"

amount_due
object
vereist
billing_address
object | null
vereist
buyer_fee_amount
object
vereist
buyer_fee_percentage
number
vereist
Voorbeeld:

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, 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.

Voorbeeld:

"pay_xxxxxxxxxxxxxx.eyJfcmFpbHMiOnsiZGF0YSI6WzEsZmFsc2VdLCJwdXIiOiJSZWNlaXB0XG5jaGVja291dF9tb3VudFxuIn19--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

created_at
string
vereist
Voorbeeld:

"2026-01-01T12:00:00.000Z"

customer_name
string | null
vereist
Voorbeeld:

"Dana"

deletable
boolean
vereist

True when DELETE /invoices/{id} can delete this invoice. A draft qualifies unless it is scheduled or bills a subscription. A void invoice qualifies unless it collected money or still awaits a bank wire.

Voorbeeld:

false

due_at
string | null
vereist
Voorbeeld:

null

email_address
string | null
vereist
Voorbeeld:

"marcus@shinetime.example"

id
string
vereist
Voorbeeld:

"pay_xxxxxxxxxxxxxx"

invoice_prefix
string | null
vereist
Voorbeeld:

null

line_items
object[]
vereist
mailing_address_id
string | null
vereist
Voorbeeld:

null

member_id
string | null
vereist
Voorbeeld:

"mber_xxxxxxxxxxxxxx"

membership_id
string | null
vereist

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.

Voorbeeld:

"mem_xxxxxxxxxxxxxx"

memo
string | null
vereist

A note to the customer, shown on the invoice email, PDF, and checkout page with its line breaks kept. null when none is set.

Voorbeeld:

null

metadata
object
vereist
Voorbeeld:
number
string
vereist
Voorbeeld:

"#xxxxxxxx"

object
enum<string>
vereist
Beschikbare opties:
invoice
Voorbeeld:

"invoice"

overdue
boolean
vereist
Voorbeeld:

false

paid_at
string | null
vereist
Voorbeeld:

null

payment_method_configuration
object | null
vereist

The payment methods the customer can choose from when paying through the invoice's checkout link. It takes precedence over the invoice's variants and the account. null when the invoice uses its variants' payment methods.

payment_method_id
string | null
vereist
Voorbeeld:

"payt_xxxxxxxxxxxxxx"

recipient_emails
string[]
vereist

Invoice email recipients, independent of the billed customer.

scheduled_charge_at
string | null
vereist

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.

Voorbeeld:

null

scheduled_collection_method
enum<string> | null
vereist

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.

Beschikbare opties:
charge_automatically,
send_invoice,
null
Voorbeeld:

"charge_automatically"

scheduled_send_at
string | null
vereist
Voorbeeld:

null

sends_on_due_date
boolean
vereist

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.

Voorbeeld:

false

status
enum<string>
vereist
Beschikbare opties:
draft,
open,
authorized,
paid,
pending,
uncollectible,
unresolved,
void
Voorbeeld:

"open"

subscription_starts_at
string | null
vereist

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.

Voorbeeld:

null

subtotal
object
vereist
tax_amount
object | null
vereist
time_zone
string
vereist

The IANA time zone for the dates on the invoice's email and PDF, such as America/New_York. UTC unless one was set.

Voorbeeld:

"UTC"

total
object
vereist
totals_status
enum<string>
vereist
Beschikbare opties:
estimated,
final
Voorbeeld:

"final"

updated_at
string
vereist
Voorbeeld:

"2026-01-01T12:00:00.000Z"