Credit Transfers

Transfer prepaid API credits from your organization to another Crane Ledger account. Credits move instantly as paired credit_transfer_out / credit_transfer_in ledger events. No Stripe or x402 charge — only credits you already paid for (starter free credits cannot be transferred).

Destination identification

Same lookup as Organization Transfers: provide exactly one of:

FieldMeaning
to_github_usernameRegistered user's GitHub username
to_emailRegistered user's email

Credits land in that user's root (billing master) organization. The response includes to_organization_name and recipient display fields so you can confirm the destination.

Permissions

Any API key (or dashboard member session) that can access the source organization may transfer. There is no owner/admin role check. The destination can be any registered user's root org.

Endpoint

POST/organizations/:organization_id/credits/transfer
Auth required

Request body

ParameterTypeRequiredDescription
to_github_usernamestringConditionalExactly one of username or email
to_emailstringConditionalExactly one of username or email
amountintegerYesCredits to move (> 0, ≤ transferable paid balance)
notestringNoMemo on both ledger sides

Headers

HeaderDescription
Idempotency-KeyOptional; retries with the same key return the original transfer

Response highlights

  • to_organization_name / from_organization_name
  • to_github_username, to_email, to_display_name
  • from_credits_remaining, to_credits_remaining
  • idempotent: true when served from an idempotency key

MCP

Product MCP tool transfer_credits (/mcp only; not on /mcp/chatgpt). Annotations: readOnlyHint: false, destructiveHint: true, openWorldHint: false.


Need help?

Create a free account (GitHub, Google, Apple, or email) to access our support portal. Once signed in, use the Support tab in your dashboard to submit a support ticket — no GitHub account required. Our team typically responds within 24 hours.