The Address model

RoundlyConsulting\Addresses\Address is a regular Eloquent model backing the addresses table. It is non-final so you can extend it, uses HasFactory and SoftDeletes, and leaves every attribute mass-assignable ($guarded = []).

$address->addressable;          // the owning model (Customer, Company, …)
$address->type;                 // AddressType::Billing — a custom type reads as its key
$address->typeKey();            // 'billing' — the stored string, built-in or custom
$address->typeLabel();          // 'Billing'
$address->is_primary;           // bool
$address->country_iso;          // 'SK'
$address->country_name;         // resolved name, or null without a resolver

The type column is cast with Casts\AddressTypeCast, not Laravel’s enum cast (which throws on a custom key): a built-in key reads as its AddressType case, a custom key as the string, and assigning a type that is not configured throws InvalidAddressTypeException. typeKey() returns the stored key and typeLabel() its label (see Address types).

Meta

meta holds anything address-related that does not deserve a column — a floor, a gate code, delivery notes. It is stored as JSON and cast back to an Illuminate\Support\Collection, or null when nothing was set:

$address = $customer->newAddress()
    ->in('Bratislava')->at('Somewhere 1')->postalCode('81101')->country('SK')
    ->meta(['floor' => 3, 'gate_code' => '1234'])
    ->save();

$address->meta->get('floor');        // 3
$address->meta?->get('gate_code');  // '1234' — meta is null when none was set

Formatted label

formatted() builds a single-line label from the populated parts — name, street, postal code with city, and the country code — skipping any that are empty. Pass a separator to replace the default comma:

$payer->primaryAddress()?->formatted();
// "HQ, Somewhere 1, 81101 Bratislava, SK"

$address->formatted(' | ');
// "HQ | Somewhere 1 | 81101 Bratislava | SK"

// empty parts are skipped — the same kind of address without a name:
// "Main 2, 04001 Košice, SK"

The label uses the ISO code, not a resolved country name, so it is the same whether or not a CountryResolver is bound.