9.9 KiB
9.9 KiB
Customer
Fields
| Field | Type | Required | Description |
|---|---|---|---|
id |
Nullable[str] | ✔️ | Your unique identifier for the customer. |
name |
Nullable[str] | ✔️ | The name of the customer. |
email |
Nullable[str] | ✔️ | The email address of the customer. |
created_at |
float | ✔️ | Timestamp of customer creation in milliseconds since epoch. |
fingerprint |
Nullable[str] | ✔️ | A unique identifier (eg. serial number) to de-duplicate customers across devices or browsers. For example: apple device ID. |
stripe_id |
Nullable[str] | ✔️ | Stripe customer ID. |
env |
models.CustomerEnv | ✔️ | The environment this customer was created in. |
metadata |
Dict[str, Any] | ✔️ | The metadata for the customer. |
send_email_receipts |
bool | ✔️ | Whether to send email receipts to the customer. |
subscriptions |
List[models.Subscription] | ✔️ | Active and scheduled recurring plans that this customer has attached. |
purchases |
List[models.Purchase] | ✔️ | One-time purchases made by the customer. |
balances |
Dict[str, models.Balance] | ✔️ | Feature balances keyed by feature ID, showing usage limits and remaining amounts. |
invoices |
List[models.Invoice] | ➖ | N/A |
entities |
List[models.Entity] | ➖ | N/A |
trials_used |
List[models.TrialsUsed] | ➖ | N/A |
rewards |
OptionalNullable[models.Rewards] | ➖ | N/A |
referrals |
List[models.Referral] | ➖ | N/A |
payment_method |
OptionalNullable[Any] | ➖ | N/A |