Docs
API reference/Customers

Customers

The people and companies you bill. Customers own saved cards, subscriptions and invoices.

The customer object

idstring
Prefixed cus_.
emailstring
namestring | null
phonestring | null
kennitalastring | null
Icelandic national or company id. Needed for bank-invoice collection.
external_idstring | null
Your own id. Usage events can reference it as external_customer_id.
vat_numberstring | null
billing_addressobject | null
line1, line2, city, postal_code, country.
default_payment_methodstring | null
The pm_ charged by subscriptions.
metadataobject
created_attimestamp
updated_attimestamp

Create a customer

POST/v1/customersSecret key

Body

emailstringrequired
namestring
phonestring
kennitalastring
external_idstring
Your own identifier, unique per customer.
vat_numberstring
billing_address_line1string
billing_address_line2string
billing_citystring
billing_postal_codestring
billing_countrystring
ISO 3166-1 alpha-2, for example IS.
metadataobject
curl https://api.borga.is/v1/customers \
  -H "Authorization: Bearer sk_test_…" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "anna@example.is",
    "name": "Anna Jónsdóttir",
    "kennitala": "0101302989",
    "external_id": "user_12345",
    "billing_address_line1": "Laugavegur 1",
    "billing_postal_code": "101",
    "billing_city": "Reykjavík",
    "billing_country": "IS"
  }'
Response
{
  "id": "cus_8Jk2Lm4Np6Qr8St0Uv2Wx4Yz",
  "email": "anna@example.is",
  "name": "Anna Jónsdóttir",
  "phone": null,
  "kennitala": "0101302989",
  "external_id": "user_12345",
  "vat_number": null,
  "billing_address": {
    "line1": "Laugavegur 1",
    "line2": null,
    "city": "Reykjavík",
    "postal_code": "101",
    "country": "IS"
  },
  "metadata": {},
  "default_payment_method": null,
  "created_at": "2026-09-07T10:00:00.000Z",
  "updated_at": "2026-09-07T10:00:00.000Z"
}

Retrieve a customer

GET/v1/customers/:idSecret key

Update a customer

PATCH/v1/customers/:idSecret key

Accepts the same fields as create, all optional. Only the fields you send are changed.

Body

emailstring
namestring
phonestring
kennitalastring
external_idstring
Send an empty string to clear.
vat_numberstring
billing_address_line1string
billing_address_line2string
billing_citystring
billing_postal_codestring
billing_countrystring
metadataobject

List customers

GET/v1/customersSecret key

Query parameters

emailstring
Exact match, case-insensitive.
limitintegerdefault: 25
starting_afterstring