v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB

Customer

Replaces the Customer resource.

put/customers/{id}

Path parameters

idstring required

Resource identifier

Request body

idstring

Unique identifier for this customer note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "stripe-5050"

integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

srcIdstring

The unique identifier of the source 3rd party integration e.g. "50"

emailstring nullable

Email address for the customer e.g. "janedoe@email.com"

namestring nullable

Full name of the customer e.g. "Jane Doe"

givenNamestring nullable

First name of the customer e.g. "Jane"

familyNamestring nullable

Last name of the customer e.g. "Doe"

companyNamestring nullable

Name of the company the customer is working on e.g. "Acme Corp."

fullyQualifiedNamestring nullable

Fully qualified name of the company the customer is working on e.g. "Acme Corporation"

addressstring nullable

First line of customer address e.g. "708 Woodland Avenue"

addressLine2string nullable

Second line of customer address e.g. "Unit 105"

citystring nullable

City of the address e.g. "St Paul"

postalCodestring nullable

Postal code of the address * e.g. "99660"

countrystring nullable

Country of the address * e.g. "United States"

billingAddressstring nullable

Billing address line 1 e.g. "4348 Candlelight Drive"

billingAddressLine2string nullable

Billing address line 2 e.g. "Apartment 78"

billingCitystring nullable

Billing address city e.g. "Panama City"

billingStatestring nullable

Billing address state or province e.g. "Florida"

billingPostalCodestring nullable

Billing address postal code e.g. "32417"

billingCountrystring nullable

Billing address country e.g. "United States"

phonestring nullable

Phone number e.g. "281-381-4241"

mobilestring nullable

Mobile number e.g. "786-258-0182"

faxstring nullable

Fax number e.g. "281-381-4255"

ddistring nullable

Direct dial number e.g. "5050"

balanceinteger nullable

Balance owed by customer in cents e.g. 19999

currencystring nullable

Currency used by customer e.g. "USD"

taxableboolean nullable

Taxable status

customerAccountStatusstring nullable

Accounting status of the customer e.g. "Enabled"

monthlyRecurringRevenueinteger nullable

Monthly recurring revenue in cents e.g. 4500000

netMonthlyRecurringRevenueinteger nullable

Net monthly recurring revenue e.g. 2500000

createdstring date-time nullable

Date of customer account creation e.g. "2013-11-18T02:17:40.080Z"

modifiedstring date-time nullable

Date entry was last modified e.g. "2013-11-22T02:17:40.080Z"

titlestring nullable

Job title of the customer e.g. "Manager"

departmentstring nullable

Department where customer works in e.g. "Administrative office"

customerOwnerstring nullable

User in touch with the customer e.g. "josh_jameson"

descriptionstring nullable

A note about the customer e.g. "Great customer"

totalSpentinteger nullable

Total spent by customer in cents e.g. 76000

acceptsMarketingboolean nullable

Whether the customer has consented to receiving promotional emails

usernamestring nullable

Username of the customer e.g. "jane_doe123"

taxTypestring nullable

Tax type applied for the customer e.g. "Global"

bankAccountNamestring nullable

Bank account name for the customer e.g. "Business Bank Account"

bankAccountNumberstring nullable

Bank account number for the customer e.g. "123654"

termIdstring nullable

Reference to a Term object (payment terms) associated with this Customer e.g. "1d80716b-427e-4cad-80c6-c4b3a18eb23d"

termDaysinteger nullable

The days value of the payment terms for this Customer e.g. "15"

termTypestring nullable

The type of the payment terms for this Customer e.g. "DAYSAFTERBILLDATE"

Example request

{
  "id": "stripe-5050",
  "integration": "quickbooks",
  "srcId": "50",
  "email": "janedoe@email.com",
  "name": "Jane Doe",
  "givenName": "Jane",
  "familyName": "Doe",
  "companyName": "Acme Corp.",
  "fullyQualifiedName": "Acme Corporation",
  "address": "708 Woodland Avenue",
  "addressLine2": "Unit 105",
  "city": "St Paul",
  "postalCode": "99660",
  "country": "United States",
  "billingAddress": "4348 Candlelight Drive",
  "billingAddressLine2": "Apartment 78",
  "billingCity": "Panama City",
  "billingState": "Florida",
  "billingPostalCode": "32417",
  "billingCountry": "United States",
  "phone": "281-381-4241",
  "mobile": "786-258-0182",
  "fax": "281-381-4255",
  "ddi": "5050",
  "balance": 19999,
  "currency": "USD",
  "taxable": true,
  "customerAccountStatus": "Enabled",
  "monthlyRecurringRevenue": 4500000,
  "netMonthlyRecurringRevenue": 2500000,
  "created": "2013-11-18T02:17:40.080Z",
  "modified": "2013-11-22T02:17:40.080Z",
  "title": "Manager",
  "department": "Administrative office",
  "customerOwner": "josh_jameson",
  "description": "Great customer",
  "totalSpent": 76000,
  "acceptsMarketing": true,
  "username": "jane_doe123",
  "taxType": "Global",
  "bankAccountName": "Business Bank Account",
  "bankAccountNumber": "123654",
  "termId": "1d80716b-427e-4cad-80c6-c4b3a18eb23d",
  "termType": "DAYSAFTERBILLDATE"
}

Response

Customer resource updated