Subscription Management

Operations for managing user subscriptions and billing

Get user subscription details

get

Retrieves the current subscription information for the authenticated user

Authorizations

AuthorizationstringRequired

JWT token for user session authentication.

Responses

200

Subscription details retrieved successfully

application/json

Represents a user's subscription plan and usage

idstring · uuidRequired

The unique identifier for the subscription

user_idstring · uuidRequired

The ID of the user who owns the subscription

statusstring · enumRequired

The current status of the subscription

Possible values:

plan_namestringOptional

The name of the subscription plan

Example: Pro Plan

generations_limitnumberRequired

Maximum number of generations allowed

Example: 50

generations_usednumberRequired

Number of generations used in current period

Example: 23

pages_limitnumberRequired

Maximum number of pages allowed

Example: 1000

pages_usednumberRequired

Number of pages used in current period

Example: 450

stripe_subscription_idstring · nullableOptional

Stripe subscription identifier

current_period_startstring · date-time · nullableOptional

Start of the current billing period

current_period_endstring · date-time · nullableOptional

End of the current billing period

created_atstring · date-timeRequired

When the subscription was created

updated_atstring · date-timeRequired

When the subscription was last updated

401

Unauthorized

application/json

404

No active subscription found

application/json

500

Internal Server Error

application/json

get/getSubscription

GET /api/getSubscription HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "user_id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "active",
  "plan_name": "Pro Plan",
  "generations_limit": 50,
  "generations_used": 23,
  "pages_limit": 1000,
  "pages_used": 450,
  "stripe_subscription_id": "text",
  "current_period_start": "2026-01-01T00:00:00.000Z",
  "current_period_end": "2026-01-01T00:00:00.000Z",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}