Appearance

Get Payments ​

Endpoint ​

http
GET /unified/subscription-management/payments/{id}
Integrations supported
  • Chargebee
  • Stripe

Path parameters ​

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

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_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

Response Body ​

id
string

Unique identifier for the payment

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

Amount of the payment

Supported in
  • Chargebee
  • Stripe
transaction_fee
string

Transaction fee on a payment

Supported in
  • Stripe
refund_amount
string

Refund amount of the payment

Supported in
  • Stripe
currency
string

Currency of the payment

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

Date and time when the payment was created

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

Date and time when the payment was last updated

Supported in
  • Chargebee
remote_data
object

Raw data returned from the remote API call.