v1

latestOpenAPI 3.0.02026-07-14198572488.4 KB

Billing

Create Billing Address

Add a new address which can be associated with a payment method

post/v1/billing/addresses

Request body

first_namestring required

First name of the billing contact

last_namestring required

Last name of the billing contact

address_line_1string required

First Address line of the billing contact

address_line_2string

Second Address line of the billing contact

company_namestring

Company name of the billing contact

emailstring required

Email address of the billing contact

citystring required

City of the billing contact

statestring required

State / Province of the billing contact

countrystring required

Country Code of the billing contact

postal_codestring required

Postal code of the billing contact

telephonestring required

Telephone number of the billing contact

receive_invoice_emailsboolean

Setting to true will CC this email address on invoice emails

Example request

{
  "first_name": "Rocket",
  "last_name": "Billing-Contact",
  "address_line_1": "17885 SE Federal Hwy",
  "address_line_2": "Suite 100",
  "company_name": "Rocket.net",
  "email": "billing@rocket.net",
  "city": "Jupiter",
  "state": "FL",
  "country": "US",
  "postal_code": "33469",
  "telephone": "877-374-0764"
}

Response

successboolean

whether the request succeeded

errorsstring[]

messagesstring[] nullable

Example response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": 42,
    "first_name": "Rocket",
    "last_name": "Billing-Contact",
    "address_line_1": "17885 SE Federal Hwy",
    "address_line_2": "Suite 100",
    "company_name": "Rocket.net",
    "email": "billing@rocket.net",
    "city": "Jupiter",
    "state": "FL",
    "country": "US",
    "postal_code": "33469",
    "telephone": "877-374-0764"
  }
}