For the complete documentation index, see llms.txt. This page is also available as Markdown.

Interface: FirmhouseProject

Represents the environment for your business or proposition on Firmhouse

Properties

Property
Type
Description

availableCountries

string[]

The available countries for this project

availableCountryStates

unknown

The available states per country for this project

currency

string

The currency of the project

currentStock

number | null

The current stock of a project

dynamicOrderStrategy

string

The type of the dynamic order strategy for this project

extraFields?

The extra fields for this project

freeShipmentFromCents

number | null

The threshold that will make shipment free in cents (works in combination with Firmhouse shipping methods)

id

string

ID to identify the project with

licence

| { showFirmhouseLogo: boolean | null; } | null

Licence

name

string

The name of the project

paymentProvider

string | null

The payment provider of this project

productImageUrl

string | null

Image of the main product of the project

productName

string | null

Name of the main product of the project

projectType

string | null

The type of the project

promotions?

The available promotions for this project

subscriptionLimitEnabled

boolean

Whether the amount of subscriptions is limited

taxRates?

The available tax rates for this project

token

string

Token to identify the project with

twoStepCancellationEnabled

boolean | null

Whether two-step cancellation is enabled for this project

twoStepSignupEnabled

boolean

Whether two step signup is enabled for this project

updatedAt

string | null

Project last updated since

Last updated

Was this helpful?