Get customer

Retrieve a single customer by ID or alias.

GET /api/v1/customers/{id_or_alias}

Get customer

cURL

curl --request GET \
  --url https://api.example.com/api/v1/customers/{id_or_alias} \
  --header 'Authorization: Bearer <token>'

200

{
  "currency": "EUR",
  "custom_properties": "<unknown>",
  "custom_taxes": [
    {
      "name": "<string>",
      "rate": "<string>",
      "tax_code": "<string>"
    }
  ],
  "id": "cus_7n42DGM5Tflk9n8mt7Fhc7",
  "invoicing_emails": [
    "<string>"
  ],
  "invoicing_entity_id": "ive_7n42DGM5Tflk9n8mt7Fhc7",
  "name": "<string>",
  "preferred_locales": [
    "<string>"
  ],
  "alias": "<string>",
  "billing_address": {
    "city": "<string>",
    "country": "US",
    "line1": "<string>",
    "line2": "<string>",
    "state": "<string>",
    "zip_code": "<string>"
  },
  "billing_email": "<string>",
  "buyer_reference": "<string>",
  "connected_account_id": "<string>",
  "customer_type": "COMPANY",
  "first_name": "<string>",
  "invoicing_language": "<string>",
  "last_name": "<string>",
  "legal_number": "<string>",
  "phone": "<string>",
  "shipping_address": {
    "same_as_billing": true,
    "address": {
      "city": "<string>",
      "country": "US",
      "line1": "<string>",
      "line2": "<string>",
      "state": "<string>",
      "zip_code": "<string>"
    }
  },
  "vat_number": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id_or_alias · string · required

customer ID or alias

Response

200

application/json

Customer

currency · enum<string> · required

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

Example:

"EUR"

custom_properties · any · required

User-defined custom property values, keyed by definition key.

custom_taxes · object[] · required

Show child attributes

id · string<MeteroidId> · required

Example:

"cus_7n42DGM5Tflk9n8mt7Fhc7"

invoicing_emails · string[] · required

invoicing_entity_id · string<MeteroidId> · required

Example:

"ive_7n42DGM5Tflk9n8mt7Fhc7"

name · string · required

preferred_locales · string[] · required

Preferred document languages, most-preferred first (BCP-47 tags, e.g. ["fr-FR", "en"]); overrides the invoicing entity default.

alias · string | null

billing_address · object | null

Show child attributes

billing_email · string | null

buyer_reference · string | null

BT-10 — the reference the buyer routes invoices by (a Leitweg-ID for German public bodies). Required by XRechnung.

connected_account_id · string | null

customer_type · enum<string>

Company vs. individual (B2C). Defaults to COMPANY.

Available options: COMPANY, INDIVIDUAL

first_name · string | null

invoicing_language · string | null · deprecated

Deprecated: the first entry of preferred_locales.

last_name · string | null

legal_number · string | null

BT-47 — the buyer's national register identifier (SIREN/SIRET, HRB).

phone · string | null

shipping_address · object | null

Show child attributes

vat_number · string | null