Billing

Subscription, tiers, and credits. Requires master key.

Show billing info

get

Returns current subscription and billing details. Requires a master key.

Authorizations

PublicApiKey

AuthorizationstringRequired

API key sent as Bearer token. Two types:

• Master key (g_master_...): full access to all agents and endpoints.
• Agent key (g_agent_...): scoped to a single agent with specific permissions.

Responses

200

Billing details

application/json

successbooleanOptional

401

Unauthorized — Invalid or missing API key

application/json

403

Forbidden — Requires a master API key

application/json

get

/billing

HTTPcURLJavaScriptPython

GET /api/v1/billing HTTP/1.1
Host: api.guayaba.run
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "user_id": "123e4567-e89b-12d3-a456-426614174000",
    "tier_slug": "pro",
    "status": "active",
    "stripe_subscription_id": "text",
    "stripe_customer_id": "text",
    "started_at": "2026-06-08T02:30:01.387Z",
    "monthly_credits": 1,
    "current_period_start": "2026-06-08T02:30:01.387Z",
    "current_period_end": "2026-06-08T02:30:01.387Z",
    "trial_start": "2026-06-08T02:30:01.387Z",
    "trial_end": "2026-06-08T02:30:01.387Z",
    "cancel_at_period_end": true,
    "cancel_at": "2026-06-08T02:30:01.387Z",
    "created_at": "2026-06-08T02:30:01.387Z",
    "updated_at": "2026-06-08T02:30:01.387Z",
    "tier": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "slug": "pro",
      "name": "Pro",
      "monthly_credits": 1,
      "price": 1,
      "features": [
        "text"
      ],
      "max_running_agents": 1,
      "allowed_channels": [
        "text"
      ],
      "can_buy_credit_packages": true,
      "trial_days": 1,
      "is_active": true,
      "sort_order": 1
    }
  }
}

List subscription tiers

get

Returns available subscription tiers and pricing. Requires a master key.

Authorizations

PublicApiKey

AuthorizationstringRequired

API key sent as Bearer token. Two types:

• Master key (g_master_...): full access to all agents and endpoints.
• Agent key (g_agent_...): scoped to a single agent with specific permissions.

Responses

200

Subscription tiers

application/json

successbooleanOptional

401

Unauthorized — Invalid or missing API key

application/json

403

Forbidden — Requires a master API key

application/json

get

/billing/tiers

HTTPcURLJavaScriptPython

GET /api/v1/billing/tiers HTTP/1.1
Host: api.guayaba.run
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "slug": "pro",
      "name": "Pro",
      "monthly_credits": 1,
      "price": 1,
      "features": [
        "text"
      ],
      "max_running_agents": 1,
      "allowed_channels": [
        "text"
      ],
      "can_buy_credit_packages": true,
      "trial_days": 1,
      "is_active": true,
      "sort_order": 1
    }
  ]
}

Get credits breakdown

get

Returns detailed credits breakdown (subscription vs purchased). Requires a master key.

Authorizations

PublicApiKey

AuthorizationstringRequired

API key sent as Bearer token. Two types:

• Master key (g_master_...): full access to all agents and endpoints.
• Agent key (g_agent_...): scoped to a single agent with specific permissions.

Responses

200

Credits breakdown

application/json

successbooleanOptional

401

Unauthorized — Invalid or missing API key

application/json

403

Forbidden — Requires a master API key

application/json

get

/billing/credits

HTTPcURLJavaScriptPython

GET /api/v1/billing/credits HTTP/1.1
Host: api.guayaba.run
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "data": {
    "total_credits": 1,
    "subscription_credits": 1,
    "purchased_credits": 1
  }
}