ListenHubOpenAPI
EN中文
API Reference

Subscription

Query account subscription status, credit balances, and expiration details.

Query Subscription and Credit Balance

GET /v1/user/subscription

Query account credits, subscription status, and related metadata.

Request example:

curl -X GET "https://api.marswave.ai/openapi/v1/user/subscription" \
  -H "Authorization: Bearer $LISTENHUB_API_KEY"
const response = await fetch('https://api.marswave.ai/openapi/v1/user/subscription', {
  headers: {
    'Authorization': `Bearer ${process.env.LISTENHUB_API_KEY}`,
  },
});
const data = await response.json();
console.log(data);
import os
import requests

response = requests.get(
    'https://api.marswave.ai/openapi/v1/user/subscription',
    headers={'Authorization': f'Bearer {os.environ["LISTENHUB_API_KEY"]}'}
)
data = response.json()
print(data)

Response example:

{
  "code": 0,
  "message": "",
  "data": {
    "subscriptionStartedAt": 1735660800000,
    "subscriptionExpiresAt": 1767196800000,
    "usageAvailableMonthlyCredits": 500,
    "usageTotalMonthlyCredits": 1000,
    "usageAvailablePermanentCredits": 300,
    "usageTotalPermanentCredits": 500,
    "usageAvailableLimitedTimeCredits": 200,
    "totalAvailableCredits": 1000,
    "resetAt": 1735660800000,
    "platform": "web",
    "renewStatus": false,
    "paidStatus": true,
    "subscriptionPlan": {
      "name": "pro",
      "duration": "monthly",
      "platform": "web"
    }
  }
}

Field reference:

  • totalAvailableCredits: total available credits
  • usageAvailableMonthlyCredits: available monthly credits
  • usageAvailablePermanentCredits: available permanent credits
  • usageAvailableLimitedTimeCredits: available time-limited credits
  • resetAt: monthly credit reset time
  • subscriptionExpiresAt: subscription expiration time

On this page

Query Subscription and Credit Balance