Skip to main content
POST
Charge Invoice

Yetkilendirmeler

Authorization
string
header
gerekli

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

payment:charge

Başlıklar

Idempotency-Key
string

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

Maximum string length: 255
Örnek:

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

Api-Version-Date
string

Pins the request to a dated API version.

Örnek:

"2026-11-17"

Yol Parametreleri

id
string
gerekli

The invoice's pay_ ID.

Gövde

application/json
payment_method_id
string | null

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.

Örnek:

"payt_xxxxxxxxxxxxxx"

Yanıt

charge started

account_id
string
gerekli
Örnek:

"biz_xxxxxxxxxxxxxx"

amount_due
object
gerekli
billing_address
object | null
gerekli
buyer_fee_amount
object
gerekli
buyer_fee_percentage
number
gerekli
Örnek:

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.

Örnek:

"pay_xxxxxxxxxxxxxx.eyJfcmFpbHMiOnsiZGF0YSI6WzEsZmFsc2VdLCJwdXIiOiJSZWNlaXB0XG5jaGVja291dF9tb3VudFxuIn19--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

created_at
string
gerekli
Örnek:

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

customer_name
string | null
gerekli
Örnek:

"Dana"

deletable
boolean
gerekli

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.

Örnek:

false

due_at
string | null
gerekli
Örnek:

null

email_address
string | null
gerekli
Örnek:

"marcus@shinetime.example"

id
string
gerekli
Örnek:

"pay_xxxxxxxxxxxxxx"

invoice_prefix
string | null
gerekli
Örnek:

null

line_items
object[]
gerekli
mailing_address_id
string | null
gerekli
Örnek:

null

member_id
string | null
gerekli
Örnek:

"mber_xxxxxxxxxxxxxx"

membership_id
string | null
gerekli

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.

Örnek:

"mem_xxxxxxxxxxxxxx"

memo
string | null
gerekli

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

Örnek:

null

metadata
object
gerekli
Örnek:
number
string
gerekli
Örnek:

"#xxxxxxxx"

object
enum<string>
gerekli
Mevcut seçenekler:
invoice
Örnek:

"invoice"

overdue
boolean
gerekli
Örnek:

false

paid_at
string | null
gerekli
Örnek:

null

payment_method_configuration
object | null
gerekli

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
gerekli
Örnek:

"payt_xxxxxxxxxxxxxx"

recipient_emails
string[]
gerekli

Invoice email recipients, independent of the billed customer.

scheduled_charge_at
string | null
gerekli

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.

Örnek:

null

scheduled_collection_method
enum<string> | null
gerekli

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.

Mevcut seçenekler:
charge_automatically,
send_invoice,
null
Örnek:

"charge_automatically"

scheduled_send_at
string | null
gerekli
Örnek:

null

sends_on_due_date
boolean
gerekli

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.

Örnek:

false

status
enum<string>
gerekli
Mevcut seçenekler:
draft,
open,
authorized,
paid,
pending,
uncollectible,
unresolved,
void
Örnek:

"open"

subscription_starts_at
string | null
gerekli

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.

Örnek:

null

subtotal
object
gerekli
tax_amount
object | null
gerekli
time_zone
string
gerekli

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

Örnek:

"UTC"

total
object
gerekli
totals_status
enum<string>
gerekli
Mevcut seçenekler:
estimated,
final
Örnek:

"final"

updated_at
string
gerekli
Örnek:

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