SUBSCRIPTION API

Manage resources and operations related to subscription.

Data Center:

GET Get

GET https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/subscription

Fetches subscription details for a specific edition.

Parameters

Name	Type	In	Required	Description
edition_id	string	path	Required	The unique ID of the edition.

Responses

200 TRAIL PLAN

200 PAID PLAN

200 FREE PLAN

200 using filter fields

TRAIL PLAN - Response

{
  "data": {
    "subscription_info": {
      "edition_id": "98723605",
      "expiry_date": "Wed, 05 Mar 2025, 19:06:08",
      "purchase_date": "Mon, 03 Feb 2025, 19:06:08",
      "plan_name": "TRIAL_PLAN",
      "status": "Active"
    }
  },
  "message": "Subscription details fetched successfully",
  "request_uri": "/vani/api/v1/editions/98723605/subscription",
  "status": "success"
}

PAID PLAN - Response

{
  "data": {
    "subscription_info": {
      "plan_type": "Yearly",
      "edition_id": "96499735",
      "expiry_date": "Wed, 04 Feb 2026, 00:00:00",
      "purchase_date": "Tue, 04 Feb 2025, 00:51:12",
      "plan_name": "TEAM_PLAN",
      "status": "Active"
    }
  },
  "message": "Subscription details fetched successfully",
  "request_uri": "/vani/api/v1/editions/96499735/subscription",
  "status": "success"
}

FREE PLAN - Response

{
  "data": {
    "subscription_info": {
      "edition_id": "85572652",
      "expiry_date": "-1L",
      "purchase_date": "Mon, 24 Jun 2024, 11:44:23",
      "plan_name": "FREE_PLAN",
      "status": "Modified"
    }
  },
  "message": "Subscription details fetched successfully",
  "request_uri": "/vani/api/v1/editions/85572652/subscription",
  "status": "success"
}

using filter fields - Response

{
  "data": {
    "subscription_info": {
      "plan_type": "Yearly",
      "plan_name": "TEAM_PLAN",
      "status": "Active"
    }
  },
  "message": "Subscription details fetched successfully",
  "request_uri": "/vani/api/v1/editions/96499735/subscription",
  "status": "success"
}

Code Examples

cURL Command line HTTP client

JavaScript Fetch API example

Python Requests library example

cURL

curl -X GET "https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/subscription" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json"

JavaScript

const response = await fetch('https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/subscription', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
// Process the response data
return data;

Node.js

const https = require('https');
const url = require('url');

const options = {
  ...url.parse('https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/subscription'),
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  }
};

const req = https.request(options, (res) => {
  let data = '';
  res.on('data', (chunk) => data += chunk);
  res.on('end', () => {
    const result = JSON.parse(data);
    // Process the response data
  });
});

req.end();

Python

import requests

url = "https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/subscription"
headers = {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
}

response = requests.get(url, headers=headers)
data = response.json()
print(data)

Java

import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import java.time.Duration;

public class ApiClient {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newBuilder()
            .connectTimeout(Duration.ofSeconds(10))
            .build();

        HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
            .uri(URI.create("https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/subscription"))
            .header("Authorization", "Bearer YOUR_ACCESS_TOKEN")
            .header("Content-Type", "application/json")
            .timeout(Duration.ofSeconds(30));

        HttpRequest request = requestBuilder
            .GET(HttpRequest.BodyPublishers.noBody())
            .build();

        HttpResponse<String> response = client.send(request,
            HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}

Deluge

info "Making API request to: https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/subscription";

headers = Map();
headers.put("Authorization", "Bearer YOUR_ACCESS_TOKEN");
headers.put("Content-Type", "application/json");

response = invokeurl
[
    url: "https://api.app.vanihq.com/vani/api/v1/editions/{edition_id}/subscription"
    type: GET
    headers: headers
];

if (response.get("status_code") == 200) {
    info "Request successful";
    responseData = response.get("response");
    info responseData;
} else {
    info "Request failed with status: " + response.get("status_code");
    info response.get("response");
}