Transfer Org Credits To Sub-Org
Transfers credits from a parent organization to one of its sub-organizations by specifying the sub-organization UUID and the number of credits to transfer. This operation is useful for managing credit allocation within an enterprise structure.
Endpoint
POST {{host}}/api/v2/organizations/transfer/credits
Request Body
-
sub_org_uuid (string, required): UUID of the sub-organization to receive credits.
-
credits (integer, required): Number of credits to transfer.
Body type: multipart/form-data
Authentication
This endpoint requires authentication. Ensure that a valid user-token is provided in the request headers or as required by your environment configuration.
Example Successful Response
{
"success": true,
"message": "Credits transferred successfully.",
"data": {
"parent_org_uuid": "string",
"sub_org_uuid": "string",
"transferred_credits": 20,
"remaining_credits": 80
}
}
Example Error Response
{
"success": false,
"message": "Insufficient credits or invalid sub_org_uuid.",
"error_code": "ORG_CREDITS_TRANSFER_FAILED"
}
Usage Notes
-
Both parameters are required.
-
Only parent organizations can transfer credits to their sub-organizations.
-
Insufficient credits or invalid UUIDs will result in an error response.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
