Skip to main content
POST
Cancel Scheduled Send

인증

Authorization
string
header
필수

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

헤더

Idempotency-Key
string

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

Maximum string length: 255
예시:

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

Api-Version-Date
string

Pins the request to a dated API version.

예시:

"2026-11-17"

경로 매개변수

id
string
필수

The invoice's pay_ ID.

응답

invoice unscheduled

account_id
string
필수
예시:

"biz_xxxxxxxxxxxxxx"

amount_due
object
필수
billing_address
object | null
필수
buyer_fee_amount
object
필수
buyer_fee_percentage
number
필수
예시:

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.

예시:

"pay_xxxxxxxxxxxxxx.eyJfcmFpbHMiOnsiZGF0YSI6WzEsZmFsc2VdLCJwdXIiOiJSZWNlaXB0XG5jaGVja291dF9tb3VudFxuIn19--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

created_at
string
필수
예시:

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

customer_name
string | null
필수
예시:

"Dana"

deletable
boolean
필수

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.

예시:

false

due_at
string | null
필수
예시:

null

email_address
string | null
필수
예시:

"marcus@shinetime.example"

id
string
필수
예시:

"pay_xxxxxxxxxxxxxx"

invoice_prefix
string | null
필수
예시:

null

line_items
object[]
필수
mailing_address_id
string | null
필수
예시:

null

member_id
string | null
필수
예시:

"mber_xxxxxxxxxxxxxx"

membership_id
string | null
필수

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"

memo
string | null
필수

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

metadata
object
필수
예시:
number
string
필수
예시:

"#xxxxxxxx"

object
enum<string>
필수
사용 가능한 옵션:
invoice
예시:

"invoice"

overdue
boolean
필수
예시:

false

paid_at
string | null
필수
예시:

null

payment_method_configuration
object | null
필수

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
필수
예시:

"payt_xxxxxxxxxxxxxx"

recipient_emails
string[]
필수

Invoice email recipients, independent of the billed customer.

scheduled_charge_at
string | null
필수

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

scheduled_collection_method
enum<string> | 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"

scheduled_send_at
string | null
필수
예시:

null

sends_on_due_date
boolean
필수

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

status
enum<string>
필수
사용 가능한 옵션:
draft,
open,
authorized,
paid,
pending,
uncollectible,
unresolved,
void
예시:

"open"

subscription_starts_at
string | null
필수

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

subtotal
object
필수
tax_amount
object | null
필수
time_zone
string
필수

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

예시:

"UTC"

total
object
필수
totals_status
enum<string>
필수
사용 가능한 옵션:
estimated,
final
예시:

"final"

updated_at
string
필수
예시:

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