Global search

Search across payments, customers, subscriptions, and gateways. Results are filtered by the caller's permissions.

get/search

Query parameters

qstring required

Example:john@example.com

Search query string to find matching payments, customers, subscriptions, invoices, and prices

Response

Example response

{
  "payments": [
    {
      "id": "pay_2abc3def4ghi5jkl",
      "label": "john@example.com",
      "sublabel": "John Doe"
    }
  ],
  "customers": [
    {
      "id": "pay_2abc3def4ghi5jkl",
      "label": "john@example.com",
      "sublabel": "John Doe"
    }
  ],
  "subscriptions": [
    {
      "id": "pay_2abc3def4ghi5jkl",
      "label": "john@example.com",
      "sublabel": "John Doe"
    }
  ],
  "invoices": [
    {
      "id": "pay_2abc3def4ghi5jkl",
      "label": "john@example.com",
      "sublabel": "John Doe"
    }
  ],
  "prices": [
    {
      "id": "pay_2abc3def4ghi5jkl",
      "label": "john@example.com",
      "sublabel": "John Doe"
    }
  ]
}

Changes

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