FirmhouseSubscription

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.

FirmhouseCart.activePlan

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).

FirmhouseCart.amountForStartingSubscriptionCents

appliedPromotions?

List of all applied promotions for this customer.

FirmhouseCart.appliedPromotions

billToAddress

null | string

The customer's billing address address line or street.

FirmhouseCart.billToAddress

billToCity

null | string

The customer's billing address city or town.

FirmhouseCart.billToCity

billToCompanyName

null | string

The company name of the customer's billing address.

FirmhouseCart.billToCompanyName

billToCountry

null | string

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

FirmhouseCart.billToCountry

billToDistrict

null | string

The customer's billing address district.

FirmhouseCart.billToDistrict

billToFullAddress

null | string

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

FirmhouseCart.billToFullAddress

billToFullName

null | string

The customer's billing address full name.

FirmhouseCart.billToFullName

billToHouseNumber

null | string

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

FirmhouseCart.billToHouseNumber

billToLastName

null | string

The customer's billing address last name.

FirmhouseCart.billToLastName

billToName

null | string

The customer' billing address first name.

FirmhouseCart.billToName

billToPhoneNumber

null | string

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

FirmhouseCart.billToPhoneNumber

billToSalutation

null | string

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

FirmhouseCart.billToSalutation

billToState

null | string

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

FirmhouseCart.billToState

billToZipcode

null | string

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

FirmhouseCart.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.chargeDayOfTheMonth

checkoutUrl

null | string

URL for the customers to complete their draft subscription.

FirmhouseCart.checkoutUrl

city

null | string

The customer's city or town.

collectionCases?

List of collection cases for this customer

-

companyName

null | string

The customer's company name.

FirmhouseCart.companyName

country

null | string

The customer's country code (ISO 3116)

createdAt

null | string

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

FirmhouseCart.createdAt

currency

null | string

The currency used for this subscription

FirmhouseCart.currency

customerId

null | string

The customer ID given by the selected payment provider

FirmhouseCart.customerId

customerReference

null | string

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

FirmhouseCart.customerReference

dateOfBirth

null | string

The customer's date of birth

FirmhouseCart.dateOfBirth

differentBillingAddress

null | boolean

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

FirmhouseCart.differentBillingAddress

district

null | string

The customer's district

FirmhouseCart.district

email

null | string

The customer's email address

extraFields

List of extra fields and values.

FirmhouseCart.extraFields

fullAddress

null | string

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

FirmhouseCart.fullAddress

fullName

null | string

The customer's full name.

FirmhouseCart.fullName

houseNumber

null | string

The customer's house number.

FirmhouseCart.houseNumber

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.

FirmhouseCart.identityVerificationUrl

inTrialPeriod

boolean

Whether this subscription is currently in its trial period.

-

invoices?

List of invoices of this customer.

-

lastName

null | string

The customer's last name.

FirmhouseCart.lastName

locale

null | string

The customer's locale/language.

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.marketingOptIn

metadata

unknown

Metadata makes it possible to store additional information on objects.

FirmhouseCart.metadata

monthlyAmountCents

null | number

The monthly amount that is charged.

FirmhouseCart.monthlyAmountCents

name

null | string

The customer's first name.

notes

null | string

Notes about the customer that can be set in the portal

-

orderedProducts

The ordered products that are part of the order

FirmhouseCart.orderedProducts

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

-

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.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.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.startDate

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

FirmhouseCart.subscribedPlan

termsAccepted

boolean

Whether the customer accepted the terms and conditions.

FirmhouseCart.termsAccepted

termsAcceptedOn

null | string

Whether the customer has accepted the terms&conditions.

FirmhouseCart.termsAcceptedOn

token

string

Unique token of the subscription

trialPeriodMonths

null | number

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

FirmhouseCart.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.updatedAt

vatNumber

null | string

The company's VAT number.

FirmhouseCart.vatNumber

verifiedIdentity?

Details of the verified identity if present.

-

zipcode

null | string

The customer's postal code or zipcode.

Last updated

#33: Shopify SSO Connection

Change request updated