Welcome
Guides
Wingback.js
Advanced
curl --request GET \
--url http://127.0.0.1:8080/v1/c/customer/{customer_id} \
--header 'wb-key: <api-key>'{
"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>"
}
}Get Customer
Retrieve customer by id. The API returns customer and the contract that the customer is currently on
curl --request GET \
--url http://127.0.0.1:8080/v1/c/customer/{customer_id} \
--header 'wb-key: <api-key>'{
"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>"
}
}Authorizations
Path Parameters
Response
Customer
Customer detailed information
Date created
Unique identifier of an object. Consists of object class prefix and a UUID
"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670"
Status of the Customer
- Active - customer is active
- Inactive - Customer account was deactivated
- Temporary - Customer was created, but registration process was not completed
active, inactive, temporary Physical address. Used by both Customer and WbCustomer entities.
Show child attributes
Show child attributes
City name
ISO 3166 2-letter Country code
First line of address
Zip or Postal code
Second line of the address. Optional
State, or another appropriate administrative region Empty string value will be treated as NULL
Contracts signed by this Customer
Show child attributes
Show child attributes
Contract estimated price
Detailed information about the current billing period
Show child attributes
Show child attributes
Billing period of the contract. For example, for contracts that are paid monthly, a new billing period would be created each month. For Constant or Once contracts, a single period would be created with empty "end" value
Current billing period index (starting from 1, ascending)
Additional Contract-level billing configuration
Show child attributes
Show child attributes
Should invoice amount be charged automatically or not
Determines when the due_date of the invoices should be set when created:
- StartOfPeriod - invoices are due at the beginning of the billing period
- EndOfPeriod - invoices are due at the end of the billing period
start_of_period, end_of_period When the invoices should be created
Note: EveryCycle and Periodic aren't yet supported, they will behave as Manual
immediate Determines how usage period should be closed:
- Automatic - usage period will be closed as soon as claim period ends
- Manual - usage period will be open until closed manually
- Delayed - automatic with delay after the claim period ends. Valid delays are 15 minutes, 1 hour, 1 day
automatic, manual, 15 minutes, 1 hour, 1 day Price estimate
Show child attributes
Show child attributes
Charges for features on a custom cycle
Show child attributes
Show child attributes
Detailed breakdown of the estimated charges
Show child attributes
Show child attributes
Amount to be charged at the start of the given cycle
Amount to be charged at the end of the cycle (except usage)
Minimum amount of usage that will be charged
Detailed breakdown of the estimated charges
Show child attributes
Show child attributes
Amount to be charged at the start of the given cycle
Amount to be charged at the end of the cycle (except usage)
Minimum amount of usage that will be charged
Detailed breakdown of the estimated charges
Show child attributes
Show child attributes
Amount to be charged at the start of the given cycle
Amount to be charged at the end of the cycle (except usage)
Minimum amount of usage that will be charged
Detailed breakdown of the estimated charges
Show child attributes
Show child attributes
Amount to be charged at the start of the given cycle
Amount to be charged at the end of the cycle (except usage)
Minimum amount of usage that will be charged
Detailed breakdown of the estimated charges
Show child attributes
Show child attributes
Amount to be charged at the start of the given cycle
Amount to be charged at the end of the cycle (except usage)
Minimum amount of usage that will be charged
Detailed breakdown of the estimated charges
Show child attributes
Show child attributes
Amount to be charged at the start of the given cycle
Amount to be charged at the end of the cycle (except usage)
Minimum amount of usage that will be charged
Detailed breakdown of the estimated charges
Show child attributes
Show child attributes
Amount to be charged at the start of the given cycle
Amount to be charged at the end of the cycle (except usage)
Minimum amount of usage that will be charged
Detailed breakdown of the estimated charges
Show child attributes
Show child attributes
Amount to be charged at the start of the given cycle
Amount to be charged at the end of the cycle (except usage)
Minimum amount of usage that will be charged
A supported currency
The format for parsing and reading is the lowercased ISO 4217 currency code (e.g. "usd")
usd, eur, gbp, brl, ars Customer Name
Unique identifier of an object. Consists of object class prefix and a UUID
"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670"
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
once, hour, day, week, month, quarter, year, constant 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
x >= 0The number of free cycles
x >= 0Unique identifier of an object. Consists of object class prefix and a UUID
"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670"
Plan Name
Unique identifier of an object. Consists of object class prefix and a UUID
"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670"
Internal Plan name
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
active, pending, scheduled, canceled, moved, not_ready 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
plan, group, feature Contract Activation Date
Date os signing
Contract Expiration Date
Date of the end of the free trial, if any
End date of the current cycle (if the contract is active)
External Plan name
Unique identifier of an object. Consists of object class prefix and a UUID
"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670"
Customer Reference. May contain a reference to an external system
Customer Name
Customer notes