EndpointPlans class Endpoint
Endpoint for managing subscription plans.
- Throws ProcurementDeniedException if the procurement fails.
- Throws NotFoundException if the plan is not found.
- Inheritance
-
- Object
- EndpointRef
- EndpointPlans
Constructors
- EndpointPlans(EndpointCaller caller)
Properties
- caller → EndpointCaller
-
Holds a reference to the caller class.
finalinherited
- client ↔ ServerpodClientShared
-
Reference to the client.
latefinalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- name → String
-
The name of the endpoint this reference is connected to.
no setteroverride
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
cancelPlan(
{required UuidValue subscriptionId}) → Future< void> - Cancels a subscription owned by the user.
-
checkPlanAvailability(
{String? planProductName, String? planName}) → Future< void> - Checks if a plan is available for procurement.
-
getPlanInfo(
{required String planProductName}) → Future< PlanInfo> - Gets the plan info for the named plan product.
-
getSubscriptionInfo(
{required UuidValue subscriptionId}) → Future< SubscriptionInfo> - Gets a subscription info of a subscription owned by the user.
-
getSubscriptionInfoOfProject(
{required String cloudProjectId}) → Future< SubscriptionInfo> - Gets the subscription info for the subscription of the given project id.
-
listPlanNames(
) → Future< List< String> > - Fetches the names of all the subscription plans.
-
listPlans(
) → Future< List< PlanInfo> > -
Lists the public plans (
starter,growth) for the private customer billing type. Each PlanInfo carries its bundled PlanInfo.projectProduct. -
listProcuredPlanNames(
) → Future< List< String> > - Fetches the names of the subscription plans owned by the user.
-
listSubscriptions(
) → Future< List< SubscriptionInfo> > - Lists the subscriptions owned by the user.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
procurePlan(
{String? planProductName, String? planName}) → Future< UuidValue> - Procures a subscription plan.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited