comecerodocs
Customers

List a customer's payments

GET
/customers/{customer_id}/payments

Lists the payments made by a customer, oldest first. The list is offset-based: follow next_page_url or send offset.

Secret tokens, and limited tokens tied to the customer (for example after Log in a customer).

Authorization

headerAuthorizationBearer <token>

A secret, trusted or limited token. See Authentication.

Path Parameters

customer_id*string

The id of the customer. With a limited token from a customer login you can send me instead.

Query Parameters

limit?integer

How many items to return on one page, from 1 to 100. The default is 100. A value outside 1 to 100, or one that is not a whole number, is a 400.

Range1 <= value <= 100
Default100
offset?integer

For offset-based lists, how many items to skip before the page starts. Use next_page_offset or previous_page_offset from the page you have. A value that is not a whole number is a 400.

Range0 <= value
Default0
desc?boolean

Sort in descending order (newest, largest or last first) when true. The default is false. A value other than true or false is a 400.

Defaultfalse
sort_by?string

The date to sort by.

Default"date_created"
Value in"date_created""date_modified""date_completed"
status?string

Only payments with this status.

Value in"unpaid""scheduled""initiated""processing""pending""completed""failed""cancelled""refunded""retry"
reference?string

Only payments with this reference.

expand?string

Comma-separated child objects to return in full instead of as a URL, for example customer,payments. Use dot notation for nested objects (items.product), up to four levels deep. A single object takes up to 12 paths; a list takes up to 2, applied to every item. Extra paths are dropped without an error. See Expanding objects.

show?string

Comma-separated fields to return; all others are left out. Use dot notation for child fields (customer.email). You cannot send show and hide together (400). See Customizing output.

hide?string

Comma-separated fields to leave out of the response. Use dot notation for child fields (customer.email). You cannot send show and hide together (400). See Customizing output.

formatted?boolean

When true, the object also has a formatted child with amounts and dates as display text in the shopper's language and currency (for example $19.99 or November 7, 2026). The default is false. See Localized formatting.

Defaultfalse

Response Body

A page of the customer's payments.

application/json
  1. response

An offset-based list of payments.

total_items*integer

The number of payments in the whole list.

total_pages*integer

The number of pages.

current_page*integer

The page number of this page.

next_page_url*|

The URL of the next page, or null on the last page.

next_page_offset*|

The offset of the next page, or null.

previous_page_url*|

The URL of the previous page, or null on the first page.

previous_page_offset*|

The offset of the previous page, or null.

current_page_url*string

The URL of this page.

data*array<>

The payments on this page.

Example Request
curl -X GET 'https://api.comecero.com/api/v1/customers/string/payments'
Example Response
{  "total_items": 0,  "total_pages": 0,  "current_page": 1,  "next_page_url": null,  "next_page_offset": null,  "previous_page_url": null,  "previous_page_offset": null,  "current_page_url": "https://api.comecero.com/api/v1/customers/0091304300408CuoxY9Pf3/payments",  "data": []}

Delete a payment method DELETE

Deletes a saved payment method. For a card, the number is also removed from the vault. This cannot be undone. A customer with an active or trial subscription must keep at least one payment method, so deleting the last one is a `409`. Cancel the subscriptions first. Secret tokens, and limited tokens tied to the customer.

List a customer's refunds GET

Lists the refunds and chargebacks on a customer's payments, oldest first. The list is offset-based: follow `next_page_url` or send `offset`. Secret tokens, and limited tokens tied to the customer.