# FirmhouseSubscription ## Properties | Property | Type | Description | Inherited from | | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | | `activatedAt` | `null` \| `string` | The date and time when the subscription was activated and billing started. | - | | `activePlan` | `null` \| [`FirmhousePlan`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-plan) | Returns the plan the subscription is currently subscribed to. | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`activePlan` | | `address` | `null` \| `string` | The customer's full address line or just street. Can include houseNumber if not separately stored in houseNumber field. | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`address` | | `amountForStartingSubscriptionCents` | `null` \| `number` | The amount that is due on checkout (in cents). | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`amountForStartingSubscriptionCents` | | `appliedPromotions?` | `null` \| [`FirmhouseAppliedPromotion`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-applied-promotion)\[] | List of all applied promotions for this customer. | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`appliedPromotions` | | `billToAddress` | `null` \| `string` | The customer's billing address address line or street. | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`billToAddress` | | `billToCity` | `null` \| `string` | The customer's billing address city or town. | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`billToCity` | | `billToCompanyName` | `null` \| `string` | The company name of the customer's billing address. | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`billToCompanyName` | | `billToCountry` | `null` \| `string` | The customer's billing address country code (ISO3661). | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`billToCountry` | | `billToDistrict` | `null` \| `string` | The customer's billing address district. | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`billToDistrict` | | `billToFullAddress` | `null` \| `string` | The customer's billing address full address by combining address and house number. | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`billToFullAddress` | | `billToFullName` | `null` \| `string` | The customer's billing address full name. | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`billToFullName` | | `billToHouseNumber` | `null` \| `string` | The customer's billing address house, building, or appartment number. | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`billToHouseNumber` | | `billToLastName` | `null` \| `string` | The customer's billing address last name. | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`billToLastName` | | `billToName` | `null` \| `string` | The customer' billing address first name. | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`billToName` | | `billToPhoneNumber` | `null` \| `string` | The customer's billing address phone number (international format). | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`billToPhoneNumber` | | `billToSalutation` | `null` \| `string` | The customer's billing address salutation (mr,ms,mx). | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`billToSalutation` | | `billToState` | `null` \| `string` | The customer's billing address state or province (ISO3661-2). | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`billToState` | | `billToZipcode` | `null` \| `string` | The customer's billing address zip code or postal code. | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`billToZipcode` | | `cancellationStartedAt` | `null` \| `string` | The date and time when cancellation was initiated for the subscription (in case of two-step cancellation). | - | | `cancelledAt` | `null` \| `string` | The date and time when the subscription was cancelled. | - | | `chargeDayOfTheMonth` | `null` \| `number` | The day of the month when the customer is charged. | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`chargeDayOfTheMonth` | | `checkoutUrl` | `null` \| `string` | URL for the customers to complete their draft subscription. | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`checkoutUrl` | | `city` | `null` \| `string` | The customer's city or town. | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`city` | | `collectionCases?` | [`FirmhouseCollectionCase`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-collection-case)\[] | List of collection cases for this customer | - | | `companyName` | `null` \| `string` | The customer's company name. | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`companyName` | | `country` | `null` \| `string` | The customer's country code (ISO 3116) | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`country` | | `createdAt` | `null` \| `string` | The date and time when the subscription record was first created. | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`createdAt` | | `currency` | `null` \| `string` | The currency used for this subscription | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`currency` | | `customerId` | `null` \| `string` | The customer ID given by the selected payment provider | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`customerId` | | `customerReference` | `null` \| `string` | The field that can be used for your internal reference. For example, internal customer id. | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`customerReference` | | `dateOfBirth` | `null` \| `string` | The customer's date of birth | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`dateOfBirth` | | `differentBillingAddress` | `null` \| `boolean` | Whether billing and shipping addresses are the same. Set this flag to `true` to store a separate billing address. | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`differentBillingAddress` | | `district` | `null` \| `string` | The customer's district | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`district` | | `email` | `null` \| `string` | The customer's email address | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`email` | | `extraFields` | [`FirmhouseExtraFieldAnswer`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-extra-field-answer)\[] | List of extra fields and values. | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`extraFields` | | `fullAddress` | `null` \| `string` | The customer's full address by combining address and house number. | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`fullAddress` | | `fullName` | `null` \| `string` | The customer's full name. | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`fullName` | | `houseNumber` | `null` \| `string` | The customer's house number. | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`houseNumber` | | `id` | `null` \| `string` | The id of the subscription. | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`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. | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`identityVerificationUrl` | | `inTrialPeriod` | `boolean` | Whether this subscription is currently in its trial period. | - | | `invoices?` | `null` \| [`FirmhouseInvoice`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-invoice)\[] | List of invoices of this customer. | - | | `lastName` | `null` \| `string` | The customer's last name. | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`lastName` | | `locale` | `null` \| `string` | The customer's locale/language. | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`locale` | | `markedAsNonPayingAt` | `null` \| `string` | The date and time when the subscription was last marked as non-paying. | - | | `marketingOptIn` | `null` \| `boolean` | Whether the customer accepted the optional marketing opt-in. | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`marketingOptIn` | | `metadata` | `unknown` | Metadata makes it possible to store additional information on objects. | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`metadata` | | `monthlyAmountCents` | `null` \| `number` | The monthly amount that is charged. | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`monthlyAmountCents` | | `name` | `null` \| `string` | The customer's first name. | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`name` | | `notes` | `null` \| `string` | Notes about the customer that can be set in the portal | - | | `orderedProducts` | `null` \| [`FirmhouseOrderedProduct`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-ordered-product)\[] | The ordered products that are part of the order | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`orderedProducts` | | `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 | - | | `paidAmount` | `null` \| `number` | The amount that is succesfully paid so far. | - | | `pausedAt` | `null` \| `string` | The time the subscription was paused. | - | | `pausedUntil` | `null` \| `string` | The time the subscription will be automatically resumed. | - | | `paymentMethod` | `null` \| `string` | The payment method currently in use for billing | - | | `paymentMethodSummary` | `null` \| `string` | The last 4 digits of the current payment method. | - | | `paymentMethodTranslated` | `null` \| `string` | Localised string of the payment method currently in use for billing. | - | | `phoneNumber` | `null` \| `string` | The customer's full international phone number | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`phoneNumber` | | `pspPaymentMethodDetails` | `unknown` | The payment method details returned by PSP currently used for billing. | - | | `salutation` | `null` \| `string` | The customer's salutation (mr,ms,mx). | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`salutation` | | `signupCompletedAt` | `null` \| `string` | The date and time when the subscription completed their signup and made their initial payment (or no payment if free). | - | | `skipAutoActivationOnSignup` | `boolean` | If true then the subscription won't be activated after signup and initial payment. | - | | `startDate` | `string` | The date and time when this subscription was (or will be) charged for the first time. | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`startDate` | | `state` | `null` \| `string` | The customer's state | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`state` | | `status` | [`SubscriptionStatus`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/enumerations/subscription-status) | Status of this customer. | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`status` | | `stoppedAt` | `null` \| `string` | The date and time when the subscription was automatically stopped. | - | | `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 | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`subscribedPlan` | | `termsAccepted` | `boolean` | Whether the customer accepted the terms and conditions. | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`termsAccepted` | | `termsAcceptedOn` | `null` \| `string` | Whether the customer has accepted the terms\&conditions. | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`termsAcceptedOn` | | `token` | `string` | Unique token of the subscription | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`token` | | `trialPeriodMonths` | `null` \| `number` | The number of months before customer is charged for the first time. | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`trialPeriodMonths` | | `updatePaymentMethodUrl` | `null` \| `string` | Send your customer to this URL to allow them to update their active payment method. | - | | `updatedAt` | `null` \| `string` | The date and time when the subscription was last updated. | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`updatedAt` | | `vatNumber` | `null` \| `string` | The company's VAT number. | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`vatNumber` | | `verifiedIdentity?` | `null` \| [`FirmhouseVerifiedIdentity`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-verified-identity) | Details of the verified identity if present. | - | | `zipcode` | `null` \| `string` | The customer's postal code or zipcode. | [`FirmhouseCart`](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart).`zipcode` |