Static Public Member Functions
static void	GetSubscriptionPublicPlans (Action< PlanItems > onSuccess, Action< Error > onError, int[] planId=null, string[] planExternalId=null, int limit=50, int offset=0, string locale=null, string country=null)
	Returns a list of all plans, including plans purchased by the user while promotions are active. More...

static void	GetSubscriptions (Action< SubscriptionItems > onSuccess, Action< Error > onError, int limit=50, int offset=0, string locale=null)
	Returns a list of active recurrent subscriptions that have the status `active`, `non renewing`, and `pause`. More...

static void	GetSubscriptionDetails (int subscriptionId, Action< SubscriptionDetails > onSuccess, Action< Error > onError, string locale=null)
	Returns information about a subscription by its ID. Subscription can be have any status. More...

static void	CancelSubscription (int subscriptionId, Action onSuccess, Action< Error > onError)
	Changes a regular subscription status to `non_renewing` (subscription is automatically canceled after expiration). More...

static void	GetSubscriptionRenewalUrl (int subscriptionId, Action< PaymentLink > onSuccess, Action< Error > onError, PaymentSettings settings=null)
	Returns the URL of the renewal interface for the selected subscription. More...

static void	GetSubscriptionPurchaseUrl (string planExternalId, Action< PaymentLink > onSuccess, Action< Error > onError, PaymentSettings settings=null, string country=null)
	Returns Pay Station URL for the subscription purchase. More...

static void	GetSubscriptionManagementUrl (Action< PaymentLink > onSuccess, Action< Error > onError, PaymentSettings settings=null, string country=null)
	Returns the URL of the management interface for the selected subscription. More...

static void	GetSubscriptionPlans (Action< PlanItems > onSuccess, Action< Error > onError, int[] planId=null, string[] planExternalId=null, int limit=50, int offset=0, string locale=null, string country=null)
	Returns a list of plans available to authorized users, including plans purchased by the user while promotions are active. More...

Member Function Documentation

◆ CancelSubscription()

static void Xsolla.Subscriptions.XsollaSubscriptions.CancelSubscription	(	int	subscriptionId,
		Action	onSuccess,
		Action< Error >	onError
	)

inlinestatic

Changes a regular subscription status to non_renewing (subscription is automatically canceled after expiration).

More about the use cases.

Parameters

subscriptionId	Subscription ID.
onSuccess	Called after successful subscription cancelling.
onError	Called after the request resulted with an error.

◆ GetSubscriptionDetails()

static void Xsolla.Subscriptions.XsollaSubscriptions.GetSubscriptionDetails	(	int	subscriptionId,
		Action< SubscriptionDetails >	onSuccess,
		Action< Error >	onError,
		string	locale = `null`
	)

inlinestatic

Returns information about a subscription by its ID. Subscription can be have any status.

More about the use cases.

Parameters

subscriptionId	Subscription ID.
onSuccess	Called after subscription data have been successfully received.
onError	Called after the request resulted with an error.
locale	Language of the UI. Two-letter lowercase language code. Leave empty to use the default value.

◆ GetSubscriptionManagementUrl()

static void Xsolla.Subscriptions.XsollaSubscriptions.GetSubscriptionManagementUrl	(	Action< PaymentLink >	onSuccess,
		Action< Error >	onError,
		PaymentSettings	settings = `null`,
		string	country = `null`
	)

inlinestatic

Returns the URL of the management interface for the selected subscription.

More about the use cases.

Parameters

onSuccess	Called after the URL has been successfully received.
onError	Called after the request resulted with an error.
settings	Settings.
country	User's country. Affects the choice of locale and currency. Two-letter uppercase country code per ISO 3166-1 alpha-2. Calculations are based on the user's IP address if the country is not specified. Check the documentation for detailed information about countries supported by Xsolla.

◆ GetSubscriptionPlans()

static void Xsolla.Subscriptions.XsollaSubscriptions.GetSubscriptionPlans	(	Action< PlanItems >	onSuccess,
		Action< Error >	onError,
		int[]	planId = `null`,
		string[]	planExternalId = `null`,
		int	limit = `50`,
		int	offset = `0`,
		string	locale = `null`,
		string	country = `null`
	)

inlinestatic

Returns a list of plans available to authorized users, including plans purchased by the user while promotions are active.

More about the use cases.

Parameters

onSuccess	Called after a list of plans has been successfully received.
onError	Called after the request resulted with an error.
planId	Array of subscription plan IDs. Plan ID can be found in the URL of the subscription details page in Publisher Account (https://publisher.xsolla.com/{merchant_id}/projects/{project_id}/subscriptions/plans/{plan_id}).
planExternalId	List of subscription plan external IDs (32 characters per ID). Plan external ID can be found in Publisher Account in the Subscriptions > Subscription plans section next to the plan name.
limit	Limit for the number of elements on the page (15 elements are displayed by default).
offset	Number of elements from which the list is generated (the count starts from 0).
locale	Language of the UI. Two-letter lowercase language code. Leave empty to use the default value.
country	User's country. Affects the choice of locale and currency. Two-letter uppercase country code per ISO 3166-1 alpha-2. Calculations are based on the user's IP address if the country is not specified. Check the documentation for detailed information about countries supported by Xsolla.

◆ GetSubscriptionPublicPlans()

static void Xsolla.Subscriptions.XsollaSubscriptions.GetSubscriptionPublicPlans	(	Action< PlanItems >	onSuccess,
		Action< Error >	onError,
		int[]	planId = `null`,
		string[]	planExternalId = `null`,
		int	limit = `50`,
		int	offset = `0`,
		string	locale = `null`,
		string	country = `null`
	)

inlinestatic

Returns a list of all plans, including plans purchased by the user while promotions are active.

More about the use cases.

Parameters

onSuccess	Called after public plans have been successfully received.
onError	Called after the request resulted with an error.
planId	Array of subscription plan IDs. Plan ID can be found in the URL of the subscription details page in Publisher Account (https://publisher.xsolla.com/{merchant_id}/projects/{project_id}/subscriptions/plans/{plan_id}).
planExternalId	List of subscription plan external IDs (32 characters per ID). Plan external ID can be found in Publisher Account in the Subscriptions > Subscription plans section next to the plan name.
limit	Limit for the number of elements on the page (15 elements are displayed by default).
offset	Number of elements from which the list is generated (the count starts from 0).
locale	Language of the UI. Two-letter lowercase language code. Leave empty to use the default value.
country	User's country. Affects the choice of locale and currency. Two-letter uppercase country code per ISO 3166-1 alpha-2. Calculations are based on the user's IP address if the country is not specified. Check the documentation for detailed information about countries supported by Xsolla.

◆ GetSubscriptionPurchaseUrl()

static void Xsolla.Subscriptions.XsollaSubscriptions.GetSubscriptionPurchaseUrl	(	string	planExternalId,
		Action< PaymentLink >	onSuccess,
		Action< Error >	onError,
		PaymentSettings	settings = `null`,
		string	country = `null`
	)

inlinestatic

Returns Pay Station URL for the subscription purchase.

More about the use cases.

Parameters

planExternalId	List of subscription plan external IDs (32 characters per ID). Plan external ID can be found in Publisher Account in the Subscriptions > Subscription plans section next to the plan name.
onSuccess	Called after the URL has been successfully received.
onError	Called after the request resulted with an error.
settings	Pay Station UI settings.
country	User's country. Affects the choice of locale and currency. Two-letter uppercase country code per ISO 3166-1 alpha-2. Calculations are based on the user's IP address if the country is not specified. Check the documentation for detailed information about countries supported by Xsolla.

◆ GetSubscriptionRenewalUrl()

static void Xsolla.Subscriptions.XsollaSubscriptions.GetSubscriptionRenewalUrl	(	int	subscriptionId,
		Action< PaymentLink >	onSuccess,
		Action< Error >	onError,
		PaymentSettings	settings = `null`
	)

inlinestatic

Returns the URL of the renewal interface for the selected subscription.

More about the use cases.

Parameters

subscriptionId	Subscription ID.
onSuccess	Called after the URL has been successfully received.
onError	Called after the request resulted with an error.
settings	Pay Station UI settings.

◆ GetSubscriptions()

static void Xsolla.Subscriptions.XsollaSubscriptions.GetSubscriptions	(	Action< SubscriptionItems >	onSuccess,
		Action< Error >	onError,
		int	limit = `50`,
		int	offset = `0`,
		string	locale = `null`
	)

inlinestatic

Returns a list of active recurrent subscriptions that have the status active, non renewing, and pause.

More about the use cases.

Parameters

onSuccess	Called after the list pf subscriptions has been successfully received.
onError	Called after the request resulted with an error.
limit	Limit for the number of elements on the page (15 elements are displayed by default).
offset	Number of elements from which the list is generated (the count starts from 0).
locale	Language of the UI. Two-letter lowercase language code. Leave empty to use the default value.

The documentation for this class was generated from the following file:

Assets/Xsolla/Subscriptions/XsollaSubscriptions.cs

Static Public Member Functions

Member Function Documentation

◆ CancelSubscription()

◆ GetSubscriptionDetails()

◆ GetSubscriptionManagementUrl()

◆ GetSubscriptionPlans()

◆ GetSubscriptionPublicPlans()

◆ GetSubscriptionPurchaseUrl()

◆ GetSubscriptionRenewalUrl()

◆ GetSubscriptions()