Skip to main content

HouseholdSubscription

No description

type HouseholdSubscription {
  activePromoCode: PromoCode
  activeSponsorship: SubscriptionSponsorshipInfo
  analyticsFreemiumSummaryStatus: String!
  billingPeriod: PaymentPeriod
  billingVersion: String!
  canceledPlusTrialAt: DateTime
  currentPeriodEndsAt: DateTime
  currentPlanAmount: Float
  eligibleForTrial: Boolean!
  entitlementParams: EntitlementParams!
  entitlements: [SubscriptionEntitlement!]!
  hasActiveStripeCheckoutSession: Boolean!
  hasBillingIssue: Boolean!
  hasChargedForLifetime: Boolean!
  hasHadFreeTrialExtension: Boolean!
  hasLegacyLiteTierAccess: Boolean!
  hasLifetimeSubscription: Boolean!
  hasPremiumEntitlement: Boolean!
  hasPremiumEntitlementAfterSync: Boolean!
  hasStartedFreeTrial: Boolean!
  hasStripeSubscriptionId: Boolean!
  id: ID!
  isEligibleForCoreToPlusPromo: Boolean!
  isOnFreeTrial: Boolean!
  isSponsor: Boolean!
  nextCyclePromoCode: PromoCode
  nextPaymentAmount: Float
  paymentMethod: PaymentMethod
  paymentSource: SubscriptionDetailsPaymentSource
  plusSubscriptionStatus: String!
  plusTrialEndsAt: DateTime
  plusUpgradeProratedAmount(
    promoCode: String
    stripePriceId: String!
  ): Float
  postalCode: String
  referralCode: String!
  referralRedemption: ReferralRedemption
  scheduledDowngradeAt: DateTime
  scheduledDowngradeEntitlement: SubscriptionEntitlement
  sponsoredBy: SubscriptionSponsorInfo
  storeBillingState: StoreBillingState!
  trialDurationDays: Int!
  trialEndsAt: DateTime
  trialType: TrialType
  willCancelAtPeriodEnd: Boolean!
}

Fields​

HouseholdSubscription.activePromoCode ● PromoCode object​

HouseholdSubscription.activeSponsorship ● SubscriptionSponsorshipInfo object​

HouseholdSubscription.analyticsFreemiumSummaryStatus ● String! non-null scalar​

HouseholdSubscription.billingPeriod ● PaymentPeriod enum​

HouseholdSubscription.billingVersion ● String! non-null scalar​

HouseholdSubscription.canceledPlusTrialAt ● DateTime scalar​

HouseholdSubscription.currentPeriodEndsAt ● DateTime scalar​

HouseholdSubscription.currentPlanAmount ● Float scalar​

HouseholdSubscription.eligibleForTrial ● Boolean! non-null scalar​

HouseholdSubscription.entitlementParams ● EntitlementParams! non-null object​

HouseholdSubscription.entitlements ● [SubscriptionEntitlement!]! non-null enum​

HouseholdSubscription.hasActiveStripeCheckoutSession ● Boolean! non-null scalar​

HouseholdSubscription.hasBillingIssue ● Boolean! non-null scalar​

HouseholdSubscription.hasChargedForLifetime ● Boolean! non-null scalar​

HouseholdSubscription.hasHadFreeTrialExtension ● Boolean! non-null scalar​

HouseholdSubscription.hasLegacyLiteTierAccess ● Boolean! non-null scalar​

HouseholdSubscription.hasLifetimeSubscription ● Boolean! non-null scalar​

HouseholdSubscription.hasPremiumEntitlement ● Boolean! non-null scalar​

HouseholdSubscription.hasPremiumEntitlementAfterSync ● Boolean! non-null scalar​

HouseholdSubscription.hasStartedFreeTrial ● Boolean! non-null scalar​

HouseholdSubscription.hasStripeSubscriptionId ● Boolean! non-null scalar​

HouseholdSubscription.id ● ID! non-null scalar​

HouseholdSubscription.isEligibleForCoreToPlusPromo ● Boolean! non-null scalar​

HouseholdSubscription.isOnFreeTrial ● Boolean! non-null scalar​

HouseholdSubscription.isSponsor ● Boolean! non-null scalar​

HouseholdSubscription.nextCyclePromoCode ● PromoCode object​

HouseholdSubscription.nextPaymentAmount ● Float scalar​

HouseholdSubscription.paymentMethod ● PaymentMethod object​

HouseholdSubscription.paymentSource ● SubscriptionDetailsPaymentSource enum​

HouseholdSubscription.plusSubscriptionStatus ● String! non-null scalar​

HouseholdSubscription.plusTrialEndsAt ● DateTime scalar​

HouseholdSubscription.plusUpgradeProratedAmount ● Float scalar​

HouseholdSubscription.plusUpgradeProratedAmount.promoCode ● String scalar​
HouseholdSubscription.plusUpgradeProratedAmount.stripePriceId ● String! non-null scalar​

HouseholdSubscription.postalCode ● String scalar​

HouseholdSubscription.referralCode ● String! non-null scalar​

HouseholdSubscription.referralRedemption ● ReferralRedemption object​

HouseholdSubscription.scheduledDowngradeAt ● DateTime scalar​

HouseholdSubscription.scheduledDowngradeEntitlement ● SubscriptionEntitlement enum​

HouseholdSubscription.sponsoredBy ● SubscriptionSponsorInfo object​

HouseholdSubscription.storeBillingState ● StoreBillingState! non-null enum​

HouseholdSubscription.trialDurationDays ● Int! non-null scalar​

HouseholdSubscription.trialEndsAt ● DateTime scalar​

HouseholdSubscription.trialType ● TrialType enum​

HouseholdSubscription.willCancelAtPeriodEnd ● Boolean! non-null scalar​

Returned By​

subscription query

Member Of​

ApplyStripeCancelDiscountOffer object ● CancelStripeSubscriptionMutation object ● ChangeStripeSubscriptionMutation object ● ConvertEmployeeTrial object ● CreateAdvisorStripeSubscriptionMutation object ● CreateStripeSubscriptionMutation object ● ExtendFreeTrialForSevenDaysMutation object ● GiveEmployeeInfinitePlusAccess object ● GiveEmployeeInfinitePremiumAccess object ● ReactivateStripeSubscriptionMutation object ● RemoveEmployeeEntitlements object ● ResetEmployeeAndSubscribe object ● ResetEmployeeToNoSubscription object ● SetEmployeeActiveSubscription object ● SetEmployeeBillingIssue object ● SetEmployeeCancellationDiscountUsed object ● SetEmployeeExpiredTrial object ● SetEmployeePlusTrialFields object ● SetEmployeeSubscriptionEnded object ● SyncEmployeeSubscription object ● UpdateOrCreateStripePaymentMethodMutation object