Skip to main content
POST
Create Invoice

Authorizations

Authorization
string
header
required

API key (sk_test_* or sk_live_*)

Body

application/json
customer
string
required
subscription
string
collection_method
enum<string>
Available options:
charge_automatically,
send_invoice
days_until_due
integer
description
string
auto_advance
boolean
default:true
metadata
object

Response

Invoice created

id
string
object
enum<string>
Available options:
invoice
number
string
customer
string
subscription
string
status
enum<string>
Available options:
draft,
open,
paid,
void,
uncollectible,
past_due
collection_method
string
currency
string
amount_due
integer
amount_paid
integer
amount_remaining
integer
subtotal
integer
tax
integer
total
integer
description
string
due_date
integer
period_start
integer
period_end
integer
lines
object
paid
boolean
paid_at
integer
voided_at
integer
hosted_invoice_url
string
metadata
object
created
integer