# FirmhouseCart

Cart

## Extended by

* [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription)

## Properties

| Property                             | Type                                                                                                                                            | Description                                                                                                                                                                   |
| ------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `activePlan`                         | `null` \| [`FirmhousePlan`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-plan)                             | Returns the plan the subscription is currently subscribed to.                                                                                                                 |
| `address`                            | `null` \| `string`                                                                                                                              | The customer's full address line or just street. Can include houseNumber if not separately stored in houseNumber field.                                                       |
| `amountForStartingSubscriptionCents` | `null` \| `number`                                                                                                                              | The amount that is due on checkout (in cents).                                                                                                                                |
| `appliedPromotions?`                 | `null` \| [`FirmhouseAppliedPromotion`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-applied-promotion)\[] | List of all applied promotions for this customer.                                                                                                                             |
| `billToAddress`                      | `null` \| `string`                                                                                                                              | The customer's billing address address line or street.                                                                                                                        |
| `billToCity`                         | `null` \| `string`                                                                                                                              | The customer's billing address city or town.                                                                                                                                  |
| `billToCompanyName`                  | `null` \| `string`                                                                                                                              | The company name of the customer's billing address.                                                                                                                           |
| `billToCountry`                      | `null` \| `string`                                                                                                                              | The customer's billing address country code (ISO3661).                                                                                                                        |
| `billToDistrict`                     | `null` \| `string`                                                                                                                              | The customer's billing address district.                                                                                                                                      |
| `billToFullAddress`                  | `null` \| `string`                                                                                                                              | The customer's billing address full address by combining address and house number.                                                                                            |
| `billToFullName`                     | `null` \| `string`                                                                                                                              | The customer's billing address full name.                                                                                                                                     |
| `billToHouseNumber`                  | `null` \| `string`                                                                                                                              | The customer's billing address house, building, or appartment number.                                                                                                         |
| `billToLastName`                     | `null` \| `string`                                                                                                                              | The customer's billing address last name.                                                                                                                                     |
| `billToName`                         | `null` \| `string`                                                                                                                              | The customer' billing address first name.                                                                                                                                     |
| `billToPhoneNumber`                  | `null` \| `string`                                                                                                                              | The customer's billing address phone number (international format).                                                                                                           |
| `billToSalutation`                   | `null` \| `string`                                                                                                                              | The customer's billing address salutation (mr,ms,mx).                                                                                                                         |
| `billToState`                        | `null` \| `string`                                                                                                                              | The customer's billing address state or province (ISO3661-2).                                                                                                                 |
| `billToZipcode`                      | `null` \| `string`                                                                                                                              | The customer's billing address zip code or postal code.                                                                                                                       |
| `chargeDayOfTheMonth`                | `null` \| `number`                                                                                                                              | The day of the month when the customer is charged.                                                                                                                            |
| `checkoutUrl`                        | `null` \| `string`                                                                                                                              | URL for the customers to complete their draft subscription.                                                                                                                   |
| `city`                               | `null` \| `string`                                                                                                                              | The customer's city or town.                                                                                                                                                  |
| `companyName`                        | `null` \| `string`                                                                                                                              | The customer's company name.                                                                                                                                                  |
| `country`                            | `null` \| `string`                                                                                                                              | The customer's country code (ISO 3116)                                                                                                                                        |
| `createdAt`                          | `null` \| `string`                                                                                                                              | The date and time when the subscription record was first created.                                                                                                             |
| `currency`                           | `null` \| `string`                                                                                                                              | The currency used for this subscription                                                                                                                                       |
| `customerId`                         | `null` \| `string`                                                                                                                              | The customer ID given by the selected payment provider                                                                                                                        |
| `customerReference`                  | `null` \| `string`                                                                                                                              | The field that can be used for your internal reference. For example, internal customer id.                                                                                    |
| `dateOfBirth`                        | `null` \| `string`                                                                                                                              | The customer's date of birth                                                                                                                                                  |
| `differentBillingAddress`            | `null` \| `boolean`                                                                                                                             | Whether billing and shipping addresses are the same. Set this flag to `true` to store a separate billing address.                                                             |
| `district`                           | `null` \| `string`                                                                                                                              | The customer's district                                                                                                                                                       |
| `email`                              | `null` \| `string`                                                                                                                              | The customer's email address                                                                                                                                                  |
| `extraFields`                        | [`FirmhouseExtraFieldAnswer`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-extra-field-answer)\[]          | List of extra fields and values.                                                                                                                                              |
| `fullAddress`                        | `null` \| `string`                                                                                                                              | The customer's full address by combining address and house number.                                                                                                            |
| `fullName`                           | `null` \| `string`                                                                                                                              | The customer's full name.                                                                                                                                                     |
| `houseNumber`                        | `null` \| `string`                                                                                                                              | The customer's house number.                                                                                                                                                  |
| `id`                                 | `null` \| `string`                                                                                                                              | The id of the subscription.                                                                                                                                                   |
| `identityVerificationUrl`            | `null` \| `string`                                                                                                                              | Identity verification URL that automatically uses the configured provider.Append ?return\_url=<https://your-url> to send the customer back after a successful identification. |
| `lastName`                           | `null` \| `string`                                                                                                                              | The customer's last name.                                                                                                                                                     |
| `locale`                             | `null` \| `string`                                                                                                                              | The customer's locale/language.                                                                                                                                               |
| `marketingOptIn`                     | `null` \| `boolean`                                                                                                                             | Whether the customer accepted the optional marketing opt-in.                                                                                                                  |
| `metadata`                           | `unknown`                                                                                                                                       | Metadata makes it possible to store additional information on objects.                                                                                                        |
| `monthlyAmountCents`                 | `null` \| `number`                                                                                                                              | The monthly amount that is charged.                                                                                                                                           |
| `name`                               | `null` \| `string`                                                                                                                              | The customer's first name.                                                                                                                                                    |
| `orderedProducts`                    | `null` \| [`FirmhouseOrderedProduct`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-ordered-product)\[]     | The ordered products that are part of the order                                                                                                                               |
| `phoneNumber`                        | `null` \| `string`                                                                                                                              | The customer's full international phone number                                                                                                                                |
| `salutation`                         | `null` \| `string`                                                                                                                              | The customer's salutation (mr,ms,mx).                                                                                                                                         |
| `startDate`                          | `string`                                                                                                                                        | The date and time when this subscription was (or will be) charged for the first time.                                                                                         |
| `state`                              | `null` \| `string`                                                                                                                              | The customer's state                                                                                                                                                          |
| `status`                             | [`SubscriptionStatus`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/enumerations/subscription-status)                           | Status of this customer.                                                                                                                                                      |
| `subscribedPlan`                     | `null` \| [`FirmhouseSubscribedPlan`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscribed-plan)        | Returns the plan relationship and contract terms of the current plan                                                                                                          |
| `termsAccepted`                      | `boolean`                                                                                                                                       | Whether the customer accepted the terms and conditions.                                                                                                                       |
| `termsAcceptedOn`                    | `null` \| `string`                                                                                                                              | Whether the customer has accepted the terms\&conditions.                                                                                                                      |
| `token`                              | `string`                                                                                                                                        | Unique token of the subscription                                                                                                                                              |
| `trialPeriodMonths`                  | `null` \| `number`                                                                                                                              | The number of months before customer is charged for the first time.                                                                                                           |
| `updatedAt`                          | `null` \| `string`                                                                                                                              | The date and time when the subscription was last updated.                                                                                                                     |
| `vatNumber`                          | `null` \| `string`                                                                                                                              | The company's VAT number.                                                                                                                                                     |
| `zipcode`                            | `null` \| `string`                                                                                                                              | The customer's postal code or zipcode.                                                                                                                                        |
