RedRover Logo

Workspaces

Get Credits

Reads the workspace's credits: the balance, credits expiring soon, what posts and comments cost, 30 days of usage and a link to top up.

GET/credits
Scope: workspace:readAI Connector Tool: redrover_get_credits

Scheduling a post or comment takes its credits right away, soonest-expiring credits first, and cancelling it before it goes live gives them back. Credits expire 60 days after they are added.

When the balance can't cover new content, scheduling answers 402 with payment_required and a message that includes topUpUrl.

paysWithCredits is false for workspaces billed by invoice: their content costs no credits and is never blocked.

Headers

  • AuthorizationstringRequired

    Bearer followed by an rr_live_ API key or a connected app's access token. See Authentication.

  • X-Workspace-IdstringRequired

    The workspace to act on, from List Workspaces.

    UUID

Response

200 The workspace's credits.

  • dataobjectRequired
    Show 6 Child Fields
    • paysWithCreditsbooleanRequired

      False when the workspace is billed by invoice, so posts and comments cost no credits

    • balanceintegerRequired

      Credits available to spend now

    • expiringSoonobjectRequired

      Credits expiring in the next 7 days, or null

      nullable

      Show 2 Child Fields
      • creditsintegerRequired

        Credits that expire in the next 7 days

      • expiresAtstringRequired

        When the first of them expire

    • pricesobjectRequired
      Show 2 Child Fields
      • postintegerRequired

        Credits a post costs

      • commentintegerRequired

        Credits a comment costs

    • usageobject[]Required

      The last 30 days, oldest first

      Show 3 Child Fields
      • datestringRequired

        The day, YYYY-MM-DD in UTC

      • spentintegerRequired

        Credits taken by content scheduled that day

      • refundedintegerRequired

        Credits given back that day for cancelled content

    • topUpUrlstringRequired

      Where to buy more credits

Errors

Every error uses the error envelope.

  • 401The Authorization header is missing, or the key is invalid or revoked
  • 403The key lacks the endpoint's scope, or cannot reach the workspace
  • 429More than 120 requests in a minute. Wait for Retry-After seconds
  • 500Something went wrong on our side
curl "https://app.tryredrover.com/api/public/v1/credits" \
  -H "Authorization: Bearer $REDROVER_API_KEY" \
  -H "X-Workspace-Id: $REDROVER_WORKSPACE_ID"
200 Response
{
  "data": {
    "paysWithCredits": true,
    "balance": 184,
    "expiringSoon": {
      "credits": 40,
      "expiresAt": "2026-11-20T00:00:00.000Z"
    },
    "prices": {
      "post": 32,
      "comment": 8
    },
    "usage": [
      {
        "date": "2026-11-13",
        "spent": 48,
        "refunded": 0
      },
      {
        "date": "2026-11-14",
        "spent": 0,
        "refunded": 0
      },
      {
        "date": "2026-11-15",
        "spent": 72,
        "refunded": 8
      }
    ],
    "topUpUrl": "https://app.tryredrover.com/settings?tab=billing"
  }
}