Get buyer's subscriptions

GET

[GET] /api/v2/buyers/{buyerId}/subscriptions/

lts

This API endpoint is required to retrieve all subscriptions for a buyer.

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

ids

array

optional

Subscription IDs for the specified buyer that you want to retrieve information for.
If ids[] is not provided, the response will include information for all of the buyer’s subscriptions.

limit

integer

optional

The maximum number of items returned in a single request

offset

integer

optional

The number of items to skip

Response parameters

Attribute

Type

Description

meta

object

Provides metadata about the response

{
  "data": [
    {
      "id": "a67be316-b150-404d-9562-519032d10632",
      "customerId": "2a767890-57a7-4ef3-abec-0bbf6a4b4ca6",
      "buyerId": "9d92c8e0-0908-4dc2-b04e-36a16c979635",
      "startDate": "2024-11-25T12:26:54+00:00",
      "endDate": "2024-12-23T12:26:54+00:00",
      "status": "frozen",
      "autoChargeStatus": true,
      "isManual": false,
      "createdAt": "2024-11-25T12:26:54+00:00",
      "isTokenized": true,
      "product": {
        "id": "c4bc3816-e0bd-4655-af32-54d355e47430",
        "code": "MMBM",
        "name": "mSpy 1-Month Basic Subscription",
        "durationDays": 28,
        "durationWeeks": 4,
        "durationMonths": 1,
        "availableForPurchase": true,
        "availableForShop": true,
        "availableForControlPanel": true,
        "availableForAutocharge": true,
        "isTrial": false
      },
      "statusInfo": [
        {
          "status": "frozen",
          "reason": "subscription_manual_freeze",
          "createdAt": "2024-11-25T12:26:56+00:00"
        }
      ],
      "freezeDetails": {
        "frozenAt": "2024-11-25T12:26:56+00:00",
        "unfreezeAt": "2024-12-25T00:00:00+00:00"
      }
    }
  ],
  "meta": {
    "type": "collection",
    "total": 1,
    "offset": 0
  }
}

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.