List Payments
Lists payments, newest first. Without filters this is every payment the caller can read: a company credential's own account, or for a user every account they can read payments for. Filters narrow by account, buyer, product, plan, membership, status, billing reason, currency, and creation window. Filtering by billing_reason=subscription_cycle also matches renewals recorded as subscription_update. settlement_time_at is null on list rows — retrieve the payment for it.
Query parameters
Only payments charged by this account, prefixed biz_.
Only payments in this lifecycle state.
Only payments charged for this reason.
Only payments presented in this three-letter currency, such as usd.
Only payments made by this buyer, prefixed user_.
Search payments by user ID, membership ID, user email, name, or username. Email filtering requires the member:email:read permission.
Search payments by user ID, membership ID, user email, name, or username. Email filtering requires the member:email:read permission.
Only payments made by this member, prefixed mber_.
Only payments billed under this membership, prefixed mem_.
Only payments for this product, prefixed prod_.
Only payments priced by this plan, prefixed plan_.
Only payments created before this ISO 8601 timestamp.
Only payments created after this ISO 8601 timestamp.
The field to sort by.
The sort direction.
Number of results to return from the start of the range.
Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.
Number of results to return from the end of the range.
Return results before this cursor. Use page_info.start_cursor from the previous response to fetch the previous page.
Response
payments listed
Example response
{
"data": [
{
"account_id": "biz_xxxxxxxxxxxxxx",
"amount_after_fees": {
"amount": "-2.50",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
},
"billing_address": {
"city": "Austin",
"country": "US",
"line1": "1114 Bouldin Ave",
"line2": "Unit B",
"name": "Dana Whitfield",
"postal_code": "78704",
"state": "TX"
},
"billing_reason": "subscription_create",
"client_secret": "pay_xxxxxxxxxxxxxx_secret_vdefault_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"created_at": "2026-01-01T12:00:00.000Z",
"currency": "usd",
"customer_email": "marcus@shinetime.example",
"customer_phone": "+xxxxxxxxxxx",
"decline_code": "insufficient_funds",
"id": "pay_xxxxxxxxxxxxxx",
"line_items": [
{
"id": "li_xxxxxxxxxxxxxx",
"label": "Ceramic Coating Package",
"plan_id": "plan_xxxxxxxxxxxxxx",
"plan_title": "Ceramic Coating — Full Vehicle",
"product_id": "prod_xxxxxxxxxxxxxx",
"product_title": "Ceramic Coating Package",
"quantity": 1,
"subtotal": {
"amount": "-2.50",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
}
}
],
"member_id": "mber_xxxxxxxxxxxxxx",
"membership_id": "mem_xxxxxxxxxxxxxx",
"metadata": {
"order_ref": "SHINE-4417"
},
"paid_at": "2026-01-01T12:00:00.000Z",
"payment_instrument": {
"card": {
"brand": "visa",
"issuer_identification_number": "41111111",
"last4": "4242"
},
"display_name": "Visa •••• 4242",
"icons": {
"card": {
"dark": {
"png_1x": "https://content.whop.com/payment_methods/visa/icons/card_dark_30.png",
"png_2x": "https://content.whop.com/payment_methods/visa/icons/card_dark_60.png",
"png_4x": "https://content.whop.com/payment_methods/visa/icons/card_dark_120.png",
"svg": "https://content.whop.com/payment_methods/visa/icons/card_dark.svg"
},
"light": {
"png_1x": "https://content.whop.com/payment_methods/visa/icons/card_dark_30.png",
"png_2x": "https://content.whop.com/payment_methods/visa/icons/card_dark_60.png",
"png_4x": "https://content.whop.com/payment_methods/visa/icons/card_dark_120.png",
"svg": "https://content.whop.com/payment_methods/visa/icons/card_dark.svg"
}
},
"square": {
"dark": {
"png_1x": "https://content.whop.com/payment_methods/visa/icons/card_dark_30.png",
"png_2x": "https://content.whop.com/payment_methods/visa/icons/card_dark_60.png",
"png_4x": "https://content.whop.com/payment_methods/visa/icons/card_dark_120.png",
"svg": "https://content.whop.com/payment_methods/visa/icons/card_dark.svg"
},
"light": {
"png_1x": "https://content.whop.com/payment_methods/visa/icons/card_dark_30.png",
"png_2x": "https://content.whop.com/payment_methods/visa/icons/card_dark_60.png",
"png_4x": "https://content.whop.com/payment_methods/visa/icons/card_dark_120.png",
"svg": "https://content.whop.com/payment_methods/visa/icons/card_dark.svg"
}
}
},
"payment_method_type": "card"
},
"payment_method_id": "payt_xxxxxxxxxxxxxx",
"payment_method_type": "acss_debit",
"payment_rule_matches": [
{
"action": "allow"
}
],
"plan_id": "plan_xxxxxxxxxxxxxx",
"presentment_total": {
"amount": "-2.50",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
},
"product_id": "prod_xxxxxxxxxxxxxx",
"refunded_amount": {
"amount": "-2.50",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
},
"retryable": true,
"shipping_address": {
"city": "Austin",
"country": "US",
"line1": "1114 Bouldin Ave",
"line2": "Unit B",
"name": "Dana Whitfield",
"postal_code": "78704",
"state": "TX"
},
"status": "draft",
"substatus": "succeeded",
"subtotal": {
"amount": "-2.50",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
},
"tax_amount": {
"amount": "-2.50",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
},
"tax_behavior": "exclusive",
"tax_refunded_amount": {
"amount": "-2.50",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
},
"total": {
"amount": "-2.50",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
},
"updated_at": "2026-01-01T12:00:00.000Z",
"usd_total": {
"amount": "-2.50",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
},
"user": {
"id": "user_xxxxxxxxxxxxxx",
"name": "Dana Whitfield",
"profile_picture": {
"url": "https://ui-avatars.com/api/"
},
"username": "danawhitfield"
},
"verification_checks": {
"address_line1": "PASS",
"card_holder_name": "PASS",
"card_security_code": "PASS",
"zip_code": "PASS"
}
}
],
"page_info": {
"start_cursor": "WyJjdXJzb3IiLDFd"
}
}