Usage & Billing API

Monitor your API usage, track translation credits, and manage billing information.

Endpoints

Get your current usage summary for the billing period.

GET /api/v1/usage

Authentication

Requires API key with Authorization: Bearer <api_key> header

URL Parameters

Name	Type	Required	Description
`period`	`string`	No	Billing period (current, previous, or YYYY-MM) (default: `current`)

Response Example

{
  "success": true,
  "data": {
    "period": {
      "start": "2024-01-01T00:00:00Z",
      "end": "2024-01-31T23:59:59Z"
    },
    "plan": {
      "name": "Pro",
      "translationCredits": 100000,
      "screenshotCredits": 500,
      "projects": 10
    },
    "usage": {
      "translationCharacters": 45230,
      "translationCreditsRemaining": 54770,
      "screenshots": 127,
      "screenshotCreditsRemaining": 373,
      "projects": 3,
      "apiCalls": 1547
    },
    "breakdown": {
      "translations": [
        { "date": "2024-01-15", "characters": 12500, "locales": 5 },
        { "date": "2024-01-18", "characters": 8730, "locales": 3 }
      ],
      "screenshots": [
        { "date": "2024-01-16", "count": 45, "devices": ["iPhone 15 Pro", "iPad Pro"] },
        { "date": "2024-01-19", "count": 82, "devices": ["iPhone 15 Pro"] }
      ]
    }
  }
}

Code Examples

curl -X GET "https://api.appstorecopilot.com/v1/usage?period=current" \
  -H "Authorization: Bearer $ASC_API_KEY"

Get your current billing information and subscription details.

GET /api/v1/billing

Authentication

Requires API key with Authorization: Bearer <api_key> header

Response Example

{
  "success": true,
  "data": {
    "subscription": {
      "plan": "Pro",
      "status": "active",
      "currentPeriodStart": "2024-01-01T00:00:00Z",
      "currentPeriodEnd": "2024-01-31T23:59:59Z",
      "cancelAtPeriodEnd": false
    },
    "paymentMethod": {
      "type": "card",
      "brand": "visa",
      "last4": "4242",
      "expiryMonth": 12,
      "expiryYear": 2025
    },
    "invoices": [
      {
        "id": "inv_abc123",
        "amount": 4900,
        "currency": "usd",
        "status": "paid",
        "date": "2024-01-01T00:00:00Z",
        "pdfUrl": "https://..."
      }
    ]
  }
}

Code Examples

curl -X GET https://api.appstorecopilot.com/v1/billing \
  -H "Authorization: Bearer $ASC_API_KEY"

Plan Limits

Feature	Free	Pro	Enterprise
Translation Credits	10,000 chars/mo	100,000 chars/mo	Unlimited
Screenshots	50/mo	500/mo	Unlimited
Projects	1	10	Unlimited
API Rate Limit	100 req/min	1,000 req/min	10,000 req/min