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