entity
BillingProfile
Stores billing-related contact information and preferences for a customer, often used for invoices and communication.
Entity
Overview
The BillingProfile entity consolidates billing-specific details for a customer, such as the billing address, contact email for invoices, tax information, and potentially preferred payment methods. This might be distinct from the customer’s general contact information or shipping addresses.
Entity Properties
| Name | Type | Required | Description |
|---|---|---|---|
billingProfileId | UUID | Required | Unique identifier for the billing profile. |
customerId | UUID | Required | Identifier of the customer this billing profile belongs to. |
billingEmail | string | Optional | Specific email address for sending invoices and billing notifications |
companyName | string | Optional | Company name for billing purposes. |
taxId | string | Optional | Tax identification number (e.g., VAT ID, EIN). |
billingAddressId | UUID | Required | Identifier for the primary billing address associated with this profile. |
preferredPaymentMethodId | UUID | Optional | Customer's preferred payment method for charges related to this profile. |
createdAt | DateTime | Required | Timestamp when the billing profile was created. |
updatedAt | DateTime | Required | Timestamp when the billing profile was last updated. |
Relationships
- Customer: A billing profile belongs to one
Customer. A customer might potentially have multiple profiles in complex scenarios, but often just one. - Address: Linked to a primary billing
Address. - PaymentMethod: May specify a preferred
PaymentMethod. - Invoice: Invoices are typically generated using information from the BillingProfile.
- Subscription: Subscriptions may use the associated customer’s BillingProfile for charging.
Examples
- Jane Doe’s personal billing profile with her home address and primary email.
- Acme Corp’s billing profile with their HQ address, VAT ID, and accounts payable email address.