Appearance

List Payments ​

Endpoint ​

http
GET /unified/subscription-management/payments
Integrations supported
  • Chargebee
  • 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
invoice_id
string

The ID of the invoice to fetch payments for

Supported in
  • Chargebee
created_at
string · date-time

Date and time when the payment was created

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

Date and time when the payment was last updated

Supported in
  • Chargebee
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
updated_at
string · date-time

Date and time when the payment was last updated

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

Date and time when the payment was created

All possible enum values:
  • asc
  • desc
Supported in
  • Chargebee

Response Body ​

result
object[]

List of Payments

id
string

Unique identifier for the payment

Supported in
  • Chargebee
  • PayPal
  • Stripe
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
Supported in
  • Chargebee
  • Stripe
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
Supported in
  • Chargebee
  • PayPal
  • Stripe
amount
string

Amount of the payment

Supported in
  • Chargebee
  • PayPal
  • Stripe
transaction_fee
string

Transaction fee on a payment

Supported in
  • PayPal
  • Stripe
refund_amount
string

Refund amount of the payment

Supported in
  • Stripe
currency
string

Currency of the payment

Supported in
  • Chargebee
  • PayPal
  • Stripe
exchange_rate
number

Exchange rate of the currency of the payment

Supported in
  • Chargebee
invoice_id
string

ID of the invoice the payment is for

Supported in
  • Chargebee
  • PayPal
  • Stripe
created_at
string · date-time

Date and time when the payment was created

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

Date and time when the payment 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.