Sign in

v3

latestSwagger 2.02026-08-067506752.0 MB
customer

Return a particular customer by id

get/v1/customer/{customerId}

Path parameters

customerIdstring required

Customer id

Response

successful operation

idstring required

unique id of customer

namestring required

name of customer

emailstring

email address for billing purposes

industrystring

industry that customer is in

source'ADP_MARKETPLACE' | 'SELF_SERVE' | 'SELF_SERVE_TEST' | 'SEQUOIA_ONE' | 'CONNECT'

source of customer signup

status'ACTIVE' | 'INACTIVE' | 'TRIAL' | 'CHURN' | 'PAYMENT_ERROR' required

current status

stripeCustomerIdstring

stripe customer id

salesforceAccountIdstring

salesforce account id

restrictedFeaturesstring[]

features that are restricted for the customer

disableAiboolean

customer has opted out of all use of AI -- no AI features may be enabled on any of their orgs

startDatestring date

initial date of billing

endDatestring date

end of service date for churning customers -- on or after this date, service should be disabled

nextInvoiceDatestring date

date of next invoice

orgCountinteger

number of orgs covered by this customer

primaryHeadCountinteger

number of total headcount across all orgs

secondaryHeadCountinteger

number of total headcount across all orgs

tertiaryHeadCountinteger

number of total headcount across all orgs

primaryHeadCountFilterstring

primary headcount filter - used for billing purposes

secondaryHeadCountFilterstring

secondary headcount filter - used for billing purposes

tertiaryHeadCountFilterstring

tertiary headcount filter - used for billing purposes

arrnumber

current ARR of the customer based on most recent invoice

trialStartDatestring date

date this customer begins their trial period

trialEndDatestring date

date this customer ends their trial period

stripeSubscriptionSync'SYNC' | 'DELETE'

Stripe subscription settings

createAtstring

created timestamp

createIdstring

created by

createBehalfIdstring

created on behalf of user id

updateAtstring

updated timestamp

updateIdstring

updated by

updateBehalfIdstring

last updated on behalf of user id

Example response

{
  "id": "588f7ee98f138b19220041a7",
  "billAddress": {
    "street1": "123 Anywhere Street",
    "street2": "Apt 6L",
    "street3": "Sixth Floor",
    "city": "New York",
    "state": "NY",
    "country": "NY",
    "postal": "10001"
  },
  "products": [
    {
      "productId": "588f7ee98f138b19220041a7"
    }
  ],
  "trialProducts": [
    {
      "productId": "588f7ee98f138b19220041a7"
    }
  ],
  "featureOptionOverrides": [
    {
      "name": "smart_fields"
    }
  ],
  "createAt": "2017-01-24T13:57:52Z",
  "createId": "588f7ee98f138b19220041a7",
  "createBehalfId": "588f7ee98f138b19220041a7",
  "createAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "updateAt": "2017-01-24T13:57:52Z",
  "updateId": "588f7ee98f138b19220041a7",
  "updateBehalfId": "588f7ee98f138b19220041a7",
  "updateAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  }
}