credits

Get your organization's credit balance and your member allowance

Changed on

Returns whole credits from the authenticated API key owner's organization wallet. Member usage and caps cover the UTC calendar month, independently of the wallet billing period. Null member cap and remaining allowance mean unlimited, not zero; member allowance is separate from the shared wallet balance. current_period_end is a nullable Unix timestamp in seconds. Available to any valid API key regardless of plan or remaining credits. Returns 404 when no organization wallet exists and never creates one.

get/v1/credits

Request

  • Base URL
    https://builder.twin.so
  • Auth
    API key in header x-api-key

Response

credits_purchasedinteger required
credits_remaininginteger required
credits_usedinteger required
current_period_endinteger nullable
member_period_cap_creditsinteger nullable
member_period_remaining_creditsinteger nullable
member_period_used_creditsinteger required
organization_idstring uuid required
period_credits_totalinteger required

Changes