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:
| Field | Meaning |
|---|---|
to_github_username | Registered user's GitHub username |
to_email | Registered 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
/organizations/:organization_id/credits/transferRequest body
| Parameter | Type | Required | Description |
|---|---|---|---|
to_github_username | string | Conditional | Exactly one of username or email |
to_email | string | Conditional | Exactly one of username or email |
amount | integer | Yes | Credits to move (> 0, ≤ transferable paid balance) |
note | string | No | Memo on both ledger sides |
Headers
| Header | Description |
|---|---|
Idempotency-Key | Optional; retries with the same key return the original transfer |
Response highlights
to_organization_name/from_organization_nameto_github_username,to_email,to_display_namefrom_credits_remaining,to_credits_remainingidempotent: truewhen 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.
- ✨ For LLMs/AI assistants: Read our structured API reference
- Legal: Terms of Service · Privacy Policy