Customer

A company you bill.

billingAddress
Type:
required

Billing address. An empty object when there is none.

Properties: 6
churnDate
Type: string | nullFormat: date-time
required

When the customer churned, or null.
connections
Type: object
required

The customer's records in connected services.

Properties: 1
createdAt
Type: stringFormat: date-time
required

When the customer was created.
creationState
Type: "draft" or "active"enum
required

Whether the customer is still being set up (draft) or ready to use (active).
defaultCurrency
Type: string
required

ISO 4217 currency code the customer is billed in. Your organisation's currency unless set when the customer was created.
email
Type: string
required

Billing email address, or an empty string when there is none.
externalId
Type: string | null
required

Your ID for the customer, unique across your organisation (ignoring case). null if you haven't set one.
id
Type: string
required

Spondo Billing ID of the customer (cus_…).
legalName
Type: string | null
required

Registered legal name, for invoices.
metadata
Type: nullable
required

Your own key-value data, or null.

Properties: 1
name
Type: string
required

Display name.
phone
Type: string
required

Phone number, or an empty string when there is none.
status
Type: "active" or "churned"enum
required

churned once a churnDate is set, otherwise active.
updatedAt
Type: stringFormat: date-time
required

When the customer was last changed.
vatNumber
Type: string | null
required

VAT or other tax registration number.
website
Type: string
required

Website, or an empty string when there is none.

CustomerAddress

CustomerInput