Skip to main content
POST
Create account invoice

Authorizations

x-api-key
string
header
required

Your SideShift Connect API key (sk_live_* or sk_test_*). Generate from Settings → Connect.

Body

application/json
sideshiftAccountId
string
required

Connected account that should receive invoice proceeds

Example:

"acct_a1b2c3d4e5f6"

customerName
string
required

Invoice recipient full name

customerEmail
string<email>
required

Primary invoice recipient email

lineItems
object[]
required

One or more invoice line items

dueDate
string<date-time>
required

Invoice due date as an ISO 8601 timestamp

customerId
string | null

Existing customer ID to associate with the invoice

additionalEmails
string<email>[]

Additional recipient emails that should also receive the invoice email

customerAddress
object | null

Optional recipient mailing address

paymentType
enum<string>
default:one_time

Billing mode for the invoice

Available options:
one_time,
renewal
currency
string
default:usd

3-letter lowercase ISO 4217 currency code

Pattern: ^[a-z]{3}$
Example:

"usd"

taxCents
integer
default:0

Optional tax amount in cents

Required range: x >= 0
discountCents
integer
default:0

Optional discount amount in cents

Required range: x >= 0
collectCustomerFee
boolean
default:true

Whether customer-facing processing fees should be collected

feeConfig
object

Optional fee overrides. Supported keys are card and us_bank_account

allowedPaymentTypes
enum<string>[]

Checkout payment methods allowed for this invoice. Supported values: card, apple_pay, google_pay, link, us_bank_account, sepa_debit, bacs_debit, acss_debit, au_becs_debit, cashapp, paypal, venmo, klarna, affirm, afterpay_clearpay, crypto

Minimum array length: 1
Available options:
card,
apple_pay,
google_pay,
link,
us_bank_account,
sepa_debit,
bacs_debit,
acss_debit,
au_becs_debit,
cashapp,
paypal,
venmo,
klarna,
affirm,
afterpay_clearpay,
crypto
description
string | null

Optional internal invoice description

notes
string | null

Optional invoice notes

terms
string | null

Optional payment terms text

sendReminders
boolean
default:true

Whether invoice reminders should be enabled on the invoice record

sendNow
boolean
default:true

When false, create without sending the initial invoice email

Response

Invoice created

success
boolean
data
object