Get line items for a specific account.

get https://Contact sales to enable your sandbox/accounts/{account_id}/line_items

Line Items for an Account include charges to the account and payments by the account holder. Results are paginated and sorted by line item effective date.

Path Params

account_id

string

required

ID of the Account

Query Params

limit

integer

The maximum number of line items to be returned. Defaults to 100.

starting_after

string

Pass the value from the paging response body in your previous request. If not provided, the zero-indexed starting point will be used. Either starting_after or ending_before may be provided, but not both.

ending_before

string

line_item_status

string

Comma-separated list of line item statuses to filter by (no whitespaces).
Allowed values are: AUTHORIZED, DECLINED, INVALID, OFFSET, PENDING, POSTED, PROCESSING, RETRO_VALID, REVERSED, ROLLED, SETTLED, SPLIT_INVALID, SPLIT_VALID, VALID, or VOID

line_item_type

string

Comma-separated list of line item types to filter by (no whitespaces).
Allowed values are: CHARGE, PAYMENT, CREDIT_OFFSET, DEBIT_OFFSET, MANUAL_FEE

updated_at_after

date-time

Returns line items with an 'updated_at' date more recent (or equal) than the timestamp passed as a value. Due to format constraints, it is highly recommended to encodeURIComponent() the value before passing it as a query parameter

updated_at_before

date-time

Returns line items with an 'updated_at' date older (or equal) than the timestamp passed as a value. Due to format constraints, it is highly recommended to encodeURIComponent() the value before passing it as a query parameter

effective_at_after

date-time

Returns line items with an 'effective_at' date more recent (or equal) than the timestamp passed as a value. Due to format constraints, it is highly recommended to encodeURIComponent() the value before passing it as a query parameter

effective_at_before

date-time

Returns line items with an 'effective_at' date older (or equal) than the timestamp passed as a value. Due to format constraints, it is highly recommended to encodeURIComponent() the value before passing it as a query parameter

min_original_amount_cents

integer

Returns line items with an original amount greater (or equal) than the provided amount.

max_original_amount_cents

integer

Returns line items with an original amount lower (or equal) than the provided amount.

search_parameters

string

Searches by line_item_id or description. Based on the input search parameter, the top responses from our API search, up to or less than the provided limit will be returned.

Responses

401

Unauthorized.

403

Forbidden.

404

Line Items not found.

429

Too many requests.

default

Unexpected Error.

200Array of Line Items and their corresponding balances at their effective dates and times.