OBJECT
SubscriptionInstance
a subscription object
link GraphQL Schema definition
- type SubscriptionInstance {
- # When a customer cancels, or is set to cancel, this will be a datetime of when
- # access will cease
- String :
- # Amount difference if switching to annual/monthly
- Int :
- # Amount savings from monthly to annual
- String :
- # Total cost of subscription for the year
- String :
- # Expiration of credit card on Stripe
- String :
- # Returns true if card is expired
- Boolean :
- # Type of credit card on Stripe (Mastercard, Visa, Amex, etc.)
- String :
- # Cost per month of annual plan
- String :
- # Discounts currently active on Stripe account
- Discount!] : [
- # Array of discounts applied in Stripe (most possible is 2)
- Discount!] : [
- # Returns true if there is already a scheduled subscription change on this account
- Boolean :
- # The unique identifier of the subscription
- ID! :
- # The interval of the subscription
- String :
- # Example of next invoice if switching plan
- StripeInvoice :
- # Returns true if the user is trialing
- Boolean :
- # Last four digits of credit card on Stripe
- String :
- # Last attempted invoice in Stripe
- StripeInvoice :
- # When the user is scheduled to be locked out due to non-payment
- String :
- # Total cost of subscription for the month
- String :
- # Cost per month of annual plan
- String :
- # Cost per month for base plan
- String :
- # The number of providers that the subscription covers
- String :
- # The number of support staff that the subscription covers
- String :
- # Percent difference if switching to annual/monthly
- Int :
- # Percent savings from monthly to annual
- Int :
- # Array of line items applied to Stripe subscription other than base plan (i.e fax
- # line, extra providers, office ally etc.)
- StripePlan!] : [
- # The ID of the plan in Healthie
- String :
- # Name of the plan in Stripe
- String :
- # Returns true if the user is set to cancel
- Boolean :
- # Remaining balance on stripe customer
- String :
- # The ID of the customer in Stripe
- String :
- # The ID of the subscription in Stripe
- String :
- # Upcoming invoice in Stripe
- StripeInvoice :
- # Owner of this subscription
- User :
- }
link Require by
- createSubscriptionPayloadAutogenerated return type of createSubscription.
- OrganizationAn organization, that is an umbrella group for multiple providers
- QueryThe query root of this schema. See available queries.
- SupportDashboardUserINTERNAL -- Data on the User Object
- updateSubscriptionPayloadAutogenerated return type of updateSubscription.
- UserAn user entry, returns basic user information