List customer invoices

GET

/portal/invoices

List invoices for the authenticated customer.

Parameters

Query Parameters

skip

Skip

integer

0

limit

Limit

integer

default: 100 >= 1 <= 1000

token

required

Token

string

Responses

200

Successful Response

Response List Portal Invoices

Array<object>

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

Invalid or expired portal token

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object