17 lines
4.0 KiB
Markdown
17 lines
4.0 KiB
Markdown
# CustomerData
|
|
|
|
Customer details to set when creating a customer
|
|
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description |
|
|
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
|
| `name` | *OptionalNullable[str]* | :heavy_minus_sign: | Customer's name |
|
|
| `email` | *OptionalNullable[str]* | :heavy_minus_sign: | Customer's email address |
|
|
| `fingerprint` | *OptionalNullable[str]* | :heavy_minus_sign: | Unique identifier (eg, serial number) to detect duplicate customers and prevent free trial abuse |
|
|
| `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Additional metadata for the customer |
|
|
| `stripe_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Stripe customer ID if you already have one |
|
|
| `create_in_stripe` | *Optional[bool]* | :heavy_minus_sign: | Whether to create the customer in Stripe |
|
|
| `auto_enable_plan_id` | *Optional[str]* | :heavy_minus_sign: | The ID of the free plan to auto-enable for the customer |
|
|
| `send_email_receipts` | *Optional[bool]* | :heavy_minus_sign: | Whether to send email receipts to this customer | |