credits
Credit-ledger enums.
Credits are an org-level append-only ledger. Each entry belongs to a bucket and carries a reason. String enums whose values match the API/JSON wire form.
CreditBucket
¶
Bases: str, Enum
Which balance a credit entry moves.
grants: credits granted for research analyses. Every entry in it names the grant it belongs to; a grant may expire.purchased: credits bought. They pay for commercial analyses and for storage above an organization's free ceiling, and never expire.allowanceandpayg: retired balances (a recurring allowance and a balance mixing welcome, administrator and purchased credits). Kept so past entries still read; nothing is entered in them any more.
Grants never pay for commercial analyses or storage, and purchased credits never pay for research analyses.
CreditReason
¶
Bases: str, Enum
Why a credit ledger entry was created.
CreditRequestDeclineReason
¶
Bases: str, Enum
Why a grant or extension request was declined, in words the requester is sent.
A fixed list for the same reasons account requests use one: something is better than nothing, a hurried reason sent to a named person reads as a statement about them, and consistency cannot be kept by hand. The split that matters is whether a fresh request could succeed.
AMOUNT_NOT_SUPPORTED = 'amount_not_supported'
class-attribute
instance-attribute
¶
The amount asked for is more than the plan supports. Fixable.
NOT_RESEARCH = 'not_research'
class-attribute
instance-attribute
¶
The work described is not non-commercial research.
NO_CAPACITY = 'no_capacity'
class-attribute
instance-attribute
¶
The platform cannot grant more credits at present.
PLAN_UNCLEAR = 'plan_unclear'
class-attribute
instance-attribute
¶
The plan did not say enough to judge the amount. Fixable.
is_fixable
property
¶
Whether a fresh request could succeed.
CreditRequestKind
¶
Bases: str, Enum
What an organization asks for.
CreditRequestStatus
¶
Bases: str, Enum
Where a request stands. Pending until an administrator decides.
GrantOrigin
¶
Bases: str, Enum
How a grant came about.
SpendClass
¶
Bases: str, Enum
Which balance pays for an analysis, decided by the analysis's licence.
An analysis offered under a non-commercial licence is a research analysis and is paid from grants; one offered under the commercial licence is paid from purchased credits. Decided once when the analysis is submitted.