Expand description
Types for billing
Structs§
- Account
- A billing account
- Account
Id - Account ID
- Account
Limit - The limit of how many accounts can be associated with the subscription. None means unlimited.
- Account
User - A user associated with an account
- Admin
School - Same as
Schoolbut includes internal fields - Admin
Upgrade Subscription Plan Path - Admin
Upgrade Subscription Plan Request - Request to upgrade a subscription plan
- Amount
InCents - Represents an amount in cents
- Applied
Coupon - 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
- Charge
Id - Local charge ID
- Create
Customer Portal Link Path - Create
School Account Path - Create
School Account Request - Request to create a new school account
- Create
Setup Intent Path - Create
Setup Intent Request - Request to create a subscription.
- Create
Subscription Path - Create
Subscription Request - Request to create a subscription.
- Create
Subscription Response - Create subscription response.
- Customer
Id - Stripe customer ID
- GetSchool
Account Response - Request to create a new school account
- Individual
Account Path - Individual
Account Response - Individual account response
- Invoice
Number - Stripe invoice number
- Last4
- Last 4 digits of a card number
- Payment
Method - Payment method
- Payment
Method Id - Local payment method ID
- PlanId
- Local subscription plan ID
- Plan
Type Iter - An iterator over the variants of PlanType
- School
- A school profile.
- School
Account Path - School
Id - Wrapper type around [
Uuid], represents the ID of a School. - School
Name - A known school name
- School
Name Id - Wrapper type around [
Uuid], represents the ID of a School Name. - School
Name Value - Representation of a school name value
- Stripe
Invoice Id - Stripe invoice ID
- Stripe
Payment Method Id - Stripe payment method ID
- Stripe
Price Id - Stripe price ID
- Stripe
Product Id - Stripe product ID
- Stripe
Subscription Id - Stripe subscription ID
- Subscription
- An existing subscription for a customer
- Subscription
Cancellation Status Request - Whether to cancel a subscription at period end or to remove a cancellation status.
- Subscription
Id - Local subscription ID
- Subscription
Pause Request - Whether a subscription is paused
- Subscription
Plan - A subscription plan
- Subscription
Plan Path - Trial
Period - Represents a trial period length
- Update
School Account Request - Request to update a school profile.
- Update
Subscription Cancellation Path - Update
Subscription Paused Path - Update
Subscription Plans Request - Request to create or update a subscription plans
- Upgrade
Subscription Plan Path - Upgrade
Subscription Plan Request - Request to upgrade a subscription plan
- User
Account Summary - Summary of the user’s account. This could be a school account that a user is a member of.
Enums§
- Account
IfAuthorized - A school account only if the user requesting the account is a system admin or an account admin.
- Account
Type - The type of account
- Billing
Interval - The subscriptions billing interval
- Cancellation
Status - Set a subscriptions cancellation status
- Payment
Method Type - Type of payment method
- Payment
Network - Payment network associated with a Card
- Plan
Tier - Subscription plan tier
- Plan
Type - Possible individual subscription plans
- School
Name Request - Whether the user is creating a new school name or chosen an existing name that we know about
- Subscription
Status - Status of a subscription
- Subscription
Tier - The tier a subscription is on. This would apply to any
SubscriptionType - Subscription
Type - 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