Subscription suspend

PUT

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

lts

This API endpoint is required for suspend a specific buyer’s subscription.

For example:

When suspending a subscription, its status changes from active (or any other status) to suspended.

The suspended status is final, once a subscription is suspended, it cannot be moved to another status.
Also note that when a subscription is suspended, all payment methods for the buyer are disabled.

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 permanently suspending the subscription.
Default: "Manually suspended subscription".

max length 255

Response parameters

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

{
  "uuid": null,
  "message": "Subscription is disabled",
  "code": 3000,
  "traceId": "aa31f50f39d1618651ae70ced2ca7f33"
}

{
  "uuid": null,
  "message": "Subscription is suspended",
  "code": 3000,
  "traceId": "b3d1dcf8836ba70c70e2bdcf774c3484"
}

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.