Retrieve an invoice item

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Path Params

string

required

Header Params

string

required

Default:

application/json

Content-Type

string

required

Default:

application/json

Responses

🟢200OK

application/json

Body

string

optional

Unique identifier for the object.

object

string

optional

"invoiceitem"

amount

integer

optional

Amount (in the currency specified) of the invoice item. This should always be equal to unit_amount * quantity.

currency

string

optional

Three-letter ISO currency code

customer

string

optional

The ID of the customer who will be billed when this invoice item is billed.

description

string

optional

An arbitrary string attached to the object. Often useful for displaying to users.

metadata

object

optional

Set of key-value pairs that you can attach to an object.

period

object

optional

The period associated with this invoice item. When set to different values, the period will be rendered on the invoice.

end

string

optional

timestamp.The end of the period, which must be greater than or equal to the start. This value is inclusive.

start

string

optional

timestamp. The start of the period. This value is inclusive.

price

object

optional

The ID of the price object.

string

optional

Unique identifier for the object, like "price_xxxx".

object

string

optional

'price'

active

boolean

optional

Whether the price can be used for new purchases.

billing_scheme

enum<string>

optional

Describes how to compute the price per period. Either per_unit or tiered

Allowed values:

per_unittiered

created

integer

optional

Time at which the object was created. Measured in seconds since the Unix epoch.

currency

string

optional

Three-letter ISO currency code, in uppercase.

livemode

boolean

optional

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

lookup_key

string

optional

A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.

metadata

object

optional

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

nickname

string

optional

A brief description of the price, hidden from customers.

product

string

optional

The ID of the product this price is associated with.

type

enum<string>

optional

One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.

Allowed values:

one_timerecurring

unit_amount

integer

optional

The unit amount in cents to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit.

recurring

object

optional

The recurring components of a price

tiers

array [object {3}]

optional

（未实现）

date

string

optional

Time at which the object was created. Measured in seconds since the Unix epoch.

invoice

string

optional

The ID of an existing invoice to add this invoice item to. When left blank, the invoice item will be added to the next upcoming scheduled invoice. This is useful when adding invoice items in response to an invoice.created webhook. You can only add invoice items to draft invoices and there is a maximum of 250 items per invoice.

livemode

boolean

optional

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

quantity

integer

optional

The quantity of the subscription, if the line item is a subscription or a proration.

subscription

string

optional

The ID of a subscription to add this invoice item to. When left blank, the invoice item will be be added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription.

unit_amount

integer

optional

The integer unit amount in pence of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. Passing in a negative unit_amount will reduce the amount_due on the invoice.

test_clock

string

optional

ID of the test clock this invoice item belongs to.

Example

{
  "id": "string",
  "object": "string",
  "amount": 0,
  "currency": "string",
  "customer": "string",
  "description": "string",
  "metadata": {},
  "period": {
    "end": "string",
    "start": "string"
  },
  "price": {
    "id": "string",
    "object": "string",
    "active": true,
    "billing_scheme": "per_unit",
    "created": 0,
    "currency": "string",
    "livemode": true,
    "lookup_key": "string",
    "metadata": {},
    "nickname": "string",
    "product": "string",
    "type": "one_time",
    "unit_amount": 0,
    "recurring": {
      "interval": "day",
      "interval_count": 0,
      "usage_type": "licensed"
    },
    "tiers": [
      {
        "up_to": "string",
        "flat_amount": "string",
        "unit_amount": "string"
      }
    ]
  },
  "date": "string",
  "invoice": "string",
  "livemode": true,
  "quantity": 0,
  "subscription": "string",
  "unit_amount": 0,
  "test_clock": "string"
}

Request

Request samples

Responses