Subscription downgrade
This API endpoint is used to downgrade a buyer to a lower subscription plan.
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
productId
string
mandatory
Unique identifier of the product
uuid
Response parameters
Attribute
Type
Description
data
object
Contains the main subscription information
meta
object
Provides metadata about the response
{
"data": {
"id": "000347bb-61e7-46da-9804-027ad5be7c21",
"customerId": "59b7f459-8a97-415a-8b59-5455db56c9b5",
"buyerId": "9a13bd9b-5eee-4633-908e-b6c6d774ee9b",
"startDate": "2022-09-23T11:59:10+00:00",
"endDate": "2024-12-19T13:25:16+00:00",
"status": "active",
"autoChargeStatus": true,
"isManual": false,
"createdAt": "2022-09-23T11:59:10+00:00",
"statusInfo": [
{
"status": "active",
"reason": "renew",
"createdAt": "2023-06-29T13:05:50+00:00"
},
{
"status": "expired",
"reason": "Subscription expired",
"createdAt": "2023-12-15T12:01:26+00:00"
},
{
"status": "active",
"reason": "renew",
"createdAt": "2024-01-17T14:47:23+00:00"
}
],
"freezeDetails": null
},
"meta": []
}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.