EndpointAdminProcurement class Endpoint

Endpoint for global administrator to handle procurement for users.

Inheritance

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 String userEmail, UuidValue? subscriptionId, String? cloudProjectId, bool? terminateImmediately}) → Future<void>
Cancels a subscription of the user at the end of its current term. Either subscriptionId or cloudProjectId must be provided.
listProcuredProducts({required String userEmail}) → Future<List<(String, String)>>
Fetches a user's procured products. Returns a list of (String, String) with the product ID and its type.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
procurePlan({required String userEmail, required String planProductName, int? planProductVersion, int? trialPeriodOverride, bool? overrideChecks}) → Future<UuidValue>
Procures a plan for a user. If planProductVersion is not provided, the default version is used. If trialPeriodOverride is provided, it will override the trial period (number of days) in billing. The owner's trial end is synced from the new subscription afterward. If overrideChecks is true, the product availability checks are overridden.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited