The Invoice Item object 

Attributes

• idstring

  Unique identifier for the object.

• amountinteger

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

• currencyenum

  Three-letter ISO currency code, in lowercase. Must be a supported currency.

• customerstringExpandable

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

• descriptionnullable string

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

• metadatanullable object

  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.

• parentnullable object

  The parent that generated this invoice item.

  Hide child attributes

  • parent.subscription_detailsnullable object

    Details about the subscription that generated this invoice item

    Hide child attributes

    • parent.subscription_details.subscriptionstring

      The subscription that generated this invoice item

    • parent.subscription_details.subscription_itemnullable string

      The subscription item that generated this invoice item

  • parent.typeenum

    The type of parent that generated this invoice item

    Possible enum values

    subscription_details Details of the parent can be found in the subscription_details hash.

• periodobject

  The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have Stripe Revenue Recognition enabled, the period will be used to recognize and defer revenue. See the Revenue Recognition documentation for details.

  Hide child attributes

  • period.endtimestamp

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

  • period.starttimestamp

    The start of the period. This value is inclusive.

• pricingnullable object

  The pricing information of the invoice item.

  Hide child attributes

  • pricing.price_detailsnullable object

    Additional details about the price this item is associated with. This is present only when the type is price_details

    Hide child attributes

    • pricing.price_details.pricestring

      The ID of the price this item is associated with.

    • pricing.price_details.productstring

      The ID of the product this item is associated with.

  • pricing.typeenum

    The type of the pricing details.

  • pricing.unit_amount_decimalnullable decimal string

    The unit amount (in the currency specified) of the item which contains a decimal value with at most 12 decimal places.

• prorationboolean

  Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.

More attributes

Collapse all

• objectstring

  String representing the object’s type. Objects of the same type share the same value.

• datetimestamp

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

• discountableboolean

  If true, discounts will apply to this invoice item. Always false for prorations.

• discountsnullable array of stringsExpandable

  The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.

• invoicenullable stringExpandable

  The ID of the invoice this invoice item belongs to.

• livemodeboolean

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

• quantityinteger

  Quantity of units for the invoice item. If the invoice item is a proration, the quantity of the subscription that the proration was computed for.

• tax_ratesnullable array of objects

  The tax rates which apply to the invoice item. When set, the default_tax_rates on the invoice do not apply to this invoice item.

  Hide child attributes

  • tax_rates.idstring

    Unique identifier for the object.

  • tax_rates.objectstring

    String representing the object’s type. Objects of the same type share the same value.

  • tax_rates.activeboolean

    Defaults to true. When set to false, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.

  • tax_rates.countrynullable string

    Two-letter country code (ISO 3166-1 alpha-2).

  • tax_rates.createdtimestamp

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

  • tax_rates.descriptionnullable string

    An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.

  • tax_rates.display_namestring

    The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.

  • tax_rates.effective_percentagenullable float

    Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage reflects the rate actually used to calculate tax based on the product’s taxability and whether the user is registered to collect taxes in the corresponding jurisdiction.

  • tax_rates.flat_amountnullable object

    The amount of the tax rate when the rate_type is flat_amount. Tax rates with rate_type percentage can vary based on the transaction, resulting in this field being null. This field exposes the amount and currency of the flat tax rate.

    Hide child attributes

    • tax_rates.flat_amount.amountinteger

      Amount of the tax when the rate_type is flat_amount. This positive integer represents how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).

    • tax_rates.flat_amount.currencystring

      Three-letter ISO currency code, in lowercase.

  • tax_rates.inclusiveboolean

    This specifies if the tax rate is inclusive or exclusive.

  • tax_rates.jurisdictionnullable string

    The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.

  • tax_rates.jurisdiction_levelnullable enum

    The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates.

    Possible enum values

    city

    country

    county

    district

    multiple

    state

  • tax_rates.livemodeboolean

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

  • tax_rates.metadatanullable object

    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.

  • tax_rates.percentagefloat

    Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions.

  • tax_rates.rate_typenullable enum

    Indicates the type of tax rate applied to the taxable amount. This value can be null when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax.

    Possible enum values

    flat_amount A fixed amount applied as tax, regardless of the taxable amount, such as a retail delivery fee.

    percentage A tax rate expressed as a percentage of the taxable amount, such as the sales tax rate in California.

  • tax_rates.statenullable string

    ISO 3166-2 subdivision code, without country prefix. For example, “NY” for New York, United States.

  • tax_rates.tax_typenullable enum

    The high-level tax type, such as vat or sales_tax.

    Possible enum values

    amusement_tax Amusement Tax

    communications_tax Communications Tax

    gst Goods and Services Tax

    hst Harmonized Sales Tax

    igst Integrated Goods and Services Tax

    jct Japanese Consumption Tax

    lease_tax Chicago Lease Tax

    pst Provincial Sales Tax

    qst Quebec Sales Tax

    retail_delivery_fee Retail Delivery Fee

    Show 4 more

• test_clocknullable stringExpandable

  ID of the test clock this invoice item belongs to.