FirmhouseSubscriptionWithUtils

Properties

PropertyTypeDescriptionInherited from

activatedAt

null | string

The date and time when the subscription was activated and billing started.

activePlan

Returns the plan the subscription is currently subscribed to.

address

null | string

The customer's full address line or just street. Can include houseNumber if not separately stored in houseNumber field.

amountForStartingSubscriptionCents

null | number

The amount that is due on checkout (in cents).

FirmhouseSubscription.amountForStartingSubscriptionCents

appliedPromotions?

List of all applied promotions for this customer.

FirmhouseSubscription.appliedPromotions

billToAddress

null | string

The customer's billing address address line or street.

FirmhouseSubscription.billToAddress

billToCity

null | string

The customer's billing address city or town.

billToCompanyName

null | string

The company name of the customer's billing address.

FirmhouseSubscription.billToCompanyName

billToCountry

null | string

The customer's billing address country code (ISO3661).

FirmhouseSubscription.billToCountry

billToDistrict

null | string

The customer's billing address district.

FirmhouseSubscription.billToDistrict

billToFullAddress

null | string

The customer's billing address full address by combining address and house number.

FirmhouseSubscription.billToFullAddress

billToFullName

null | string

The customer's billing address full name.

FirmhouseSubscription.billToFullName

billToHouseNumber

null | string

The customer's billing address house, building, or appartment number.

FirmhouseSubscription.billToHouseNumber

billToLastName

null | string

The customer's billing address last name.

FirmhouseSubscription.billToLastName

billToName

null | string

The customer' billing address first name.

billToPhoneNumber

null | string

The customer's billing address phone number (international format).

FirmhouseSubscription.billToPhoneNumber

billToSalutation

null | string

The customer's billing address salutation (mr,ms,mx).

FirmhouseSubscription.billToSalutation

billToState

null | string

The customer's billing address state or province (ISO3661-2).

billToZipcode

null | string

The customer's billing address zip code or postal code.

FirmhouseSubscription.billToZipcode

cancellationStartedAt

null | string

The date and time when cancellation was initiated for the subscription (in case of two-step cancellation).

FirmhouseSubscription.cancellationStartedAt

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.

FirmhouseSubscription.chargeDayOfTheMonth

checkoutUrl

null | string

URL for the customers to complete their draft subscription.

city

null | string

The customer's city or town.

collectionCases?

List of collection cases for this customer

FirmhouseSubscription.collectionCases

companyName

null | string

The customer's company name.

country

null | string

The customer's country code (ISO 3116)

createdAt

null | string

The date and time when the subscription record was first created.

currency

null | string

The currency used for this subscription

customerId

null | string

The customer ID given by the selected payment provider

customerReference

null | string

The field that can be used for your internal reference. For example, internal customer id.

FirmhouseSubscription.customerReference

dateOfBirth

null | string

The customer's date of birth

differentBillingAddress

null | boolean

Whether billing and shipping addresses are the same. Set this flag to true to store a separate billing address.

FirmhouseSubscription.differentBillingAddress

district

null | string

The customer's district

email

null | string

The customer's email address

extraFields

List of extra fields and values.

fullAddress

null | string

The customer's full address by combining address and house number.

fullName

null | string

The customer's full name.

getClosestUpcomingOrderDate

() => null | string

Utilty to check the closest upcoming order date

FirmhouseSubscriptionUtils.getClosestUpcomingOrderDate

getClosestUpcomingOrderOrderedProducts

Utility to check the closest upcoming order ordered products

FirmhouseSubscriptionUtils.getClosestUpcomingOrderOrderedProducts

houseNumber

null | string

The customer's house number.

id

null | string

The id of the subscription.

identityVerificationUrl

null | string

Identity verification URL that automatically uses the configured provider.Append ?return_url=https://your-url to send the customer back after a successful identification.

FirmhouseSubscription.identityVerificationUrl

inTrialPeriod

boolean

Whether this subscription is currently in its trial period.

FirmhouseSubscription.inTrialPeriod

invoices?

List of invoices of this customer.

lastName

null | string

The customer's last name.

locale

null | string

The customer's locale/language.

markedAsNonPayingAt

null | string

The date and time when the subscription was last marked as non-paying.

FirmhouseSubscription.markedAsNonPayingAt

marketingOptIn

null | boolean

Whether the customer accepted the optional marketing opt-in.

FirmhouseSubscription.marketingOptIn

metadata

unknown

Metadata makes it possible to store additional information on objects.

monthlyAmountCents

null | number

The monthly amount that is charged.

FirmhouseSubscription.monthlyAmountCents

name

null | string

The customer's first name.

notes

null | string

Notes about the customer that can be set in the portal

ordersV2?

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

FirmhouseSubscription.paymentMethod

paymentMethodSummary

null | string

The last 4 digits of the current payment method.

FirmhouseSubscription.paymentMethodSummary

paymentMethodTranslated

null | string

Localised string of the payment method currently in use for billing.

FirmhouseSubscription.paymentMethodTranslated

phoneNumber

null | string

The customer's full international phone number

pspPaymentMethodDetails

unknown

The payment method details returned by PSP currently used for billing.

FirmhouseSubscription.pspPaymentMethodDetails

salutation

null | string

The customer's salutation (mr,ms,mx).

signupCompletedAt

null | string

The date and time when the subscription completed their signup and made their initial payment (or no payment if free).

FirmhouseSubscription.signupCompletedAt

skipAutoActivationOnSignup

boolean

If true then the subscription won't be activated after signup and initial payment.

FirmhouseSubscription.skipAutoActivationOnSignup

startDate

string

The date and time when this subscription was (or will be) charged for the first time.

state

null | string

The customer's state

status

Status of this customer.

stoppedAt

null | string

The date and time when the subscription was automatically stopped.

subscribedPlan

Returns the plan relationship and contract terms of the current plan

FirmhouseSubscription.subscribedPlan

termsAccepted

boolean

Whether the customer accepted the terms and conditions.

FirmhouseSubscription.termsAccepted

termsAcceptedOn

null | string

Whether the customer has accepted the terms&conditions.

FirmhouseSubscription.termsAcceptedOn

token

string

Unique token of the subscription

trialPeriodMonths

null | number

The number of months before customer is charged for the first time.

FirmhouseSubscription.trialPeriodMonths

updatePaymentMethodUrl

null | string

Send your customer to this URL to allow them to update their active payment method.

FirmhouseSubscription.updatePaymentMethodUrl

updatedAt

null | string

The date and time when the subscription was last updated.

vatNumber

null | string

The company's VAT number.

verifiedIdentity?

Details of the verified identity if present.

FirmhouseSubscription.verifiedIdentity

zipcode

null | string

The customer's postal code or zipcode.

Last updated