Module billing

Types for billing

Structs

• Account
  A billing account
• AccountId
  Account ID
• AccountLimit
  The limit of how many accounts can be associated with the subscription. None means unlimited.
• AccountUser
  A user associated with an account
• AdminSchool
  Same as School but includes internal fields
• AdminUpgradeSubscriptionPlanPath
• AdminUpgradeSubscriptionPlanRequest
  Request to upgrade a subscription plan
• AmountInCents
  Represents an amount in cents
• AppliedCoupon
  Details of a coupon applied to a subscription
• Card
  A display-only representation of a card
• Charge
  A charge to a customer for a subscription
• ChargeId
  Local charge ID
• CreateCustomerPortalLinkPath
• CreateSchoolAccountPath
• CreateSchoolAccountRequest
  Request to create a new school account
• CreateSetupIntentPath
• CreateSetupIntentRequest
  Request to create a subscription.
• CreateSubscriptionPath
• CreateSubscriptionRequest
  Request to create a subscription.
• CreateSubscriptionResponse
  Create subscription response.
• CustomerId
  Stripe customer ID
• GetSchoolAccountResponse
  Request to create a new school account
• IndividualAccountPath
• IndividualAccountResponse
  Individual account response
• InvoiceNumber
  Stripe invoice number
• Last4
  Last 4 digits of a card number
• PaymentMethod
  Payment method
• PaymentMethodId
  Local payment method ID
• PlanId
  Local subscription plan ID
• PlanTypeIter
  An iterator over the variants of PlanType
• School
  A school profile.
• SchoolAccountPath
• SchoolId
  Wrapper type around [Uuid], represents the ID of a School.
• SchoolName
  A known school name
• SchoolNameId
  Wrapper type around [Uuid], represents the ID of a School Name.
• SchoolNameValue
  Representation of a school name value
• StripeInvoiceId
  Stripe invoice ID
• StripePaymentMethodId
  Stripe payment method ID
• StripePriceId
  Stripe price ID
• StripeProductId
  Stripe product ID
• StripeSubscriptionId
  Stripe subscription ID
• Subscription
  An existing subscription for a customer
• SubscriptionCancellationStatusRequest
  Whether to cancel a subscription at period end or to remove a cancellation status.
• SubscriptionId
  Local subscription ID
• SubscriptionPauseRequest
  Whether a subscription is paused
• SubscriptionPlan
  A subscription plan
• SubscriptionPlanPath
• TrialPeriod
  Represents a trial period length
• UpdateSchoolAccountRequest
  Request to update a school profile.
• UpdateSubscriptionCancellationPath
• UpdateSubscriptionPausedPath
• UpdateSubscriptionPlansRequest
  Request to create or update a subscription plans
• UpgradeSubscriptionPlanPath
• UpgradeSubscriptionPlanRequest
  Request to upgrade a subscription plan
• UserAccountSummary
  Summary of the user’s account. This could be a school account that a user is a member of.

Enums

• AccountIfAuthorized
  A school account only if the user requesting the account is a system admin or an account admin.
• AccountType
  The type of account
• BillingInterval
  The subscriptions billing interval
• CancellationStatus
  Set a subscriptions cancellation status
• PaymentMethodType
  Type of payment method
• PaymentNetwork
  Payment network associated with a Card
• PlanTier
  Subscription plan tier
• PlanType
  Possible individual subscription plans
• SchoolNameRequest
  Whether the user is creating a new school name or chosen an existing name that we know about
• SubscriptionStatus
  Status of a subscription
• SubscriptionTier
  The tier a subscription is on. This would apply to any SubscriptionType
• SubscriptionType
  The type of subscription

Constants

• INDIVIDUAL_TRIAL_PERIOD
  Individual plan trial period in days
• PLAN_PRICE_ANNUAL_BASIC
  Plan price annual-basic
• PLAN_PRICE_ANNUAL_PRO
  Plan price annual-pro
• PLAN_PRICE_ANNUAL_SCHOOL_1
  Plan price annual-school-1
• PLAN_PRICE_ANNUAL_SCHOOL_2
  Plan price annual-school-2
• PLAN_PRICE_ANNUAL_SCHOOL_3
  Plan price annual-school-3
• PLAN_PRICE_ANNUAL_SCHOOL_4
  Plan price annual-school-4
• PLAN_PRICE_ANNUAL_SCHOOL_UNLIMITED
  Plan price annual-school-unlimited
• PLAN_PRICE_MONTHLY_BASIC
  Plan price monthly-basic
• PLAN_PRICE_MONTHLY_PRO
  Plan price monthly-pro
• PLAN_PRICE_MONTHLY_SCHOOL_1
  Plan price monthly-school-1
• PLAN_PRICE_MONTHLY_SCHOOL_2
  Plan price monthly-school-2
• PLAN_PRICE_MONTHLY_SCHOOL_3
  Plan price monthly-school-3
• PLAN_PRICE_MONTHLY_SCHOOL_4
  Plan price monthly-school-4
• PLAN_PRICE_MONTHLY_SCHOOL_UNLIMITED
  Plan price monthly-school-unlimited
• PLAN_SCHOOL_LEVEL_1_TEACHER_COUNT
  Shared billing constants.
• PLAN_SCHOOL_LEVEL_2_TEACHER_COUNT
  Level 2 max teacher count
• PLAN_SCHOOL_LEVEL_3_TEACHER_COUNT
  Level 3 max teacher count
• PLAN_SCHOOL_LEVEL_4_TEACHER_COUNT
  Level 4 max teacher count
• SCHOOL_TRIAL_PERIOD
  Schools plan trial period in days