Sign in

v1

latestOpenAPI 3.0.32026-07-2488203535.0 KB
Customers

Add Billing Address

Add a new billing address to an existing customer.

post/v5/customers/{customer_id}/billing

Path parameters

customer_idstring required

The customer vault ID.

Request body

method'initial_recurring' | 'recurring' | 'installment'

Recurring or installment classification for the processor.

  • initial_recurring: First transaction in a recurring sequence only.
  • recurring: Later charges in that sequence.
  • installment: Installment transactions; use number and total on supported processors.

Which values apply depends on the processor.

numberinteger

Specify installment billing number, on supported processors. For use when billing.method is set to "installment"

totalnumber

Specify installment billing total on supported processors. For use when billing.method is set to "installment"

first_namestring

Cardholder's first name

last_namestring

Cardholder's last name

companystring

Cardholder's company

address1string

Card billing address

address2string

Card billing address, line 2

citystring

Card billing city

statestring

Card billing state. Format: CC

zipstring

Card billing zip code

countrystring

Card billing country. Country codes are as shown in ISO 3166-1 alpha-2. Format: CC

phonestring

Billing phone number

emailstring email

Billing email address

faxstring

Billing fax number

cell_phonestring

Billing cell phone number

websitestring

Website (invoice-specific field)

drivers_license_numberstring

Driver's license number

drivers_license_dobstring

Driver's license date of birth. Format: YYYY-MM-DD

drivers_license_statestring

Driver's license state. Format: CC

Response

Billing address added successfully

object'customer' required

Resource type identifier

idstring required

Customer vault ID

createdstring date-time nullable

Customer creation date in UTC ISO 8601 format