Customer
customer
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| name | str | ✅ | The name of the customer |
| addresses | List[Address] | ❌ | |
| business_vat_id | str | ❌ | The tax ID number of the customer. Relevant when the customer is a business |
| created_at | int | ❌ | Time of creation of this customer, in Unix time. Response only |
| default_payment_method | str | ❌ | The payment method that is used when the 'payment' object or subscription does not specify a payment method. The value must also appear in the payment_methods list. The payment method is referenced by its name field. |
| delinquent | bool | ❌ | Indicates whether there is currently a failure of an automatic payment that is part of a subscription, or an invoice that was not paid when due. Response only. true - The account is delinquent false - The account is current |
| description | str | ❌ | A text description of the customer |
| discount | Discount | ❌ | Describes the fields relating to discounts in REST messages and webhooks for customer profiles and subscriptions Contains information about the coupon that applies to the customer. Read-only field. Adding a discount is a 2-step process - 1. Create Coupon, which returns a coupon ID. 2. Add the coupon ID to the coupon field of the customer with Create Customer or Update Customer. |
str | ❌ | Customer's email address. Maximum 512 characters | |
| ewallet | str | ❌ | ID of the wallet that is linked to the customer. String starting with ewallet_. Each wallet can be associated with only one customer |
| id_ | str | ❌ | ID of the Customer object. String starting with cus_ |
| invoice_prefix | str | ❌ | A custom string that is prefixed to all invoices for this customer. For more information see Invoice Object at https://docs.rapyd.net/build-with-rapyd/reference/invoices#invoice-object |
| metadata | dict | ❌ | A JSON object defined by the client |
| payment_methods | CustomerPaymentMethods | ❌ | An object containing the following fields - _ data - A list of up to three payment methods. For more information, see Customer Payment Method Object. _ has_more - Indicates whether there are more than three payment methods for this customer. _ total_count - Total number of payment methods for this customer. _ url - URL for requesting all of the payment methods for this customer.. |
| phone_number | str | ❌ | Customer's primary phone number in E.164 format. The merchant is responsible for verifying that the number is correct. One method of verifying could be to send an activation code to the phone by SMS, with a limited time for response. |
| subscriptions | List[Subscription] | ❌ |
Build Your Own SDKs with liblab
Build developer friendly SDKs in minutes from your APIs