Appearance

List Payments ​

Endpoint ​

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

Query parameters ​

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
invoice_id
string
The ID of the invoice to fetch payments for
Supported in
  • Chargebee
created_at
string
Date and time when the payment was created
Required in
  • PayPal
Supported in
  • Chargebee
  • Stripe
updated_at
string
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 and time when the payment was last updated
All possible enum values:
  • asc
  • desc
Supported in
  • Chargebee
created_at
string
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 and time when the payment was created
Supported in
  • Chargebee
  • PayPal
  • Stripe
updated_at
string
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.