> For the complete documentation index, see [llms.txt](https://developer.firmhouse.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription-with-utils.md).

# Interface: FirmhouseSubscriptionWithUtils

## Properties

| Property                                 | Type                                                                                                                                                                                                                                  | Description                                                                                                                                                                   | Overrides                                                                                                                                                                                                                                                           | Inherited from                                                                                                                                                                                                                                                                                                                     |
| ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `activatedAt`                            | `string` \| `null`                                                                                                                                                                                                                    | The date and time when the subscription was activated and billing started.                                                                                                    | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`activatedAt`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#activatedat)                                                                        |
| `activePlan`                             | [`FirmhousePlan`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-plan.md) \| `null`                                                                                                                | Returns the plan the subscription is currently subscribed to.                                                                                                                 | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`activePlan`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#activeplan)                                                                          |
| `address`                                | `string` \| `null`                                                                                                                                                                                                                    | The customer's full address line or just street. Can include houseNumber if not separately stored in houseNumber field.                                                       | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`address`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#address)                                                                                |
| `amountForStartingSubscriptionCents`     | `number` \| `null`                                                                                                                                                                                                                    | The amount that is due on checkout (in cents).                                                                                                                                | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`amountForStartingSubscriptionCents`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#amountforstartingsubscriptioncents)                          |
| `appliedPromotions?`                     | [`FirmhouseAppliedPromotion`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-applied-promotion.md)\[] \| `null`                                                                                    | List of all applied promotions for this customer.                                                                                                                             | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`appliedPromotions`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#appliedpromotions)                                                            |
| `billToAddress`                          | `string` \| `null`                                                                                                                                                                                                                    | The customer's billing address address line or street.                                                                                                                        | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`billToAddress`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#billtoaddress)                                                                    |
| `billToCity`                             | `string` \| `null`                                                                                                                                                                                                                    | The customer's billing address city or town.                                                                                                                                  | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`billToCity`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#billtocity)                                                                          |
| `billToCompanyName`                      | `string` \| `null`                                                                                                                                                                                                                    | The company name of the customer's billing address.                                                                                                                           | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`billToCompanyName`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#billtocompanyname)                                                            |
| `billToCountry`                          | `string` \| `null`                                                                                                                                                                                                                    | The customer's billing address country code (ISO3661).                                                                                                                        | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`billToCountry`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#billtocountry)                                                                    |
| `billToDistrict`                         | `string` \| `null`                                                                                                                                                                                                                    | The customer's billing address district.                                                                                                                                      | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`billToDistrict`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#billtodistrict)                                                                  |
| `billToFullAddress`                      | `string` \| `null`                                                                                                                                                                                                                    | The customer's billing address full address by combining address and house number.                                                                                            | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`billToFullAddress`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#billtofulladdress)                                                            |
| `billToFullName`                         | `string` \| `null`                                                                                                                                                                                                                    | The customer's billing address full name.                                                                                                                                     | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`billToFullName`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#billtofullname)                                                                  |
| `billToHouseNumber`                      | `string` \| `null`                                                                                                                                                                                                                    | The customer's billing address house, building, or appartment number.                                                                                                         | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`billToHouseNumber`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#billtohousenumber)                                                            |
| `billToLastName`                         | `string` \| `null`                                                                                                                                                                                                                    | The customer's billing address last name.                                                                                                                                     | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`billToLastName`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#billtolastname)                                                                  |
| `billToName`                             | `string` \| `null`                                                                                                                                                                                                                    | The customer' billing address first name.                                                                                                                                     | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`billToName`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#billtoname)                                                                          |
| `billToPhoneNumber`                      | `string` \| `null`                                                                                                                                                                                                                    | The customer's billing address phone number (international format).                                                                                                           | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`billToPhoneNumber`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#billtophonenumber)                                                            |
| `billToSalutation`                       | `string` \| `null`                                                                                                                                                                                                                    | The customer's billing address salutation (mr,ms,mx).                                                                                                                         | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`billToSalutation`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#billtosalutation)                                                              |
| `billToState`                            | `string` \| `null`                                                                                                                                                                                                                    | The customer's billing address state or province (ISO3661-2).                                                                                                                 | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`billToState`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#billtostate)                                                                        |
| `billToZipcode`                          | `string` \| `null`                                                                                                                                                                                                                    | The customer's billing address zip code or postal code.                                                                                                                       | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`billToZipcode`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#billtozipcode)                                                                    |
| `cancellationStartedAt`                  | `string` \| `null`                                                                                                                                                                                                                    | The date and time when cancellation was initiated for the subscription (in case of two-step cancellation).                                                                    | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`cancellationStartedAt`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#cancellationstartedat)                                                    |
| `cancelledAt`                            | `string` \| `null`                                                                                                                                                                                                                    | The date and time when the subscription was cancelled.                                                                                                                        | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`cancelledAt`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#cancelledat)                                                                        |
| `chargeDayOfTheMonth`                    | `number` \| `null`                                                                                                                                                                                                                    | The day of the month when the customer is charged.                                                                                                                            | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`chargeDayOfTheMonth`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#chargedayofthemonth)                                                        |
| `checkoutUrl`                            | `string` \| `null`                                                                                                                                                                                                                    | URL for the customers to complete their draft subscription.                                                                                                                   | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`checkoutUrl`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#checkouturl)                                                                        |
| `city`                                   | `string` \| `null`                                                                                                                                                                                                                    | The customer's city or town.                                                                                                                                                  | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`city`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#city)                                                                                      |
| `collectionCases?`                       | [`FirmhouseCollectionCase`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-collection-case.md)\[]                                                                                                  | List of collection cases for this customer                                                                                                                                    | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`collectionCases`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#collectioncases)                                                                |
| `companyName`                            | `string` \| `null`                                                                                                                                                                                                                    | The customer's company name.                                                                                                                                                  | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`companyName`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#companyname)                                                                        |
| `country`                                | `string` \| `null`                                                                                                                                                                                                                    | The customer's country code (ISO 3116)                                                                                                                                        | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`country`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#country)                                                                                |
| `createdAt`                              | `string` \| `null`                                                                                                                                                                                                                    | The date and time when the subscription record was first created.                                                                                                             | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`createdAt`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#createdat)                                                                            |
| `currency`                               | `string` \| `null`                                                                                                                                                                                                                    | The currency used for this subscription                                                                                                                                       | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`currency`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#currency)                                                                              |
| `customerId`                             | `string` \| `null`                                                                                                                                                                                                                    | The customer ID given by the selected payment provider                                                                                                                        | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`customerId`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#customerid)                                                                          |
| `customerReference`                      | `string` \| `null`                                                                                                                                                                                                                    | The field that can be used for your internal reference. For example, internal customer id.                                                                                    | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`customerReference`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#customerreference)                                                            |
| `dateOfBirth`                            | `string` \| `null`                                                                                                                                                                                                                    | The customer's date of birth                                                                                                                                                  | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`dateOfBirth`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#dateofbirth)                                                                        |
| `differentBillingAddress`                | `boolean` \| `null`                                                                                                                                                                                                                   | Whether billing and shipping addresses are the same. Set this flag to `true` to store a separate billing address.                                                             | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`differentBillingAddress`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#differentbillingaddress)                                                |
| `district`                               | `string` \| `null`                                                                                                                                                                                                                    | The customer's district                                                                                                                                                       | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`district`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#district)                                                                              |
| `email`                                  | `string` \| `null`                                                                                                                                                                                                                    | The customer's email address                                                                                                                                                  | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`email`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#email)                                                                                    |
| `extraFields`                            | [`FirmhouseExtraFieldAnswer`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-extra-field-answer.md)\[]                                                                                             | List of extra fields and values.                                                                                                                                              | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`extraFields`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#extrafields)                                                                        |
| `fullAddress`                            | `string` \| `null`                                                                                                                                                                                                                    | The customer's full address by combining address and house number.                                                                                                            | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`fullAddress`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#fulladdress)                                                                        |
| `fullName`                               | `string` \| `null`                                                                                                                                                                                                                    | The customer's full name.                                                                                                                                                     | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`fullName`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#fullname)                                                                              |
| `getClosestUpcomingOrderDate`            | () => `string` \| `null`                                                                                                                                                                                                              | Utilty to check the closest upcoming order date                                                                                                                               | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscriptionUtils`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription-utils.md).[`getClosestUpcomingOrderDate`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription-utils.md#getclosestupcomingorderdate)                       |
| `getClosestUpcomingOrderOrderedProducts` | () => [`FirmhouseOrderedProduct`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-ordered-product.md)\[]                                                                                            | Utility to check the closest upcoming order ordered products                                                                                                                  | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscriptionUtils`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription-utils.md).[`getClosestUpcomingOrderOrderedProducts`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription-utils.md#getclosestupcomingorderorderedproducts) |
| `houseNumber`                            | `string` \| `null`                                                                                                                                                                                                                    | The customer's house number.                                                                                                                                                  | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`houseNumber`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#housenumber)                                                                        |
| `id`                                     | `string` \| `null`                                                                                                                                                                                                                    | The id of the subscription.                                                                                                                                                   | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`id`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#id)                                                                                          |
| `identityVerificationUrl`                | `string` \| `null`                                                                                                                                                                                                                    | Identity verification URL that automatically uses the configured provider.Append ?return\_url=<https://your-url> to send the customer back after a successful identification. | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`identityVerificationUrl`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#identityverificationurl)                                                |
| `inTrialPeriod`                          | `boolean`                                                                                                                                                                                                                             | Whether this subscription is currently in its trial period.                                                                                                                   | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`inTrialPeriod`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#intrialperiod)                                                                    |
| `invoices?`                              | [`FirmhouseInvoice`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-invoice.md)\[] \| `null`                                                                                                       | List of invoices of this customer.                                                                                                                                            | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`invoices`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#invoices)                                                                              |
| `lastName`                               | `string` \| `null`                                                                                                                                                                                                                    | The customer's last name.                                                                                                                                                     | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`lastName`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#lastname)                                                                              |
| `locale`                                 | `string` \| `null`                                                                                                                                                                                                                    | The customer's locale/language.                                                                                                                                               | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`locale`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#locale)                                                                                  |
| `markedAsNonPayingAt`                    | `string` \| `null`                                                                                                                                                                                                                    | The date and time when the subscription was last marked as non-paying.                                                                                                        | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`markedAsNonPayingAt`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#markedasnonpayingat)                                                        |
| `marketingOptIn`                         | `boolean` \| `null`                                                                                                                                                                                                                   | Whether the customer accepted the optional marketing opt-in.                                                                                                                  | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`marketingOptIn`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#marketingoptin)                                                                  |
| `metadata`                               | `unknown`                                                                                                                                                                                                                             | Metadata makes it possible to store additional information on objects.                                                                                                        | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`metadata`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#metadata)                                                                              |
| `monthlyAmountCents`                     | `number` \| `null`                                                                                                                                                                                                                    | The monthly amount that is charged.                                                                                                                                           | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`monthlyAmountCents`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#monthlyamountcents)                                                          |
| `name`                                   | `string` \| `null`                                                                                                                                                                                                                    | The customer's first name.                                                                                                                                                    | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`name`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#name)                                                                                      |
| `notes`                                  | `string` \| `null`                                                                                                                                                                                                                    | Notes about the customer that can be set in the portal                                                                                                                        | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`notes`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#notes)                                                                                    |
| `orderedProducts`                        | \| [`FirmhouseOrderedProductWithUtils`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-ordered-product-with-utils.md)\[] \| `null`                                                                 | The ordered products that are part of the order                                                                                                                               | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`orderedProducts`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#orderedproducts) | -                                                                                                                                                                                                                                                                                                                                  |
| `ordersV2?`                              | [`PaginatedResponse`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/typealiases/paginated-response.md)<[`FirmhouseOrder`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-order.md)> | List of orders of this subscription                                                                                                                                           | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`ordersV2`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#ordersv2)                                                                              |
| `paidAmount`                             | `number` \| `null`                                                                                                                                                                                                                    | The amount that is succesfully paid so far.                                                                                                                                   | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`paidAmount`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#paidamount)                                                                          |
| `pausedAt`                               | `string` \| `null`                                                                                                                                                                                                                    | The time the subscription was paused.                                                                                                                                         | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`pausedAt`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#pausedat)                                                                              |
| `pausedUntil`                            | `string` \| `null`                                                                                                                                                                                                                    | The time the subscription will be automatically resumed.                                                                                                                      | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`pausedUntil`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#pauseduntil)                                                                        |
| `paymentMethod`                          | `string` \| `null`                                                                                                                                                                                                                    | The payment method currently in use for billing                                                                                                                               | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`paymentMethod`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#paymentmethod)                                                                    |
| `paymentMethodSummary`                   | `string` \| `null`                                                                                                                                                                                                                    | The last 4 digits of the current payment method.                                                                                                                              | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`paymentMethodSummary`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#paymentmethodsummary)                                                      |
| `paymentMethodTranslated`                | `string` \| `null`                                                                                                                                                                                                                    | Localised string of the payment method currently in use for billing.                                                                                                          | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`paymentMethodTranslated`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#paymentmethodtranslated)                                                |
| `phoneNumber`                            | `string` \| `null`                                                                                                                                                                                                                    | The customer's full international phone number                                                                                                                                | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`phoneNumber`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#phonenumber)                                                                        |
| `pspPaymentMethodDetails`                | `unknown`                                                                                                                                                                                                                             | The payment method details returned by PSP currently used for billing.                                                                                                        | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`pspPaymentMethodDetails`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#psppaymentmethoddetails)                                                |
| `salutation`                             | `string` \| `null`                                                                                                                                                                                                                    | The customer's salutation (mr,ms,mx).                                                                                                                                         | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`salutation`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#salutation)                                                                          |
| `signupCompletedAt`                      | `string` \| `null`                                                                                                                                                                                                                    | The date and time when the subscription completed their signup and made their initial payment (or no payment if free).                                                        | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`signupCompletedAt`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#signupcompletedat)                                                            |
| `skipAutoActivationOnSignup`             | `boolean`                                                                                                                                                                                                                             | If true then the subscription won't be activated after signup and initial payment.                                                                                            | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`skipAutoActivationOnSignup`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#skipautoactivationonsignup)                                          |
| `startDate`                              | `string`                                                                                                                                                                                                                              | The date and time when this subscription was (or will be) charged for the first time.                                                                                         | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`startDate`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#startdate)                                                                            |
| `state`                                  | `string` \| `null`                                                                                                                                                                                                                    | The customer's state                                                                                                                                                          | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`state`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#state)                                                                                    |
| `status`                                 | [`SubscriptionStatus`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/enumerations/subscription-status.md)                                                                                                              | Status of this customer.                                                                                                                                                      | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`status`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#status)                                                                                  |
| `stoppedAt`                              | `string` \| `null`                                                                                                                                                                                                                    | The date and time when the subscription was automatically stopped.                                                                                                            | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`stoppedAt`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#stoppedat)                                                                            |
| `subscribedPlan`                         | [`FirmhouseSubscribedPlan`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscribed-plan.md) \| `null`                                                                                           | Returns the plan relationship and contract terms of the current plan                                                                                                          | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`subscribedPlan`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#subscribedplan)                                                                  |
| `termsAccepted`                          | `boolean`                                                                                                                                                                                                                             | Whether the customer accepted the terms and conditions.                                                                                                                       | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`termsAccepted`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#termsaccepted)                                                                    |
| `termsAcceptedOn`                        | `string` \| `null`                                                                                                                                                                                                                    | Whether the customer has accepted the terms\&conditions.                                                                                                                      | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`termsAcceptedOn`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#termsacceptedon)                                                                |
| `token`                                  | `string`                                                                                                                                                                                                                              | Unique token of the subscription                                                                                                                                              | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`token`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#token)                                                                                    |
| `trialPeriodMonths`                      | `number` \| `null`                                                                                                                                                                                                                    | The number of months before customer is charged for the first time.                                                                                                           | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`trialPeriodMonths`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#trialperiodmonths)                                                            |
| `updatedAt`                              | `string` \| `null`                                                                                                                                                                                                                    | The date and time when the subscription was last updated.                                                                                                                     | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`updatedAt`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#updatedat)                                                                            |
| `updatePaymentMethodUrl`                 | `string` \| `null`                                                                                                                                                                                                                    | Send your customer to this URL to allow them to update their active payment method.                                                                                           | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`updatePaymentMethodUrl`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#updatepaymentmethodurl)                                                  |
| `vatNumber`                              | `string` \| `null`                                                                                                                                                                                                                    | The company's VAT number.                                                                                                                                                     | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`vatNumber`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#vatnumber)                                                                            |
| `verifiedIdentity?`                      | [`FirmhouseVerifiedIdentity`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-verified-identity.md) \| `null`                                                                                       | Details of the verified identity if present.                                                                                                                                  | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`verifiedIdentity`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#verifiedidentity)                                                              |
| `zipcode`                                | `string` \| `null`                                                                                                                                                                                                                    | The customer's postal code or zipcode.                                                                                                                                        | -                                                                                                                                                                                                                                                                   | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md).[`zipcode`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md#zipcode)                                                                                |
