Skip to main content
GET
/
v1
/
c
/
customer
returns customers filtered by query string parameters
curl --request GET \
  --url http://127.0.0.1:8080/v1/c/customer \
  --header 'wb-key: <api-key>'
{
  "current_page": 123,
  "hits": [
    {
      "created": "<string>",
      "emails": {},
      "id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
      "metadata": {},
      "status": "active",
      "address": {
        "city": "<string>",
        "country": "<string>",
        "line_1": "<string>",
        "zip": "<string>",
        "line_2": "<string>",
        "state": "<string>"
      },
      "contracts": [
        {
          "amount": "<string>",
          "billing_information": {
            "current_period": {
              "end": "2023-11-07T05:31:56Z",
              "start": "2023-11-07T05:31:56Z"
            },
            "current_period_idx": 123
          },
          "configuration": {
            "automatic_payment": true,
            "due_date_policy": "start_of_period",
            "invoice_trigger": "immediate",
            "usage_period_closing_policy": "automatic"
          },
          "cost_estimates": {
            "custom_cycle_charges": {
              "periodic_daily": {
                "cycle_start_charges": "<string>",
                "extra_cycle_end_charges": "<string>",
                "minimum_usage": "<string>"
              },
              "periodic_monthly": {
                "cycle_start_charges": "<string>",
                "extra_cycle_end_charges": "<string>",
                "minimum_usage": "<string>"
              },
              "periodic_quarterly": {
                "cycle_start_charges": "<string>",
                "extra_cycle_end_charges": "<string>",
                "minimum_usage": "<string>"
              },
              "periodic_weekly": {
                "cycle_start_charges": "<string>",
                "extra_cycle_end_charges": "<string>",
                "minimum_usage": "<string>"
              },
              "periodic_yearly": {
                "cycle_start_charges": "<string>",
                "extra_cycle_end_charges": "<string>",
                "minimum_usage": "<string>"
              }
            },
            "on_demand_price": {
              "cycle_start_charges": "<string>",
              "extra_cycle_end_charges": "<string>",
              "minimum_usage": "<string>"
            },
            "one_time_price": {
              "cycle_start_charges": "<string>",
              "extra_cycle_end_charges": "<string>",
              "minimum_usage": "<string>"
            },
            "recurring_price": {
              "cycle_start_charges": "<string>",
              "extra_cycle_end_charges": "<string>",
              "minimum_usage": "<string>"
            }
          },
          "currency": "usd",
          "customer": "<string>",
          "customer_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
          "cycle": "once",
          "cycle_start_offset": 1,
          "free_cycles": 1,
          "id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
          "plan": "<string>",
          "plan_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
          "plan_internal_name": "<string>",
          "status": "active",
          "strategy": "plan",
          "activation": "2023-11-07T05:31:56Z",
          "created": "2023-11-07T05:31:56Z",
          "expiration": "2023-11-07T05:31:56Z",
          "free_trial_end": "2023-11-07T05:31:56Z",
          "next_cycle_start": "2023-11-07T05:31:56Z",
          "plan_external_name": "<string>",
          "pricing_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670"
        }
      ],
      "customer_reference": "<string>",
      "name": "<string>",
      "notes": "<string>",
      "tax_details": {
        "vat_id": "<string>"
      }
    }
  ],
  "total": 123,
  "total_pages": 123,
  "backward": "<string>",
  "first": "<string>",
  "forward": "<string>",
  "last": "<string>"
}

Authorizations

​
wb-key
string
header
required

Query Parameters

​
id
string

Unique identifier of an object. Consists of object class prefix and a UUID

Example:

"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670"

​
email
string | null
​
customer_reference
string | null
​
plan
string

Unique identifier of an object. Consists of object class prefix and a UUID

Example:

"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670"

​
status
string | null
​
listed
string | null
​
search
string | null
​
contract_plan_name
string | null
​
payment_status
enum<string>

Status of the invoice:

  • PendingValidation - Invoice awaits manual review
  • ReadyForPayment - invoice can be paid
  • Paid - invoice was paid
Available options:
pending_validation,
ready_for_payment,
paid
​
metadata

Filter for customer metadata.

​
limit
integer<int32>
Required range: x >= 0
​
offset
string | null
​
direction
enum<string>

Pagination direction:

  • Forward - from first entry to last
  • Backward - from last entry to first
Available options:
forward,
backward

Response

200 - application/json

Customers

A paginated result of the requested resource This is based on Keyset Pagination https://vladmihalcea.com/sql-seek-keyset-pagination/

​
current_page
integer
required

Number of the current page

​
hits
object[]
required
​
total
integer
required

Total number of results

​
total_pages
integer
required

Number of pages in the result

​
backward
string

Index of the previous page in the result set

​
first
string

Index of the first element in the result set

​
forward
string

Index of the next page in the result set

​
last
string

Index of the last element in the result set