Appearance

List Invoices ​

Endpoint ​

http
GET /unified/subscription-management/invoices
Integrations supported
  • Chargebee
  • Chargify
  • PayPal
  • Stripe

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
created_at
string · date-time

Date and time when the invoice was created

Supported in
  • Chargebee
  • Chargify
  • PayPal
  • Stripe
updated_at
string · date-time

Date and time when the invoice was last updated

Supported in
  • Chargebee
  • Chargify
customer_id
string

Unique identifier for the customer

Supported in
  • Chargebee
  • Chargify
  • Stripe
status
string

Status of the invoice. In case there is no clear mapping, the raw status is passed.

All possible enum values:
  • cancelled
  • draft
  • failed
  • paid
  • pending
  • refunded
Supported in
  • Chargebee
  • Chargify
  • Stripe
number
string

Invoice number

Supported in
  • Chargify
subscription_id
string

Unique identifier for the subscription associated with the invoice

Supported in
  • Chargify
  • Stripe
sort_by
object

The field to sort the resource by. Should be in format { fieldName: direction }. The direction can be asc or desc.

Supported in
  • Chargebee
  • Chargify
created_at
string · date-time

Date and time when the invoice was created

All possible enum values:
  • asc
  • desc
Supported in
  • Chargebee
  • Chargify
updated_at
string · date-time

Date and time when the invoice was last updated

All possible enum values:
  • asc
  • desc
Supported in
  • Chargebee
  • Chargify
issue_date
string · date-time

Date of the invoice

All possible enum values:
  • asc
  • desc
Supported in
  • Chargify
due_date
string · date-time

Due date of the invoice

All possible enum values:
  • asc
  • desc
Supported in
  • Chargify
paid_on_date
string · date-time

Date when the invoice was paid or marked as paid

Supported in
  • Chargebee
due_date
string · date-time

Due date of the invoice

Supported in
  • Stripe

Response Body ​

result
object[]

List of Invoices

id
string
REQUIRED · 

Unique identifier for the invoice

Supported in
  • Chargebee
  • Chargify
  • PayPal
  • Stripe
customer
object
Supported in
  • Chargebee
  • Chargify
  • PayPal
  • Stripe
id
string

Unique identifier for the customer

name
string

Name of the customer

email
string

Email of the customer

phone
string

Phone number of the customer

created_at
string · date-time

Date and time when the customer was created

updated_at
string · date-time

Date and time when the customer was last updated

subscription_id
string

Unique identifier for the subscription associated with the invoice

Supported in
  • Chargebee
  • Chargify
  • Stripe
is_recurring
boolean

Whether the invoice is recurring or not

Supported in
  • Chargebee
status
string

Status of the invoice. In case there is no clear mapping, the raw status is passed.

All possible enum values:
  • pending
  • paid
  • failed
  • cancelled
  • refunded
  • draft
Supported in
  • Chargebee
  • Chargify
  • PayPal
  • Stripe
issue_date
string · date-time

Date of the invoice

Supported in
  • Chargebee
  • Chargify
  • PayPal
due_date
string · date-time

Due date of the invoice

Supported in
  • Chargebee
  • Chargify
  • PayPal
  • Stripe
paid_on_date
string · date-time

Date when the invoice was paid or marked as paid

Supported in
  • Chargebee
  • Chargify
  • PayPal
  • Stripe
transaction_fee
string

Transaction fee on a payment

Supported in
  • Stripe
number
string

Invoice number

Supported in
  • Chargebee
  • Chargify
  • PayPal
  • Stripe
currency
string

Currency of the invoice

Supported in
  • Chargebee
  • Chargify
  • PayPal
  • Stripe
exchange_rate
number

Exchange rate of the currency of the invoice

Supported in
  • Chargebee
total_discount
string

Total discount applied to the invoice

Supported in
  • Chargebee
  • Chargify
  • PayPal
  • Stripe
sub_total
string

Sub total of the invoice

Supported in
  • Chargebee
  • Chargify
  • PayPal
  • Stripe
total_tax_amount
string

Total tax amount of the invoice

Supported in
  • Chargebee
  • Chargify
  • PayPal
  • Stripe
balance
string

Balance amount to be paid

Supported in
  • Chargebee
  • Chargify
  • PayPal
  • Stripe
payments
object[]

List of payments associated with the invoice

Supported in
  • Chargebee
  • Chargify
  • PayPal
id
string

Unique identifier for the payment

method
string

Payment method used for the payment. In case there is no clear mapping, the raw payment method is passed.

All possible enum values:
  • card
  • bank_transfer
  • cash
  • check
  • paypal
  • wallet
  • wire_transfer
status
string

Status of the payment. In case there is no clear mapping, the raw status is passed.

All possible enum values:
  • pending
  • authorized
  • paid
  • partial
  • refunded
  • voided
  • cancelled
  • unknown
amount
string

Amount of the payment

currency
string

Currency of the payment

exchange_rate
number

Exchange rate of the currency of the payment

created_at
string · date-time

Date and time when the payment was created

updated_at
string · date-time

Date and time when the payment was last updated

line_items
object[]

List of line items associated with the invoice

Supported in
  • Chargebee
  • Chargify
  • PayPal
  • Stripe
id
string

The unique identifier for line item

name
string

The name of the line item

description
string

The description of the line item

item
string

The ID of the item

quantity
number

The quantity of the line item

unit_price
string

The unit price of the line item

tax_rate
string

The ID of the tax rate

tax_amount
string

The tax amount of the line item

total_line_amount
string

The total line amount of the line item.

type
string

The type of the line item

currency
string

The currency of the line item

exchange_rate
number

The exchange rate of the currency for the line item

memo
string

Memo of the invoice

Supported in
  • Chargify
created_at
string · date-time

Date and time when the invoice was created

Supported in
  • Chargebee
  • Chargify
  • PayPal
  • Stripe
updated_at
string · date-time

Date and time when the invoice was last updated

Supported in
  • Chargebee
  • PayPal
remote_data
object

Raw data returned from the remote API call.

next_cursor
string

The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.