Skip to main content
GET
/
v1
/
c
/
customer
/
{customer_id}
returns a customer by id
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

​
wb-key
string
header
required

Path Parameters

​
customer_id
string
required

Response

200 - application/json

Customer

Customer detailed information

​
created
string
required

Date created

​
emails
object
required

Email addresses associated with this customer

​
id
string
required

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

Example:

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

​
metadata
object
required

Key-value customer metadata with string values.

​
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
​
address
object

Physical address. Used by both Customer and WbCustomer entities.

​
contracts
object[] | null

Contracts signed by this Customer

​
customer_reference
string | null

Customer Reference. May contain a reference to an external system

​
name
string | null

Customer Name

​
notes
string | null

Customer notes

​
tax_details
object

Extra information that impacts customer's taxation