> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developer.fortresstech.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.fortresstech.io/_mcp/server.

# Read Subscription

GET https://api.fortresstech.io/v1/subscriptions/{subscriptionId}

Defined, not yet publishedInfo for a specific subscription

Reference: https://developer.fortresstech.io/api-reference/subscriptions/read-subscription

## Authentication

- `x-api-key` header (required) — API Key authentication via header

## Request

### Path parameters

- `subscriptionId` (string, required) — The id of the subscription

## Response

### 200

Expected response to a valid request

- `id` (string, optional)
- `customerId` (string, optional) — The ID of the customer who holds the subscription
- `householdId` (string, optional) — The ID of the household of the customer
- `propertyId` (string, optional) — The ID of the property of the household
- `organizationId` (string, optional) — The ID of the organization that owns the property
- `leaseId` (string, optional, nullable) — The ID of the lease the subscription is attached to. It moves on lease renewal.
- `provider` (string, optional) — The slug of the provider, for example PINATA
- `serviceType` (string, optional) — The type of service the provider offers, for example RENT_REPORTING
- `planCode` (string, optional) — The code of the plan the resident is on
- `previousPlanCode` (string, optional, nullable) — The code of the plan before the last plan change
- `status` (enum, optional) — The lifecycle status of the subscription
  - Allowed values: `PENDING`, `ACTIVE`, `PAST_DUE`, `SUSPENDED`, `ENDED`
- `changeReason` (enum, optional) — The reason for the last change to the subscription
  - Allowed values: `ENROLLMENT`, `RESIDENT_UPGRADE`, `RESIDENT_DOWNGRADE`, `NONPAYMENT_SUSPENSION`, `LEASE_RENEWAL`, `MOVE_OUT`, `HOUSEHOLD_MOVE_OUT`, `PROPERTY_DISABLED`
- `priceCents` (integer, optional) — The plan price in cents, copied from the provider at enrollment
- `partnerReference` (string, optional, nullable) — The provider's ID for the resident
- `version` (integer, optional) — A number that increases on every change to the subscription
- `startedAt` (datetime, optional, nullable)
- `endedAt` (datetime, optional, nullable)
- `createdAt` (datetime, optional)
- `updatedAt` (datetime, optional)
- `deletedAt` (datetime, optional, nullable) — Set when the subscription row is soft-deleted. Always null on exported rows.
- `household` (households_components-schemas-Base, optional)

## Types

### households_components-schemas-Base

- `status` (enum, optional)
  - Allowed values: `APPLICANT`, `RESIDENT`, `PRIOR`
- `isUnderEviction` (boolean, optional)
- `id` (string, optional)
- `readableId` (string, optional)
- `idempotencyId` (string, optional)
- `createdAt` (datetime, optional)
- `updatedAt` (datetime, optional)
- `deletedAt` (datetime, optional)
- `currentUnitId` (string, optional) — Current unit the household is associated with. Set only when the lease is active
- `currentLeaseId` (string, optional) — Current active lease for the household.
- `applicationId` (string, optional)
- `organizationId` (string, optional)
- `propertyId` (string, optional)
- `currentCertificationId` (string, optional)
- `prospectId` (string, optional)
- `primaryCustomerId` (string, optional)
- `totalActiveRentAmount` (double, optional) — Sum of all active RENT monthly lease transactions for the household
- `totalActiveSubsidyAmount` (double, optional) — Sum of all active SUBRENT monthly lease transactions for the household
- `totalActiveFeesAmount` (double, optional) — Sum of all active non-optional fee (charge) monthly lease transactions for the household
- `unitId` (string, optional, deprecated) — Deprecated, use currentUnitId instead

## Examples

**Response**

```json
{
  "id": "string",
  "customerId": "string",
  "householdId": "string",
  "propertyId": "string",
  "organizationId": "string",
  "leaseId": "string",
  "provider": "string",
  "serviceType": "string",
  "planCode": "string",
  "previousPlanCode": "string",
  "status": "PENDING",
  "changeReason": "ENROLLMENT",
  "priceCents": 1,
  "partnerReference": "string",
  "version": 1,
  "startedAt": "2024-01-15T09:30:00Z",
  "endedAt": "2024-01-15T09:30:00Z",
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "deletedAt": "2024-01-15T09:30:00Z",
  "household": {
    "status": "APPLICANT",
    "isUnderEviction": true,
    "id": "string",
    "readableId": "string",
    "idempotencyId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "currentUnitId": "string",
    "currentLeaseId": "string",
    "applicationId": "string",
    "organizationId": "string",
    "propertyId": "string",
    "currentCertificationId": "string",
    "prospectId": "string",
    "primaryCustomerId": "string",
    "totalActiveRentAmount": 1.1,
    "totalActiveSubsidyAmount": 1.1,
    "totalActiveFeesAmount": 1.1,
    "unitId": "string"
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.fortresstech.io/v1/subscriptions/subscriptionId"

headers = {"x-api-key": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.fortresstech.io/v1/subscriptions/subscriptionId';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fortresstech.io/v1/subscriptions/subscriptionId"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.fortresstech.io/v1/subscriptions/subscriptionId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.fortresstech.io/v1/subscriptions/subscriptionId")
  .header("x-api-key", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.fortresstech.io/v1/subscriptions/subscriptionId', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.fortresstech.io/v1/subscriptions/subscriptionId");
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.fortresstech.io/v1/subscriptions/subscriptionId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```