Account Management - Delete Membership Subscription

Service:

Admin

API Version:

240426

Deletes a player's subscription

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

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
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.
SubscriptionId	True	string	Id of the subscription that should be deleted from the membership.
CustomTags		object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Responses

Name	Type	Description
200 OK	DeleteMembershipSubscriptionResult
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
DeleteMembershipSubscriptionRequest	This API lets developers delete a membership subscription.
DeleteMembershipSubscriptionResult

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

DeleteMembershipSubscriptionRequest

This API lets developers delete a membership subscription.

Name	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
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.
SubscriptionId	string	Id of the subscription that should be deleted from the membership.

DeleteMembershipSubscriptionResult

Error Codes

Name	Code
MembershipNotFound	1331