Subscription unfreeze

PUT

/api/v2/buyers/{buyerId}/subscriptions/{subscriptionId}/unfreeze

lts

This endpoint is required when a buyer with a frozen subscription needs to unfreeze the current subscription so it can be used again.

For example:

When the subscription is unfrozen, its status changes from frozen to active.

Only a frozen subscription can be unfrozen.

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 information about the reason for unfreezing the subscription.
‍Default: Subscription has been unfrozen by api

max length 255

Response parameters

After the request is processed, the subscription is moved to the active status and the status 204 is returned without any data indicating the successful completion of the request.

{
  "uuid": null,
  "message": "Only frozen subscriptions can be unfrozen",
  "code": 3000,
  "traceId": "1eea5454d76aecfbda7800699dd2462a"
}

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.