Subscription disable
This API endpoint is required to move a buyer’s subscription to the disabled status in order to permanently stop it.
If a subscription is in the
disabled status, it cannot be transitioned to any other status except suspended.Header parameters
Attribute
Requirement
Description
x-public-key
mandatory
a public key that identifies the merchant account (there can be several for one merchant)
x-buyer-ip
mandatory
is responsible for information about the buyer's IP address
x-date
mandatory
is responsible for the date and time of sending the request
x-token
mandatory
generated on the merchant side
x-source
mandatory
identifier of the type of service that is the initiator of the request
x-id
mandatory
service identifier from which the current request is made
Request parameters
Attribute
Type
Requirement
Description
Standard
buyerId
string
mandatory
Unique identifier of buyer in the system
uuid
subscriptionId
string
mandatory
Unique subscription identifier associated with the buyer
uuid
reason
string
optional
Contains the reason for disabling the subscription.
If not provided, the default value is
If not provided, the default value is
"Manually disabled subscription".max length 255
Response parameters
After the request is processed, the subscription is moved to the disabled status and the status 204 is returned without any data indicating the successful completion of the request.
Errors and interpretation
The list of possible errors for this endpoint, along with their types and interpretation, is provided in the general reference: Endpoint response errors.