Retrieve invoice items

Retrieve an invoice items with specified invoice identifier string.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

query Parameters
limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

expand
string

Expand a response to get a full related object included inside of the _embedded path in the response. It accepts a comma-separated list of objects to expand. See the expand guide for more info.

Responses
200

Invoice items were retrieved successfully.

Response Schema: application/json
Array
type
required
string

Invoice item's type.

Enum: "debit" "credit"
unitPrice
required
number <double>

Invoice item's price.

id
string <= 50 characters

The website identifier string.

description
string

Invoice item's description.

quantity
integer

Invoice item's quantity.

price
number <double>

Invoice item's total price.

productId
string <= 50 characters

The product's ID.

discountAmount
number <double>

Invoice item discount amount.

periodStartTime
string <date-time>

Start time.

periodEndTime
string <date-time>

End time.

periodNumber
integer

Invoice item subscription order period number.

createdTime
string <date-time>

Invoice item created time.

updatedTime
string <date-time> (UpdatedTime)

Read-only timestamp updates when the resource is updated.

object

Invoice item tax.

amount
required
number <double>

Tax amount.

description
required
string

Tax description.

rate
number or null <double>

Tax rate.

stateAmount
number or null <double>

Amount of sales tax to collect for the state.

countyAmount
number or null <double>

Amount of sales tax to collect for the county.

cityAmount
number or null <double>

Amount of sales tax to collect for the city.

specialDistrictAmount
number or null <double>

Amount of sales tax to collect for the special district.

object or null

Jurisdiction names for the invoice.

Array of Self (object) or ProductLink (object) non-empty

The links related to resource.

Array (non-empty)
Any of:
href
required
string

The link URL.

rel
required
string

The link type.

Value: "self"
Array of ProductEmbed (object) or PlanEmbed (object) non-empty

Any embedded objects available that are requested by the expand querystring parameter.

Array (non-empty)
Any of:

Product object.

object (Product)

Products include digital goods, services, and physical goods. Products appear on invoice line items. If you set a tax category identifier, taxes will be calculated upon invoice generation. If it is shippable, shipping will be calculated upon invoice generation. Pricing and variations are set within Plans.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

get/invoices/{id}/items
Request samples
$invoiceItems = $client->invoiceItems()->search('invoiceId', [
    'filter' => 'quantity:5',
]);
Response samples
application/json
[
  • {
    }
]