Retrieve invoice items

Retrieves invoice items with a specified invoice ID.

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

ID of the resource.

query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

Specifies the starting point within the collection of items to be returned.

expand
string

Expands a request to include embedded objects within the _embedded property of the response. This field accepts a comma-separated list of objects.

For more information, see Expand to include embedded objects.

Responses
200

Invoice items retrieved.

Response Schema: application/json
Array
type
required
string

Type of invoice item.

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

Unit price of the invoice item.

id
string <= 50 characters

ID of the website. A website is where an organization obtains a customer through a subscription. For more information, see Obtain an organization ID and website ID.

description
string <= 1000 characters

Description of the invoice item.

quantity
integer

Quantity of the invoice item.

price
number <double>

Total price of the invoice item.

productId
string <= 50 characters

ID of the product.

discountAmount
number <double>

Discount amount applied to the invoice item.

periodStartTime
string <date-time>

Date and time when the billing period starts.

periodEndTime
string <date-time>

Date and time when the billing period ends.

periodNumber
integer

Number of subscription order billing periods in which the invoice item has been included.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

object (InvoiceTaxItem)

Invoice item tax.

amount
required
number <double>

Amount of the tax.

description
required
string

Description of the tax.

rate
number or null <double>

Overall sales tax rate which includes state, county, city and district tax.

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.

stateRate
number or null <double>

State sales tax rate for given location.

countyRate
number or null <double>

County sales tax rate for given location.

cityRate
number or null <double>

City sales tax rate for given location.

specialDistrictRate
number or null <double>

Special district sales tax rate for given location.

object or null

Jurisdiction names for the invoice.

Array of objects

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Enum: "self" "product"
object

Embedded objects that are requested by the expand query parameter.

product
object
plan
object
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

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