Welcome
Guides
Wingback.js
Advanced
API Reference
- Introduction
- Customer
- Contract
- Billing Portal
- Entitlements
- Usage
- Payment
- Balance
- Virtual Wallets (Credits)
- Invoices
Customer
Search for Customers
Returns customers filtered by query string parameters. Atleast one variable must be provided to do the search. All the customers meeting the search criteria will be returned
GET
/
v1
/
c
/
customer
Copy
curl --request GET \
--url http://127.0.0.1:8080/v1/c/customer \
--header 'wb-key: <api-key>'
Copy
{
"backward": "<string>",
"current_page": 123,
"first": "<string>",
"forward": "<string>",
"hits": [
{
"address": {
"city": "<string>",
"country": "<string>",
"line_1": "<string>",
"line_2": "<string>",
"state": "<string>",
"zip": "<string>"
},
"contracts": [
{
"activation": "2023-11-07T05:31:56Z",
"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>"
}
},
"created": "2023-11-07T05:31:56Z",
"currency": "usd",
"customer": "<string>",
"customer_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"cycle": "once",
"cycle_start_offset": 1,
"expiration": "2023-11-07T05:31:56Z",
"free_cycles": 1,
"free_trial_end": "2023-11-07T05:31:56Z",
"id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"next_cycle_start": "2023-11-07T05:31:56Z",
"plan": "<string>",
"plan_external_name": "<string>",
"plan_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"plan_internal_name": "<string>",
"pricing_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"status": "active",
"strategy": "plan"
}
],
"created": "<string>",
"customer_reference": "<string>",
"emails": {},
"id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"metadata": {},
"name": "<string>",
"notes": "<string>",
"status": "active",
"tax_details": {
"vat_id": "<string>"
}
}
],
"last": "<string>",
"total": 123,
"total_pages": 123
}
Authorizations
Query Parameters
Unique identifier of an object. Consists of object class prefix and a UUID
Example:
"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670"
Unique identifier of an object. Consists of object class prefix and a UUID
Example:
"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670"
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
Filter for customer metadata. metadata[0]=key1&metadata[1]=key2 (multiple keys present)
Required range:
x >= 0
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/
Copy
curl --request GET \
--url http://127.0.0.1:8080/v1/c/customer \
--header 'wb-key: <api-key>'
Copy
{
"backward": "<string>",
"current_page": 123,
"first": "<string>",
"forward": "<string>",
"hits": [
{
"address": {
"city": "<string>",
"country": "<string>",
"line_1": "<string>",
"line_2": "<string>",
"state": "<string>",
"zip": "<string>"
},
"contracts": [
{
"activation": "2023-11-07T05:31:56Z",
"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>"
}
},
"created": "2023-11-07T05:31:56Z",
"currency": "usd",
"customer": "<string>",
"customer_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"cycle": "once",
"cycle_start_offset": 1,
"expiration": "2023-11-07T05:31:56Z",
"free_cycles": 1,
"free_trial_end": "2023-11-07T05:31:56Z",
"id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"next_cycle_start": "2023-11-07T05:31:56Z",
"plan": "<string>",
"plan_external_name": "<string>",
"plan_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"plan_internal_name": "<string>",
"pricing_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"status": "active",
"strategy": "plan"
}
],
"created": "<string>",
"customer_reference": "<string>",
"emails": {},
"id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"metadata": {},
"name": "<string>",
"notes": "<string>",
"status": "active",
"tax_details": {
"vat_id": "<string>"
}
}
],
"last": "<string>",
"total": 123,
"total_pages": 123
}
Assistant
Responses are generated using AI and may contain mistakes.