Get the commitment
What is on offer and what is running: the agreement (terms, left
out while commitments are not offered), the commitment in force
(active, left out when there is none), when a commitment agreed
today would start (starts_on, the first day of next month), the
commitment and on-demand prices per EHU for the organization, what
ending the active commitment today would cost
(estimated_clawback_usd), and the last 24 commitments.
Requires the billing:usage:read scope.
Authorization
Responses
200
The commitment state.
dataCommitmentStateShow CommitmentState properties
termsCommitmentTermsShow CommitmentTerms properties
versionintegerbodystringThe full text of the agreement.body_sha256stringterm_monthsintegerpublished_atstring (date-time)
activeCommitmentShow Commitment properties
idintegerorg_idstringehu_per_monthnumberstarts_onstring (date-time)The first day of the first committed month.ends_onstring (date-time)The first day after the term (exclusive).statusstringterms_versionintegerterms_sha256stringThe hash of the agreement text that was accepted.accepted_atstring (date-time)accepted_bystringThe person, or the organization key, that accepted.accepted_ipstringterminated_atstring (date-time)terminated_fromstring (date-time)The first month no longer committed, for an ended commitment.terminated_bystringclawback_usdnumberThe early-termination charge.clawback_invoice_idstringclawback_invoice_urlstring (uri)clawback_invoice_pdf_urlstring (uri)clawback_invoiced_atstring (date-time)ending_notice_atstring (date-time)When the organization was told the term is nearly over.created_atstring (date-time)
starts_onstring (date-time)When a commitment agreed now would start.estimated_clawback_usdnumberWhat ending the active commitment today would cost; 0 without one.commitment_usd_per_ehunumberon_demand_usd_per_ehunumberhistoryarray of CommitmentThe last 24 commitments.Show Commitment properties
idintegerorg_idstringehu_per_monthnumberstarts_onstring (date-time)The first day of the first committed month.ends_onstring (date-time)The first day after the term (exclusive).statusstringterms_versionintegerterms_sha256stringThe hash of the agreement text that was accepted.accepted_atstring (date-time)accepted_bystringThe person, or the organization key, that accepted.accepted_ipstringterminated_atstring (date-time)terminated_fromstring (date-time)The first month no longer committed, for an ended commitment.terminated_bystringclawback_usdnumberThe early-termination charge.clawback_invoice_idstringclawback_invoice_urlstring (uri)clawback_invoice_pdf_urlstring (uri)clawback_invoiced_atstring (date-time)ending_notice_atstring (date-time)When the organization was told the term is nearly over.created_atstring (date-time)
401
No API key was sent, or it is unknown, revoked or expired (UNAUTHORIZED).
errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
403
The key lacks the scope this endpoint needs (FORBIDDEN).
errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
429
Too many requests (RATE_LIMITED). Wait for Retry-After seconds.
Retry-AfterintegerSeconds to wait before retrying.
errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
500
The commitment could not be loaded (COMMITMENT_UNAVAILABLE). Retry later.
errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
Example request
curl -X GET 'https://evohub.io/api/v1/billing/commitment' \
-H 'Authorization: Bearer <TOKEN>'
