Get Subscription Status

This endpoint returns the most recent status of a subscription managed by Zotlo.

Use the GET method to query a subscriber. Both subscriberId and packageId parameters are required to retrieve the correct subscription record.

The response includes the subscription’s state, status, lifecycle dates, and related metadata.

Method	GET
URL	https://api.zotlo.com/v1/subscription/profile?subscriberId=SUBSCRIBER_ID&packageId=PACKAGE_ID&isSandbox=true|false

Request Parameters

Field	Type	Description
subscriberId	Required	The email or phone number the user provided when starting the subscription.
packageId	Required	The ID of the package to query. A successful response is returned only if the user has a subscription for this package.
isSandbox	Required	Indicates whether the subscription was created in sandbox or live mode.Send: true → sandbox false → live

Sample Request

GET https://api.zotlo.com/v1/subscription/profile?subscriberId=SUB_ID&packageId=PACKAGE_ID HTTP/1.1
AccessKey: ••••••
AccessSecret: ••••••
Content-Type: application/json
ApplicationId: •
Language: en

You can find your AccessKey and AccessSecret in the Zotlo Panel under Developer Tools → API Keys

Sending ApplicationId is optional.

Successful Response

Active Subscription

{
  "meta": {
    "requestId": "6d2989e84793-REQ-5f32a82e299ff",
    "httpStatus": 200
  },
  "result": {
    "profile": {
      "status": "active",
      "realStatus": "active",
      "subscriberId": "[email protected]",
      "subscriptionType": "paid",
      "startDate": "2020-08-10 21:57:25",
      "expireDate": "2020-09-09 21:57:25",
      "package": "zotlo-premium",
      "country": "TR",
      "phoneNumber": "[phone]",
      "language": "tr",
      "originalTransactionId": "80397a95-742d-4c74-975e-f740d1909580",
      "cancellation": null,
      "customParameters": {
        "source": "Landing",
        "adjust": {
          "idfa": "A161AD92-7DC3-4B15-B14C-3AA65995AFCC"
        }
      },
      "renewalFetchCount": 0
    },
    "package": {
      "packageId": "zotlo-premium",
      "price": 3.99,
      "currency": "USD",
      "packageType": "subscription",
      "name": "Zotlo Premium"
    },
    "newPackage": null,
    "card": {
      "cardNumber": "411111******1111",
      "expireDate": "12/20"
    },
    "customer": {
      "id": 1,
      "createDate": "2020-05-13 12:57:36",
      "country": "TR",
      "firstname": "Test",
      "lastname": "Test",
      "email": "[email protected]"
    }
  }
}

Canceled Subscription

{
  "meta": {
    "requestId": "6d2989e84793-REQ-5f32a89037084",
    "httpStatus": 200
  },
  "result": {
    "profile": {
      "status": "active",
      "realStatus": "passive",
      "subscriberId": "313334342",
      "subscriptionType": "paid",
      "startDate": "2020-08-07 06:44:16",
      "expireDate": "2020-09-06 06:44:16",
      "package": "zotlo-premium",
      "country": "TR",
      "phoneNumber": "[phone]",
      "language": "tr",
      "originalTransactionId": "51e8fd2a-5b28-4b9f-bfe3-5f752b09d3a3",
      "cancellation": {
        "date": "2020-08-07 06:46:00",
        "reason": "Not Interest",
        "code": "CU00001"
      },
      "customParameters": {
        "source": "Landing"
      }
    },
    "package": {
      "packageId": "zotlo-premium",
      "price": 2.99,
      "currency": "USD",
      "packageType": "subscription",
      "name": "Zotlo Premium"
    },
    "newPackage": null,
    "card": {
      "cardNumber": "411111******1111",
      "expireDate": "12/20"
    },
    "customer": {
      "id": 1,
      "createDate": "2020-05-13 12:57:36",
      "country": "TR",
      "firstname": "Test",
      "lastname": "Test",
      "email": "[email protected]"
    }
  }
}

Key Response Fields

Subscription Fields

Field	Description
status	high-level subscription status delivered to your app. active, grace, passive.
realStatus	the system’s true internal status. Returns passive immediately after cancellation even if status remains active until expire_date.
subscriptionType	trial (still in trial) or paid (charged at least once).
startDate	Subscription start date.
expireDate	Current billing end date.
package	Active package ID.
country	Subscriber’s country.
language	Subscriber’s language.
cancellation	Cancellation details if the user or system canceled the subscription. nullif not canceled.

Cancellation Details

Field	Description
date	Cancellation timestamp.
reason	Reason text for cancellation.
code	Cancellation code (CP00001, CU00001, CU00002).

Failed Response

All failed responses follow the same standard error format. (See: Error Handling)