Retrieve an invoice's line items

Changed on

When retrieving an invoice, you’ll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

get/v1/invoices/{invoice}/lines

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/invoices/{invoice}/lines
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Path parameters

invoicestring required

Query parameters

ending_beforestring

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

expandstring[]

Specifies which fields in the response should be expanded.

limitinteger

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

starting_afterstring

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Request body application/x-www-form-urlencoded

object required

Response

Successful response.

has_moreboolean required

True if this list has another page of items after this one that can be fetched.

object'list' required

String representing the object's type. Objects of the same type share the same value. Always has the value list.

urlstring required

The URL where this list can be accessed.

Changes

  • 743273d7a7b7Revision changes
    • info

      added the required property // to the response with the status

  • b22313c11340Revision changes
    • breaking

      the ///// response property's maxLength was unset from 5000 for the response status

    • breaking

      the ///// response's property type changed from string to no type for status

    This list may be incomplete.

Some revisions have not been checked yet.