EndpointAdminProcurement class Endpoint

Endpoint for global administrator to handle procurement for users.

Inheritance

Implementers

Constructors

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
stream → Stream<SerializableModel>: Stream of messages sent from an endpoint that supports streaming.
no setterinherited

cancelPlan({required String userEmail, String? 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<String>: Procures a plan for a user. If planProductVersion is not provided, the latest 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.
resetStream() → void: Resets web socket stream, so it's possible to re-listen to endpoint streams.
inherited
sendStreamMessage(SerializableModel message) → Future<void>: Sends a message to the endpoint's stream.
inherited
toString() → String: A string representation of this object.
inherited