Create a one-off invoice

POST

/v1/invoices/one_off

Create a one-off invoice with custom line items (not tied to a subscription).

Request Body ^required

OneOffInvoiceCreate

object

customer_id

required

Customer Id

string format: uuid

currency

Currency

string

default: USD >= 3 characters <= 3 characters

line_items

required

Line Items

Array<object>

>= 1 items

InvoiceLineItem

object

description

required

Description

string

quantity

required

Any of:

number

number

string

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

unit_price

required

Any of:

number

number

string

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

amount

required

Any of:

number

number

string

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

charge_id

Any of:

string

string format: uuid

null

null

metric_code

Any of:

string

string

null

null

due_date

Any of:

string

string format: date-time

null

null

billing_entity_id

Any of:

string

string format: uuid

null

null

Responses

200

Successful Response

InvoiceResponse

object

id

required

Id

string format: uuid

invoice_number

required

Invoice Number

string

customer_id

required

Customer Id

string format: uuid

subscription_id

required

Any of:

string

string format: uuid

null

null

status

required

Status

string

invoice_type

required

Invoice Type

string

billing_period_start

required

Billing Period Start

string format: date-time

billing_period_end

required

Billing Period End

string format: date-time

subtotal_cents

required

Subtotal Cents

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

tax_amount_cents

required

Tax Amount Cents

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

total_cents

required

Total Cents

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

prepaid_credit_amount_cents

required

Prepaid Credit Amount Cents

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

coupons_amount_cents

required

Coupons Amount Cents

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

progressive_billing_credit_amount_cents

required

Progressive Billing Credit Amount Cents

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

currency

required

Currency

string

line_items

required

Line Items

Array<object>

object

key

additional properties

any

due_date

required

Any of:

string

string format: date-time

null

null

issued_at

required

Any of:

string

string format: date-time

null

null

paid_at

required

Any of:

string

string format: date-time

null

null

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

401

Unauthorized – invalid or missing API key

404

Customer not found

422

Validation error