SoldTo interface

Sold-to identity used for business verification.

Data classification — Personally Identifiable Information (PII): This model carries customer/contact PII (names, email, phone, postal address). Producers (service code paths populating SoldTo) and consumers (anything emitting it to logs / telemetry) MUST treat individual field values as PII and avoid clear-text logging. BillingTrust's existing runtime discipline keeps SoldTo out of Geneva logs (see Services/Rpaas/RpaasRuleProjector.cs — raw bodies and parsed error messages are filtered before emission). Downstream consumers of the public OpenAPI surface should follow the same convention. Tracked for follow-up alignment with ARM ARG002 (control-plane PII guidance) — see PR description.

Properties

addressLine1

First address line. PII — postal address.

addressLine2

Second address line. PII — postal address.

addressLine3

Third address line. PII — postal address.

city

City of the address. PII — postal address.

companyName

Company name.

country

ISO 3166-1 alpha-2 country code of the sold-to address (e.g. US, IE, GB). Populated from the billing account.

district

District or sub-region. PII — postal address.

email

Contact email address. PII — contact.

firstName

Contact first name. PII — contact.

lastName

Contact last name. PII — contact.

middleName

Contact middle name. PII — contact.

phoneNumber

Contact phone number (free-form string; format not validated server-side). PII — contact.

postalCode

Postal or ZIP code. PII — postal address.

region

State, province, or region. PII — postal address.

Property Details

addressLine1

First address line. PII — postal address.

addressLine1?: string

Property Value

string

addressLine2

Second address line. PII — postal address.

addressLine2?: string

Property Value

string

addressLine3

Third address line. PII — postal address.

addressLine3?: string

Property Value

string

city

City of the address. PII — postal address.

city?: string

Property Value

string

companyName

Company name.

companyName?: string

Property Value

string

country

ISO 3166-1 alpha-2 country code of the sold-to address (e.g. US, IE, GB). Populated from the billing account.

country?: string

Property Value

string

district

District or sub-region. PII — postal address.

district?: string

Property Value

string

email

Contact email address. PII — contact.

email?: string

Property Value

string

firstName

Contact first name. PII — contact.

firstName?: string

Property Value

string

lastName

Contact last name. PII — contact.

lastName?: string

Property Value

string

middleName

Contact middle name. PII — contact.

middleName?: string

Property Value

string

phoneNumber

Contact phone number (free-form string; format not validated server-side). PII — contact.

phoneNumber?: string

Property Value

string

postalCode

Postal or ZIP code. PII — postal address.

postalCode?: string

Property Value

string

region

State, province, or region. PII — postal address.

region?: string

Property Value

string