REresolvepay
Charges

List charges

Return a paginated list of charges.

get/charges

Request

Query parameters

limitinteger

Limit the number of charges returned.

pagestring

Specify the page of charges returned.

searchstring

Search across supported charge fields.

Search is applied to charge and associated record values including: id, number, merchant_invoice.order_number, merchant_invoice.po_number, and customer/merchant identifying fields.

orderstring

Sort charges by field. Prefix with - for descending order.

Examples:

  • order=-created_at
  • order=amount
starting_atstring date-time

Return charges created at or after this timestamp.

ending_atstring date-time

Return charges created at or before this timestamp.

Response

A paginated list of charges.

countinteger
limitinteger
pageinteger

Example response

{
  "count": 1,
  "limit": 25,
  "page": 1,
  "results": [
    {
      "id": "PMMlaE5wbg0",
      "amount": 1000,
      "customer_id": "X50sgfRd",
      "captured": true,
      "captured_at": "2020-01-02T00:00:00.730Z",
      "created_at": "2020-01-01T00:00:00.730Z",
      "invoice_url": "https://example.com/invoice.pdf",
      "metadata": {
        "source": "checkout"
      },
      "number": "ch_100001",
      "terms": "net30",
      "updated_at": "2020-01-02T00:00:00.730Z",
      "merchant_invoice_id": "INabc123",
      "order_number": "5055",
      "po_number": "PO-555",
      "fee": 25.5
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.