Get Billing

Get billing information including subscription details and linked organizations

Endpoint

GET https://api.ugc.inc/billing

Overview

Retrieve your billing information, including Stripe subscription status, slot counts by tier, and linked organizations. Requires a profile-scoped API key.

Request

No request body required. Authentication via profile-scoped Bearer token.

Response

data · object

Show Response properties

billing_id · string

Unique billing record identifier

subscription · object | null

Stripe subscription details (null if no subscription)

Show Subscription properties

status · string

Stripe subscription status (e.g., active, canceled, past_due)

cancel_at_period_end · boolean

Whether the subscription will cancel at the end of the current period

current_period_start · string

ISO 8601 timestamp of the current billing period start

current_period_end · string

ISO 8601 timestamp of the current billing period end

slots · object

Account slot counts by tier

Show Slot properties

basic · number

Number of basic tier slots

premium · number

Number of premium tier slots

orgs · array

Linked organizations

Show Org properties

id · string

Organization ID

name · string | null

Organization name

cURL

curl https://api.ugc.inc/billing \
  -H "Authorization: Bearer YOUR_API_KEY"

Success Response

{
  "ok": true,
  "code": 200,
  "message": "Success",
  "data": {
    "billing_id": "bill_123",
    "subscription": {
      "status": "active",
      "cancel_at_period_end": false,
      "current_period_start": "2025-01-01T00:00:00.000Z",
      "current_period_end": "2025-02-01T00:00:00.000Z",
      "slots": {
        "basic": 5,
        "premium": 2
      }
    },
    "orgs": [
      {
        "id": "org_123",
        "name": "My Organization"
      }
    ]
  }
}