Search for Customers

Authorizations

wb-key

string

header

required

Query Parameters

string

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

string | null

customer_reference

string | null

plan

string

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

status

string | null

listed

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

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

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

hits.created

string

required

Date created

hits.emails

object

required

Email addresses associated with this customer

hits.id

string

required

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

hits.metadata

object

required

Key-value customer metadata with string values.

hits.status

enum<string>

required

Status of the Customer

Active - customer is active
Inactive - Customer account was deactivated
Temporary - Customer was created, but registration process was not completed

Available options:

active,

inactive,

temporary

hits.address

object

Physical address. Used by both Customer and WbCustomer entities.

hits.contracts

object[] | null

Contracts signed by this Customer

hits.contracts.amount

string

requireddeprecated

Contract estimated price

hits.contracts.billing_information

object

required

Detailed information about the current billing period

hits.contracts.configuration

object

required

Additional Contract-level billing configuration

hits.contracts.cost_estimates

object

required

Price estimate

hits.contracts.cost_estimates.custom_cycle_charges

object

required

Charges for features on a custom cycle

hits.contracts.cost_estimates.on_demand_price

object

required

Detailed breakdown of the estimated charges

hits.contracts.cost_estimates.one_time_price

object

required

Detailed breakdown of the estimated charges

hits.contracts.cost_estimates.recurring_price

object

required

Detailed breakdown of the estimated charges

hits.contracts.currency

enum<string>

required

A supported currency

The format for parsing and reading is the lowercased ISO 4217 currency code (e.g. "usd")

Available options:

usd,

eur,

gbp,

brl,

ars

hits.contracts.customer

string

required

Customer Name

hits.contracts.customer_id

string

required

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

hits.contracts.cycle

enum<string>

required

Enum that lists supported payment cycles for contracts:

Once - one-time payment
Constant - one-time payment for the duration of the contract
Week - contract is paid weekly
Month - contract is paid monthly
Quarter - contract is paid every quarter
Year - contract is paid yearly

Available options:

once,

hour,

day,

week,

month,

quarter,

year,

constant

hits.contracts.cycle_start_offset

integer

required

The number of days from the cycle's natural start (i.e. the first day of the week/month/quarter/year) to the start of the cycles

Required range: x > 0

hits.contracts.free_cycles

integer

required

The number of free cycles

Required range: x > 0

hits.contracts.id

string

required

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

hits.contracts.plan

string

required

Plan Name

hits.contracts.plan_id

string

required

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

hits.contracts.plan_internal_name

string

required

Internal Plan name

hits.contracts.status

enum<string>

required

Status of the contract:

Active - Contract is active
Pending - Contract is not active
Scheduled - Contract is scheduled to activate in the future
Canceled - Contract has been canceled
Moved - User upgraded from this contract to a different one
NotReady - Contract was created, but billing engine has not completed contract setup

Available options:

active,

pending,

scheduled,

canceled,

moved,

not_ready

hits.contracts.strategy

enum<string>

required

Pricing strategy of the Plan:

Plan - Plan itself contains a price, and it will be used.
Feature - Each feature in the plan is configured with a price, and final price of the plan is the combination of prices of all its features

Available options:

plan,

group,

feature

hits.contracts.activation

string | null

Contract Activation Date

hits.contracts.created

string | null

Date os signing

hits.contracts.expiration

string | null

Contract Expiration Date

hits.contracts.free_trial_end

string | null

Date of the end of the free trial, if any

hits.contracts.next_cycle_start

string | null

End date of the current cycle (if the contract is active)

hits.contracts.plan_external_name

string | null

External Plan name

hits.contracts.pricing_id

string

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

hits.customer_reference

string | null

Customer Reference. May contain a reference to an external system

hits.name

string | null

Customer Name

hits.notes

string | null

Customer notes

hits.tax_details

object

Extra information that impacts customer's taxation

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

Welcome

Guides

Wingback.js

Advanced

API Reference

Search for Customers

Authorizations

Query Parameters

Response