Links

Subscription

A subscription represents the main subscription or customer record in Firmhouse
A subscription contains things like name, address, and company details. A subscription is subscribed to a plan via SubscribedPlan or multiple products via the OrderedProduct object.

Fields

activatedAt (String)

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

activePlan (Plan)

Returns the plan the subscription is currently subscribed to.

address (String)

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

amountForStartingSubscriptionCents (Int)

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

appliedBillingCyclePromotions ([AppliedBillingCyclePromotion!])

List of billing cycle promotions applied for this customer.

appliedOrderDiscountPromotions ([AppliedOrderDiscountPromotion!])

List of order discount promotions applied for this customer.

appliedPromotions ([AppliedPromotion!])

List of all applied promotions for this customer.

billToAddress (String)

The customer's billing address address line or street.

billToCity (String)

The customer's billing address city or town.

billToCompanyName (String)

The company name of the customer's billing address.

billToCountry (String)

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

billToDistrict (String)

The customer's billing address district.

billToFullAddress (String)

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

billToFullName (String)

The customer's billing address full name.

billToHouseNumber (String)

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

billToLastName (String)

The customer's billing address last name.

billToName (String)

The customer' billing address first name.

billToPhoneNumber (String)

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

billToSalutation (String)

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

billToState (String)

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

billToZipcode (String)

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

cancellationStartedAt (String)

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

cancelledAt (String)

The date and time when the subscription was cancelled.

chargeDayOfTheMonth (Int)

The day of the month when the customer is charged.

checkoutUrl (String)

URL for the customers to complete their draft subscription.

city (String)

The customer's city or town.

collectionCases (CollectionCaseConnection)

List of collection cases for this customer.
Argument
Description
after (String)
Returns the elements in the list that come after the specified cursor.
before (String)
Returns the elements in the list that come before the specified cursor.
first (Int)
Returns the first n elements from the list.
last (Int)
Returns the last n elements from the list.

companyName (String)

The customer's company name.

country (String)

The customer's country code (ISO 3116)

createdAt (String)

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

currency (String)

The currency used for this subscription

customerFeedbacks ([CustomerFeedback!])

List of customer feedback for this customer.

customerId (String)

The customer ID given by the selected payment provider

customerReference (String)

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

dateOfBirth (ISO8601Date)

The customer's date of birth

differentBillingAddress (Boolean)

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

discountCodes ([DiscountCode!])

The assigned discount codes.

district (String)

The customer's district

email (String)

The customer's email address

extraFields ([ExtraFieldAnswer!]!)

List of extra fields and values.

fullAddress (String)

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

fullName (String)

The customer's full name.

houseNumber (String)

The customer's house number.

id (String)

The id of the subscription.

identityVerificationUrl (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.

inTrialPeriod (Boolean!)

Whether this subscription is currently in its trial period.

invoices ([Invoice!])

List of invoices of this customer.

lastName (String)

The customer's last name.

locale (String)

The customer's locale/language.

markedAsNonPayingAt (String)

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

marketingOptIn (Boolean)

Whether the customer accepted the optional marketing opt-in.

metadata (JSON)

Metadata makes it possible to store additional information on objects.

monthlyAmount (Float)

Deprecated: Use monthlyAmountCents instead.
The monthly amount that is charged.

monthlyAmountCents (Int)

The monthly amount that is charged (in cents)

name (String)

The customer's first name.

notes (String)

Notes about the customer that can be set in the portal

orderCalculation (OrderCalculation)

Deprecated: Will be removed.
Calculate order prices
Argument
Description
orderedProducts ([OrderedProductInput!])
The ordered products that are part of the order
discountCode (String)

orderedProducts ([OrderedProduct!])

List of products the subscription is on.

orders ([Order!])

Deprecated: Use 'ordersV2' instead.
List of orders of this subscription

ordersV2 (OrderConnection)

List of orders of this subscription
Argument
Description
after (String)
Returns the elements in the list that come after the specified cursor.
before (String)
Returns the elements in the list that come before the specified cursor.
first (Int)
Returns the first n elements from the list.
last (Int)
Returns the last n elements from the list.

paidAmount (Float)

The amount that is succesfully paid so far.

pausedAt (ISO8601DateTime)

The time the subscription was paused.

pausedUntil (ISO8601DateTime)

The time the subscription will be automatically resumed.

paymentMethod (String)

The payment method currently in use for billing

paymentMethodSummary (String)

The last 4 digits of the current payment method.

paymentMethodTranslated (String)

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

phoneNumber (String)

The customer's full international phone number

products ([Product!])

List of products the subscription is on (via orderedProducts).

project (Project!)

projectId (ID!)

Deprecated: Will be removed.

pspPaymentMethodDetails (JSON)

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

salutation (String)

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

serviceChannel (ServiceChannel)

Returns the service channel this subscription has signed up to

signupCompletedAt (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 (ISO8601DateTime!)

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

state (String)

The customer's state
Status of this customer.

stoppedAt (ISO8601DateTime)

The date and time when the subscription was automatically stopped.

subscribedPlan (SubscribedPlan)

Returns the plan relationship and contract terms of the current plan

subscriptionAcceptanceChecks (SubscriptionAcceptanceCheckConnection)

List of acceptance checks of this subscription
Argument
Description
after (String)
Returns the elements in the list that come after the specified cursor.
before (String)
Returns the elements in the list that come before the specified cursor.
first (Int)
Returns the first n elements from the list.
last (Int)
Returns the last n elements from the list.

termsAccepted (Boolean!)

Whether the customer accepted the terms and conditions.

termsAcceptedOn (String)

Whether the customer has accepted the terms&conditions.

token (String)

Unique token of the subscription

trialPeriodMonths (Int)

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

updatePaymentMethodUrl (String)

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

updatedAt (String)

The date and time when the subscription was last updated.

vatNumber (String)

The company's VAT number.

verifiedIdentity (SubscriptionIdentity)

Details of the verified identity if present.

zipcode (String)

The customer's postal code or zipcode.
Last modified 1mo ago