New Customer

post

https://api.paysimple.com/v4/customer

Creates a new customer object

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Customer Response

All fields in the request are returned in the response, with the addition of the following properties:

Property	Type	Description
Id	number (integer)	Uniquely identifies customer in all API requests and responses (elsewhere `CustomerId`)
LastModified	string (formatted as UTC ISO8601 datetime)	Date and time the customer was last modified
CreatedOn	string (formatted as UTC ISO8601 datetime)	Date and time the customer was created

Body Params

FirstName

string

Required. 100 characters max.

LastName

string

Required. 100 characters max.

ShippingSameAsBilling

boolean

Defaults to true

Required. Set to true to indicate that there is no separate shipping address, even if you are not including a billing address. Set to false to require ShippingAddress fields.

BillingAddress

object

Billing address is not required, but if included all its attributes are required except StreetAddress2, StateCode,” and Country. From 5 to 10 characters of any type is valid for ZipCode.

ShippingAddress

object

Not required if ShippingSameAsBilling is set to true, but if included all its attributes are required except StreetAddress2, StateCode, and Country. From 5 to 10 characters of any type is valid for ZipCode.

Company

string

Optional. 50 characters max.

CustomerAccount

string

Optional. 28 characters max. Useful for assigning non-PaySimple Id to the customer for future reference.

Phone

string

Optional.10 characters max, enter as a numeric string; do not include parenthesis or dashes.

AltPhone

string

Optional.10 characters max, enter as a numeric string; do not include parenthesis or dashes.

MobilePhone

string

Optional.10 characters max, enter as a numeric string; do not include parenthesis or dashes.

Fax

string

Optional.10 characters max, enter as a numeric string; do not include parenthesis or dashes.

string

Optional. 100 characters max, must be a valid email address.

AltEmail

string

Optional. 100 characters max, must be a valid email address.

Website

string

Optional. 100 characters max, must be in URL format.

Notes

string

Optional. 2048 characters max. Open text field.

Responses

Customer Response

201201

400400