Skip to main content
Do you like Artifex? Give it a ⭐ star on GitHub!

Get promotional credits

Warning

This method is only available to users who have signed up on the Tanaos platform and generated an API Key. If you are using Synthex without an API Key, this method will return an authentication error.

Retrieves the current credits balance of the user whose API key is used to authenticate the request.

Arguments


No parameters.

Response


  • amount
    int

    The amount of credits you have in your account, expressed in the smallest currency unit. For example, amount: 125 and currency: "USD" means you have $1.25 in your account.
  • currency
    str

    Code of the currency that the credits are in.
from synthex import Synthex

client = Synthex()
client.credits.promotional()
{
"amount": 125,
"currency": "USD"
}