Account Management - Set Membership Override

Service:

Admin

API Version:

240426

Sets the override expiration for a membership subscription

POST https://titleId.playfabapi.com/Admin/SetMembershipOverride

Request Header

Name	Required	Type	Description
X-SecretKey	True	string	This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Request Body

Name	Required	Type	Description
ExpirationTime	True	string	Expiration time for the membership in DateTime format, will override any subscription expirations.
MembershipId	True	string	Id of the membership to apply the override expiration date to.
PlayFabId	True	string	Unique PlayFab assigned ID of the user on whom the operation will be performed.
CustomTags		object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Responses

Name	Type	Description
200 OK	SetMembershipOverrideResult
400 Bad Request	ApiErrorWrapper	This is the outer wrapper for all responses with errors

Security

X-SecretKey

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Type: apiKey
In: header

Definitions

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
SetMembershipOverrideRequest	This API lets developers set overrides for membership expirations, independent of any subscriptions setting it.
SetMembershipOverrideResult

ApiErrorWrapper

The basic wrapper around every failed API response

Name	Type	Description
code	integer	Numerical HTTP code
error	string	Playfab error code
errorCode	integer	Numerical PlayFab error code
errorDetails	object	Detailed description of individual issues with the request object
errorMessage	string	Description for the PlayFab errorCode
status	string	String HTTP code

SetMembershipOverrideRequest

This API lets developers set overrides for membership expirations, independent of any subscriptions setting it.

Name	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
ExpirationTime	string	Expiration time for the membership in DateTime format, will override any subscription expirations.
MembershipId	string	Id of the membership to apply the override expiration date to.
PlayFabId	string	Unique PlayFab assigned ID of the user on whom the operation will be performed.

SetMembershipOverrideResult

Error Codes

Name	Code
MembershipNotFound	1331