Customer Credits

Operations Summary

Method	Endpoint	Description
Core CRUD
GET	/api/customer-credits/	List Customer Credits
GET	/api/customer-credits/{uuid}/	Retrieve
POST	/api/customer-credits/	Create
PUT	/api/customer-credits/{uuid}/	Update
PATCH	/api/customer-credits/{uuid}/	Partial Update
DELETE	/api/customer-credits/{uuid}/	Delete
Other Actions
GET	/api/customer-credits/{uuid}/consumptions/	Get credit consumption history grouped by month
POST	/api/customer-credits/{uuid}/adjust_withdrawable/	Adjust withdrawable
POST	/api/customer-credits/{uuid}/apply_compensations/	Apply compensations
POST	/api/customer-credits/{uuid}/clear_compensations/	Clear compensations

---

Core CRUD

List Customer Credits

HTTPiePythonTypeScriptQuery ParametersResponses

http \
  GET \
  https://api.example.com/api/customer-credits/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.customer_credit_o_enum import CustomerCreditOEnum # (1)
from waldur_api_client.api.customer_credits import customer_credits_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = customer_credits_list.sync(client=client)

for item in response:
    print(item)

1. Model Source: CustomerCreditOEnum
2. API Source: customer_credits_list

import { customerCreditsList } from 'waldur-js-client';

try {
  const response = await customerCreditsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

Name	Type	Description
customer_name	string
customer_slug	string
customer_uuid	string (uuid)
o	array	Ordering
page	integer	A page number within the paginated result set.
page_size	integer	Number of results to return per page.
query	string

200 -

The response body is an array of objects, where each object has the following structure:

Field	Type	Description
uuid	string (uuid)
url	string (uri)
value	string (decimal)
customer	string (uri)
customer_name	string
customer_uuid	string (uuid)
customer_slug	string
offerings	array of objects
offerings.uuid	string (uuid)
offerings.url	string (uri)
offerings.type	string
offerings.name	string
end_date	string (date)
expected_consumption	string (decimal)
minimal_consumption	number (double)
minimal_consumption_logic	string	Enum: fixed, linear
grace_coefficient	string (decimal)
apply_as_minimal_consumption	boolean
allocated_to_projects	number (double)
consumption_last_month	number (double)
withdrawable_balance	number (double)	Part of the credit that may leave the platform via payouts or transfers: earnings-typed ledger inflows minus outflows, capped by the current credit value so that staff-granted (promotional) credit is never withdrawable and credit expiry wipes earnings too.

---

Retrieve

HTTPiePythonTypeScriptPath ParametersResponses

http \
  GET \
  https://api.example.com/api/customer-credits/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.customer_credits import customer_credits_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = customer_credits_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)

1. API Source: customer_credits_retrieve

import { customerCreditsRetrieve } from 'waldur-js-client';

try {
  const response = await customerCreditsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

Name	Type	Required
uuid	string (uuid)	✓

200 -

Field	Type	Description
uuid	string (uuid)
url	string (uri)
value	string (decimal)
customer	string (uri)
customer_name	string
customer_uuid	string (uuid)
customer_slug	string
offerings	array of objects
offerings.uuid	string (uuid)
offerings.url	string (uri)
offerings.type	string
offerings.name	string
end_date	string (date)
expected_consumption	string (decimal)
minimal_consumption	number (double)
minimal_consumption_logic	string	Enum: fixed, linear
grace_coefficient	string (decimal)
apply_as_minimal_consumption	boolean
allocated_to_projects	number (double)
consumption_last_month	number (double)
withdrawable_balance	number (double)	Part of the credit that may leave the platform via payouts or transfers: earnings-typed ledger inflows minus outflows, capped by the current credit value so that staff-granted (promotional) credit is never withdrawable and credit expiry wipes earnings too.

---

Create

HTTPiePythonTypeScriptRequest Body (required)Responses

http \
  POST \
  https://api.example.com/api/customer-credits/ \
  Authorization:"Token YOUR_API_TOKEN" \
  customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.create_customer_credit_request import CreateCustomerCreditRequest # (1)
from waldur_api_client.api.customer_credits import customer_credits_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CreateCustomerCreditRequest(
    customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = customer_credits_create.sync(
    client=client,
    body=body_data
)

print(response)

1. Model Source: CreateCustomerCreditRequest
2. API Source: customer_credits_create

import { customerCreditsCreate } from 'waldur-js-client';

try {
  const response = await customerCreditsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "customer": "https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

Field	Type	Required
value	string (decimal)
customer	string (uri)	✓
offerings	array of string (uri)s
end_date	string (date)
expected_consumption	string (decimal)
minimal_consumption_logic	string
grace_coefficient	string (decimal)
apply_as_minimal_consumption	boolean

201 -

Field	Type	Description
uuid	string (uuid)
url	string (uri)
value	string (decimal)
customer	string (uri)
customer_name	string
customer_uuid	string (uuid)
customer_slug	string
offerings	array of string (uri)s
end_date	string (date)
expected_consumption	string (decimal)
minimal_consumption	number (double)
minimal_consumption_logic	string	Enum: fixed, linear
grace_coefficient	string (decimal)
apply_as_minimal_consumption	boolean
allocated_to_projects	number (double)
consumption_last_month	number (double)
withdrawable_balance	number (double)	Part of the credit that may leave the platform via payouts or transfers: earnings-typed ledger inflows minus outflows, capped by the current credit value so that staff-granted (promotional) credit is never withdrawable and credit expiry wipes earnings too.

---

Update

HTTPiePythonTypeScriptPath ParametersRequest Body (required)Responses

http \
  PUT \
  https://api.example.com/api/customer-credits/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.create_customer_credit_request import CreateCustomerCreditRequest # (1)
from waldur_api_client.api.customer_credits import customer_credits_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CreateCustomerCreditRequest(
    customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = customer_credits_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)

1. Model Source: CreateCustomerCreditRequest
2. API Source: customer_credits_update

import { customerCreditsUpdate } from 'waldur-js-client';

try {
  const response = await customerCreditsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "customer": "https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

Name	Type	Required
uuid	string (uuid)	✓

Field	Type	Required
value	string (decimal)
customer	string (uri)	✓
offerings	array of string (uri)s
end_date	string (date)
expected_consumption	string (decimal)
minimal_consumption_logic	string
grace_coefficient	string (decimal)
apply_as_minimal_consumption	boolean

200 -

Field	Type	Description
uuid	string (uuid)
url	string (uri)
value	string (decimal)
customer	string (uri)
customer_name	string
customer_uuid	string (uuid)
customer_slug	string
offerings	array of string (uri)s
end_date	string (date)
expected_consumption	string (decimal)
minimal_consumption	number (double)
minimal_consumption_logic	string	Enum: fixed, linear
grace_coefficient	string (decimal)
apply_as_minimal_consumption	boolean
allocated_to_projects	number (double)
consumption_last_month	number (double)
withdrawable_balance	number (double)	Part of the credit that may leave the platform via payouts or transfers: earnings-typed ledger inflows minus outflows, capped by the current credit value so that staff-granted (promotional) credit is never withdrawable and credit expiry wipes earnings too.

---

Partial Update

HTTPiePythonTypeScriptPath ParametersRequest BodyResponses

http \
  PATCH \
  https://api.example.com/api/customer-credits/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_create_customer_credit_request import PatchedCreateCustomerCreditRequest # (1)
from waldur_api_client.api.customer_credits import customer_credits_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedCreateCustomerCreditRequest()
response = customer_credits_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)

1. Model Source: PatchedCreateCustomerCreditRequest
2. API Source: customer_credits_partial_update

import { customerCreditsPartialUpdate } from 'waldur-js-client';

try {
  const response = await customerCreditsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

Name	Type	Required
uuid	string (uuid)	✓

Field	Type	Required
value	string (decimal)
customer	string (uri)
offerings	array of string (uri)s
end_date	string (date)
expected_consumption	string (decimal)
minimal_consumption_logic	string
grace_coefficient	string (decimal)
apply_as_minimal_consumption	boolean

200 -

Field	Type	Description
uuid	string (uuid)
url	string (uri)
value	string (decimal)
customer	string (uri)
customer_name	string
customer_uuid	string (uuid)
customer_slug	string
offerings	array of string (uri)s
end_date	string (date)
expected_consumption	string (decimal)
minimal_consumption	number (double)
minimal_consumption_logic	string	Enum: fixed, linear
grace_coefficient	string (decimal)
apply_as_minimal_consumption	boolean
allocated_to_projects	number (double)
consumption_last_month	number (double)
withdrawable_balance	number (double)	Part of the credit that may leave the platform via payouts or transfers: earnings-typed ledger inflows minus outflows, capped by the current credit value so that staff-granted (promotional) credit is never withdrawable and credit expiry wipes earnings too.

---

Delete

HTTPiePythonTypeScriptPath ParametersResponses

http \
  DELETE \
  https://api.example.com/api/customer-credits/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.customer_credits import customer_credits_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = customer_credits_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)

1. API Source: customer_credits_destroy

import { customerCreditsDestroy } from 'waldur-js-client';

try {
  const response = await customerCreditsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

Name	Type	Required
uuid	string (uuid)	✓

204 - No response body

---

Other Actions

Get credit consumption history grouped by month

Get credit consumption history grouped by month.

HTTPiePythonTypeScriptPath ParametersQuery ParametersResponses

http \
  GET \
  https://api.example.com/api/customer-credits/a1b2c3d4-e5f6-7890-abcd-ef1234567890/consumptions/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.customer_credit_o_enum import CustomerCreditOEnum # (1)
from waldur_api_client.api.customer_credits import customer_credits_consumptions_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = customer_credits_consumptions_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)

1. Model Source: CustomerCreditOEnum
2. API Source: customer_credits_consumptions_list

import { customerCreditsConsumptionsList } from 'waldur-js-client';

try {
  const response = await customerCreditsConsumptionsList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

Name	Type	Required
uuid	string (uuid)	✓

Name	Type	Description
customer_name	string
customer_slug	string
customer_uuid	string (uuid)
o	array	Ordering
page	integer	A page number within the paginated result set.
page_size	integer	Number of results to return per page.
query	string

200 -

The response body is an array of objects, where each object has the following structure:

Field	Type
date	string (date)
price	string (decimal)

---

Adjust withdrawable

Staff adjustment of the withdrawable part of the credit. Records a signed ledger entry with a comment and changes the credit value by the same amount.

HTTPiePythonTypeScriptPath ParametersRequest Body (required)Responses

http \
  POST \
  https://api.example.com/api/customer-credits/a1b2c3d4-e5f6-7890-abcd-ef1234567890/adjust_withdrawable/ \
  Authorization:"Token YOUR_API_TOKEN" \
  amount="12.34" \
  comment="string-value"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.withdrawable_adjustment_request import WithdrawableAdjustmentRequest # (1)
from waldur_api_client.api.customer_credits import customer_credits_adjust_withdrawable # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = WithdrawableAdjustmentRequest(
    amount="12.34",
    comment="string-value"
)
response = customer_credits_adjust_withdrawable.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)

1. Model Source: WithdrawableAdjustmentRequest
2. API Source: customer_credits_adjust_withdrawable

import { customerCreditsAdjustWithdrawable } from 'waldur-js-client';

try {
  const response = await customerCreditsAdjustWithdrawable({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "amount": "12.34",
    "comment": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

Name	Type	Required
uuid	string (uuid)	✓

Field	Type	Required
amount	string (decimal)	✓
comment	string	✓

200 -

Field	Type	Description
uuid	string (uuid)
url	string (uri)
value	string (decimal)
customer	string (uri)
customer_name	string
customer_uuid	string (uuid)
customer_slug	string
offerings	array of objects
offerings.uuid	string (uuid)
offerings.url	string (uri)
offerings.type	string
offerings.name	string
end_date	string (date)
expected_consumption	string (decimal)
minimal_consumption	number (double)
minimal_consumption_logic	string	Enum: fixed, linear
grace_coefficient	string (decimal)
apply_as_minimal_consumption	boolean
allocated_to_projects	number (double)
consumption_last_month	number (double)
withdrawable_balance	number (double)	Part of the credit that may leave the platform via payouts or transfers: earnings-typed ledger inflows minus outflows, capped by the current credit value so that staff-granted (promotional) credit is never withdrawable and credit expiry wipes earnings too.

---

Apply compensations

HTTPiePythonTypeScriptPath ParametersResponses

http \
  POST \
  https://api.example.com/api/customer-credits/a1b2c3d4-e5f6-7890-abcd-ef1234567890/apply_compensations/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.customer_credits import customer_credits_apply_compensations # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = customer_credits_apply_compensations.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)

1. API Source: customer_credits_apply_compensations

import { customerCreditsApplyCompensations } from 'waldur-js-client';

try {
  const response = await customerCreditsApplyCompensations({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

Name	Type	Required
uuid	string (uuid)	✓

200 - No response body

---

Clear compensations

HTTPiePythonTypeScriptPath ParametersResponses

http \
  POST \
  https://api.example.com/api/customer-credits/a1b2c3d4-e5f6-7890-abcd-ef1234567890/clear_compensations/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.customer_credits import customer_credits_clear_compensations # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = customer_credits_clear_compensations.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)

1. API Source: customer_credits_clear_compensations

import { customerCreditsClearCompensations } from 'waldur-js-client';

try {
  const response = await customerCreditsClearCompensations({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

Name	Type	Required
uuid	string (uuid)	✓

200 - No response body

---