Subscription freeze

PUT

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

lts

This endpoint is used when a buyer with an active subscription needs to freeze the current subscription.

For example:

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

Only an active subscription can be frozen, regardless of its endDate.

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

The reason for freezing the subscription.
‍Default: Subscription has been frozen by api.

max length 255

freezePeriodDays

integer

mandatory

The number of days the subscription should be frozen for

min 1,
max 366

Response parameters

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

{
  "uuid": null,
  "message": "This product cannot be frozen",
  "code": 3000,
  "traceId": "0f60fb2ce3855dfb2bde9c56c580728a"
}

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.