Sign in

v1

latestOpenAPI 3.0.02026-07-263403911.5 MB
Customers

View customer

Find a single customer by ID.

get/v1/Customers/{id}

Path parameters

idinteger required

Format - int32. ID of the customer to view.

Response

OK

okboolean
currency_code'USD' | 'AFN' | 'DZD' | 'ARS' | 'AMD' | 'AWG' | 'AUD' | 'AZN' | 'BSD' | 'BHD' | 'THB' | 'PAB' | 'BBD' | 'BYN' | 'BZD' | 'BMD' | 'VEF' | 'BOB' | 'BRL' | 'BND' | 'BGN' | 'BIF' | 'CVE' | 'CAD' | 'KYD' | 'XOF' | 'XAF' | 'XPF' | 'CLP' | 'COP' | 'KMF' | 'CDF' | 'BAM' | 'NIO' | 'CRC' | 'CUP' | 'CZK' | 'GMD' | 'DKK' | 'MKD' | 'DJF' | 'STD' | 'DOP' | 'VND' | 'XCD' | 'EGP' | 'SVC' | 'ETB' | 'EUR' | 'FKP' | 'FJD' | 'HUF' | 'GHS' | 'GIP' | 'HTG' | 'PYG' | 'GNF' | 'GYD' | 'HKD' | 'UAH' | 'ISK' | 'INR' | 'IRR' | 'IQD' | 'JMD' | 'JOD' | 'KES' | 'PGK' | 'LAK' | 'HRK' | 'KWD' | 'AOA' | 'MMK' | 'GEL' | 'LBP' | 'ALL' | 'HNL' | 'SLL' | 'LRD' | 'LYD' | 'SZL' | 'LSL' | 'MGA' | 'MWK' | 'MYR' | 'MUR' | 'MXN' | 'MXV' | 'MDL' | 'MAD' | 'MZN' | 'BOV' | 'NGN' | 'ERN' | 'NAD' | 'NPR' | 'ANG' | 'ILS' | 'TWD' | 'NZD' | 'BTN' | 'KPW' | 'NOK' | 'MRO' | 'TOP' | 'PKR' | 'MOP' | 'CUC' | 'UYU' | 'PHP' | 'GBP' | 'BWP' | 'QAR' | 'GTQ' | 'ZAR' | 'OMR' | 'KHR' | 'RON' | 'MVR' | 'IDR' | 'RUB' | 'RWF' | 'SHP' | 'SAR' | 'RSD' | 'SCR' | 'SGD' | 'PEN' | 'SBD' | 'KGS' | 'SOS' | 'TJS' | 'SSP' | 'LKR' | 'SDG' | 'SRD' | 'SEK' | 'CHF' | 'SYP' | 'BDT' | 'WST' | 'TZS' | 'KZT' | 'TTD' | 'MNT' | 'TND' | 'TRY' | 'TMT' | 'AED' | 'UGX' | 'CLF' | 'COU' | 'UYI' | 'USN' | 'UZS' | 'VUV' | 'CHE' | 'CHW' | 'KRW' | 'YER' | 'JPY' | 'CNY' | 'ZMW' | 'ZWL' | 'PLN'

The three-letter currency code used by customer.

customer_idinteger

Primary identifier for this customer.

parent_customer_idinteger

Foreign identifier indicating a parent account.

account_numberstring

Customizable account identifier.

activated_datestring date-time

Date and time account activated.

agent_idinteger

Foreign identifier indicating association with an agent.

secondary_agent_idinteger

Additional foreign identifier indicating association with another agent (use agent_id first).

close_datestring date-time

Date and time account closed completely.

created_byinteger

Foreign identifier indicating user who created this.

created_datestring date-time

Date and time this account was created.

updated_datestring date-time

Date and time this account was updated.

emailstring

Primary contact email (or emails separated by comma).

is_parentboolean

Indicates account is a parent to other accounts.

registration_codestring

Unique security code needed for BillCenter.net registration.

security_pinstring

Pin, code, or password used to verify account ownership.

sold_byinteger

Foreign identifier indicating user who made the sale to end user.

sourcestring

Describes the system or method by which the account was created.

status'ALL' | 'PROSPECT' | 'PENDING' | 'CLOSED' | 'OPEN'

Current status of the account. NOTE: The ALL value is not currently supported.

suspendedboolean

Indicates whether this account is suspended or not.

suspended_datestring date-time

Date and time at least one service on the account went was marked as suspended.

culturestring

Culture used by customer.

prevent_closing_for_no_active_service_productsboolean

Indicates whether this account's status will change to Closed when there are no active service products.