# FirmhouseSubscriptionWithUtils
## Properties
| Property | Type | Description | Inherited from |
| ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `activatedAt` | `null` \| `string` | The date and time when the subscription was activated and billing started. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`activatedAt` |
| `activePlan` | `null` \| [`FirmhousePlan`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-plan) | Returns the plan the subscription is currently subscribed to. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`activePlan` |
| `address` | `null` \| `string` | 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).`address` |
| `amountForStartingSubscriptionCents` | `null` \| `number` | The amount that is due on checkout (in cents). | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`amountForStartingSubscriptionCents` |
| `appliedPromotions?` | `null` \| [`FirmhouseAppliedPromotion`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-applied-promotion)\[] | List of all applied promotions for this customer. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`appliedPromotions` |
| `billToAddress` | `null` \| `string` | The customer's billing address address line or street. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`billToAddress` |
| `billToCity` | `null` \| `string` | The customer's billing address city or town. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`billToCity` |
| `billToCompanyName` | `null` \| `string` | The company name of the customer's billing address. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`billToCompanyName` |
| `billToCountry` | `null` \| `string` | The customer's billing address country code (ISO3661). | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`billToCountry` |
| `billToDistrict` | `null` \| `string` | The customer's billing address district. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`billToDistrict` |
| `billToFullAddress` | `null` \| `string` | 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).`billToFullAddress` |
| `billToFullName` | `null` \| `string` | The customer's billing address full name. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`billToFullName` |
| `billToHouseNumber` | `null` \| `string` | The customer's billing address house, building, or appartment number. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`billToHouseNumber` |
| `billToLastName` | `null` \| `string` | The customer's billing address last name. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`billToLastName` |
| `billToName` | `null` \| `string` | The customer' billing address first name. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`billToName` |
| `billToPhoneNumber` | `null` \| `string` | The customer's billing address phone number (international format). | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`billToPhoneNumber` |
| `billToSalutation` | `null` \| `string` | The customer's billing address salutation (mr,ms,mx). | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`billToSalutation` |
| `billToState` | `null` \| `string` | The customer's billing address state or province (ISO3661-2). | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`billToState` |
| `billToZipcode` | `null` \| `string` | The customer's billing address zip code or postal code. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`billToZipcode` |
| `cancellationStartedAt` | `null` \| `string` | 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).`cancellationStartedAt` |
| `cancelledAt` | `null` \| `string` | The date and time when the subscription was cancelled. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`cancelledAt` |
| `chargeDayOfTheMonth` | `null` \| `number` | The day of the month when the customer is charged. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`chargeDayOfTheMonth` |
| `checkoutUrl` | `null` \| `string` | URL for the customers to complete their draft subscription. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`checkoutUrl` |
| `city` | `null` \| `string` | The customer's city or town. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`city` |
| `collectionCases?` | [`FirmhouseCollectionCase`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-collection-case)\[] | List of collection cases for this customer | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`collectionCases` |
| `companyName` | `null` \| `string` | The customer's company name. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`companyName` |
| `country` | `null` \| `string` | The customer's country code (ISO 3116) | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`country` |
| `createdAt` | `null` \| `string` | The date and time when the subscription record was first created. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`createdAt` |
| `currency` | `null` \| `string` | The currency used for this subscription | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`currency` |
| `customerId` | `null` \| `string` | The customer ID given by the selected payment provider | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`customerId` |
| `customerReference` | `null` \| `string` | 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).`customerReference` |
| `dateOfBirth` | `null` \| `string` | The customer's date of birth | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`dateOfBirth` |
| `differentBillingAddress` | `null` \| `boolean` | 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).`differentBillingAddress` |
| `district` | `null` \| `string` | The customer's district | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`district` |
| `email` | `null` \| `string` | The customer's email address | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`email` |
| `extraFields` | [`FirmhouseExtraFieldAnswer`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-extra-field-answer)\[] | List of extra fields and values. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`extraFields` |
| `fullAddress` | `null` \| `string` | The customer's full address by combining address and house number. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`fullAddress` |
| `fullName` | `null` \| `string` | The customer's full name. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`fullName` |
| `getClosestUpcomingOrderDate` | () => `null` \| `string` | Utilty to check the closest upcoming order date
| [`FirmhouseSubscriptionUtils`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription-utils).`getClosestUpcomingOrderDate` |
| `getClosestUpcomingOrderOrderedProducts` | () => [`FirmhouseOrderedProduct`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-ordered-product)\[] | Utility to check the closest upcoming order ordered products
| [`FirmhouseSubscriptionUtils`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription-utils).`getClosestUpcomingOrderOrderedProducts` |
| `houseNumber` | `null` \| `string` | The customer's house number. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`houseNumber` |
| `id` | `null` \| `string` | The id of the subscription. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`id` |
| `identityVerificationUrl` | `null` \| `string` | Identity verification URL that automatically uses the configured provider.Append ?return\_url= to send the customer back after a successful identification. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`identityVerificationUrl` |
| `inTrialPeriod` | `boolean` | Whether this subscription is currently in its trial period. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`inTrialPeriod` |
| `invoices?` | `null` \| [`FirmhouseInvoice`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-invoice)\[] | List of invoices of this customer. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`invoices` |
| `lastName` | `null` \| `string` | The customer's last name. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`lastName` |
| `locale` | `null` \| `string` | The customer's locale/language. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`locale` |
| `markedAsNonPayingAt` | `null` \| `string` | 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).`markedAsNonPayingAt` |
| `marketingOptIn` | `null` \| `boolean` | Whether the customer accepted the optional marketing opt-in. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`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).`metadata` |
| `monthlyAmountCents` | `null` \| `number` | The monthly amount that is charged. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`monthlyAmountCents` |
| `name` | `null` \| `string` | The customer's first name. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`name` |
| `notes` | `null` \| `string` | Notes about the customer that can be set in the portal | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`notes` |
| `ordersV2?` | [`PaginatedResponse`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/typealiases/paginated-response)<[`FirmhouseOrder`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-order)> | List of orders of this subscription | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`ordersV2` |
| `paidAmount` | `null` \| `number` | The amount that is succesfully paid so far. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`paidAmount` |
| `pausedAt` | `null` \| `string` | The time the subscription was paused. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`pausedAt` |
| `pausedUntil` | `null` \| `string` | The time the subscription will be automatically resumed. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`pausedUntil` |
| `paymentMethod` | `null` \| `string` | The payment method currently in use for billing | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`paymentMethod` |
| `paymentMethodSummary` | `null` \| `string` | The last 4 digits of the current payment method. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`paymentMethodSummary` |
| `paymentMethodTranslated` | `null` \| `string` | Localised string of the payment method currently in use for billing. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`paymentMethodTranslated` |
| `phoneNumber` | `null` \| `string` | The customer's full international phone number | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`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).`pspPaymentMethodDetails` |
| `salutation` | `null` \| `string` | The customer's salutation (mr,ms,mx). | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`salutation` |
| `signupCompletedAt` | `null` \| `string` | 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).`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).`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).`startDate` |
| `state` | `null` \| `string` | The customer's state | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`state` |
| `status` | [`SubscriptionStatus`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/enumerations/subscription-status) | Status of this customer. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`status` |
| `stoppedAt` | `null` \| `string` | The date and time when the subscription was automatically stopped. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`stoppedAt` |
| `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 | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`subscribedPlan` |
| `termsAccepted` | `boolean` | Whether the customer accepted the terms and conditions. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`termsAccepted` |
| `termsAcceptedOn` | `null` \| `string` | Whether the customer has accepted the terms\&conditions. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`termsAcceptedOn` |
| `token` | `string` | Unique token of the subscription | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`token` |
| `trialPeriodMonths` | `null` \| `number` | The number of months before customer is charged for the first time. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`trialPeriodMonths` |
| `updatePaymentMethodUrl` | `null` \| `string` | 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).`updatePaymentMethodUrl` |
| `updatedAt` | `null` \| `string` | The date and time when the subscription was last updated. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`updatedAt` |
| `vatNumber` | `null` \| `string` | The company's VAT number. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`vatNumber` |
| `verifiedIdentity?` | `null` \| [`FirmhouseVerifiedIdentity`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-verified-identity) | Details of the verified identity if present. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`verifiedIdentity` |
| `zipcode` | `null` \| `string` | The customer's postal code or zipcode. | [`FirmhouseSubscription`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription).`zipcode` |