# 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`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-plan.md) | Returns the plan the subscription is currently subscribed to. | [`FirmhouseCart`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart.md).`activePlan` | | `address` | `null` \| `string` | 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` | | `amountForStartingSubscriptionCents` | `null` \| `number` | The amount that is due on checkout (in cents). | [`FirmhouseCart`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart.md).`amountForStartingSubscriptionCents` | | `appliedPromotions?` | `null` \| [`FirmhouseAppliedPromotion`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-applied-promotion.md)\[] | List of all applied promotions for this customer. | [`FirmhouseCart`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart.md).`appliedPromotions` | | `billToAddress` | `null` \| `string` | The customer's billing address address line or street. | [`FirmhouseCart`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart.md).`billToAddress` | | `billToCity` | `null` \| `string` | The customer's billing address city or town. | [`FirmhouseCart`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart.md).`billToCity` | | `billToCompanyName` | `null` \| `string` | The company name of the customer's billing address. | [`FirmhouseCart`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart.md).`billToCompanyName` | | `billToCountry` | `null` \| `string` | The customer's billing address country code (ISO3661). | [`FirmhouseCart`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart.md).`billToCountry` | | `billToDistrict` | `null` \| `string` | The customer's billing address district. | [`FirmhouseCart`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart.md).`billToDistrict` | | `billToFullAddress` | `null` \| `string` | The customer's billing address full address by combining address and house number. | [`FirmhouseCart`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart.md).`billToFullAddress` | | `billToFullName` | `null` \| `string` | The customer's billing address full name. | [`FirmhouseCart`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart.md).`billToFullName` | | `billToHouseNumber` | `null` \| `string` | The customer's billing address house, building, or appartment number. | [`FirmhouseCart`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart.md).`billToHouseNumber` | | `billToLastName` | `null` \| `string` | The customer's billing address last name. | [`FirmhouseCart`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart.md).`billToLastName` | | `billToName` | `null` \| `string` | The customer' billing address first name. | [`FirmhouseCart`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart.md).`billToName` | | `billToPhoneNumber` | `null` \| `string` | The customer's billing address phone number (international format). | [`FirmhouseCart`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart.md).`billToPhoneNumber` | | `billToSalutation` | `null` \| `string` | The customer's billing address salutation (mr,ms,mx). | [`FirmhouseCart`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart.md).`billToSalutation` | | `billToState` | `null` \| `string` | The customer's billing address state or province (ISO3661-2). | [`FirmhouseCart`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart.md).`billToState` | | `billToZipcode` | `null` \| `string` | The customer's billing address zip code or postal code. | [`FirmhouseCart`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart.md).`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`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart.md).`chargeDayOfTheMonth` | | `checkoutUrl` | `null` \| `string` | URL for the customers to complete their draft subscription. | [`FirmhouseCart`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart.md).`checkoutUrl` | | `city` | `null` \| `string` | The customer's city or town. | [`FirmhouseCart`](/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` | `null` \| `string` | The customer's company name. | [`FirmhouseCart`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart.md).`companyName` | | `country` | `null` \| `string` | The customer's country code (ISO 3116) | [`FirmhouseCart`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart.md).`country` | | `createdAt` | `null` \| `string` | The date and time when the subscription record was first created. | [`FirmhouseCart`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart.md).`createdAt` | | `currency` | `null` \| `string` | The currency used for this subscription | [`FirmhouseCart`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart.md).`currency` | | `customerId` | `null` \| `string` | The customer ID given by the selected payment provider | [`FirmhouseCart`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart.md).`customerId` | | `customerReference` | `null` \| `string` | 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` | | `dateOfBirth` | `null` \| `string` | The customer's date of birth | [`FirmhouseCart`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart.md).`dateOfBirth` | | `differentBillingAddress` | `null` \| `boolean` | 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` | | `district` | `null` \| `string` | The customer's district | [`FirmhouseCart`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart.md).`district` | | `email` | `null` \| `string` | The customer's email address | [`FirmhouseCart`](/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` | | `fullAddress` | `null` \| `string` | The customer's full address by combining address and house number. | [`FirmhouseCart`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart.md).`fullAddress` | | `fullName` | `null` \| `string` | The customer's full name. | [`FirmhouseCart`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart.md).`fullName` | | `houseNumber` | `null` \| `string` | The customer's house number. | [`FirmhouseCart`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart.md).`houseNumber` | | `id` | `null` \| `string` | The id of the subscription. | [`FirmhouseCart`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart.md).`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`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart.md).`identityVerificationUrl` | | `inTrialPeriod` | `boolean` | Whether this subscription is currently in its trial period. | - | | `invoices?` | `null` \| [`FirmhouseInvoice`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-invoice.md)\[] | List of invoices of this customer. | - | | `lastName` | `null` \| `string` | The customer's last name. | [`FirmhouseCart`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart.md).`lastName` | | `locale` | `null` \| `string` | The customer's locale/language. | [`FirmhouseCart`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart.md).`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`](/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` | | `monthlyAmountCents` | `null` \| `number` | The monthly amount that is charged. | [`FirmhouseCart`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart.md).`monthlyAmountCents` | | `name` | `null` \| `string` | The customer's first name. | [`FirmhouseCart`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart.md).`name` | | `notes` | `null` \| `string` | Notes about the customer that can be set in the portal | - | | `orderedProducts` | `null` \| [`FirmhouseOrderedProduct`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-ordered-product.md)\[] | The ordered products that are part of the order | [`FirmhouseCart`](/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` | `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`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart.md).`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`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart.md).`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`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart.md).`startDate` | | `state` | `null` \| `string` | The customer's state | [`FirmhouseCart`](/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` | | `stoppedAt` | `null` \| `string` | The date and time when the subscription was automatically stopped. | - | | `subscribedPlan` | `null` \| [`FirmhouseSubscribedPlan`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscribed-plan.md) | Returns the plan relationship and contract terms of the current plan | [`FirmhouseCart`](/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` | | `termsAcceptedOn` | `null` \| `string` | Whether the customer has accepted the terms\&conditions. | [`FirmhouseCart`](/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` | | `trialPeriodMonths` | `null` \| `number` | The number of months before customer is charged for the first time. | [`FirmhouseCart`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart.md).`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`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart.md).`updatedAt` | | `vatNumber` | `null` \| `string` | The company's VAT number. | [`FirmhouseCart`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart.md).`vatNumber` | | `verifiedIdentity?` | `null` \| [`FirmhouseVerifiedIdentity`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-verified-identity.md) | Details of the verified identity if present. | - | | `zipcode` | `null` \| `string` | The customer's postal code or zipcode. | [`FirmhouseCart`](/sdks/firmhouse-sdk/reference/interfaces/firmhouse-cart.md).`zipcode` | --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/interfaces/firmhouse-subscription.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.