Preview invoice

POST

/v1/invoices/preview

Preview an invoice for a subscription without persisting anything.

Request Body ^required

InvoicePreviewRequest

Request body for invoice preview.

object

subscription_id

required

Subscription Id

string format: uuid

billing_period_start

Any of:

string

string format: date-time

null

null

billing_period_end

Any of:

string

string format: date-time

null

null

Responses

200

Successful Response

InvoicePreviewResponse

Response for an invoice preview.

object

subtotal_cents

required

Subtotal Cents

string

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

tax_amount_cents

required

Tax Amount Cents

string

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

coupons_amount_cents

required

Coupons Amount Cents

string

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

prepaid_credit_amount_cents

required

Prepaid Credit Amount Cents

string

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

total_cents

required

Total Cents

string

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

currency

required

Currency

string

fees

required

Fees

Array<object>

FeePreview

Preview of a single fee/line item.

object

description

required

Description

string

units

required

Units

string

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

unit_amount_cents

required

Unit Amount Cents

string

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

amount_cents

required

Amount Cents

string

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

charge_model

Any of:

string

string

null

null

metric_code

Any of:

string

string

null

null

400

Subscription not found or not active

401

Unauthorized – invalid or missing API key

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