Retrieve the billing position
A credits organization's balance, credits held for work in progress, what it has spent this calendar month and what a report and an interview cost on its versions. A quota organization's monthly allowance, how much is used and when it resets. Read only: credits are bought in the app, never through the API. To list what happened, see GET /v1/organization/credit-transactions.
Required scope: organization:read (organization:write also works).
Errors
- 401:
authentication_required,invalid_api_key - 403:
api_access_disabled,insufficient_scope - 429:
rate_limit_exceeded - 500:
api_error - 503:
service_unavailable
ApiKeyAuthorizationBearer <probb_live_<id>_<secret>>Success.
application/json- response
object*stringbillingMode*stringcredits organisations pay per report and interview. quota organisations have a monthly allowance.
"credits""quota"credits*|Set when billingMode is credits, otherwise null.
quota*|Set when billingMode is quota, otherwise null.
rates*array<>What one report and one interview cost on the versions assigned to the organization. Empty for quota organizations.
# Set PROBB_URL and PROBB_API_KEY. Replace any *_VALUE placeholder and any example ID (such as job_example) with a real one.curl --fail-with-body -X GET "$PROBB_URL/api/v1/organization/billing" \ -H "Authorization: Bearer $PROBB_API_KEY"{ "object": "billing", "billingMode": "credits", "credits": { "balance": 0, "reserved": 0, "spentThisMonth": { "periodStart": "2019-08-24T14:15:22Z", "total": 0, "reports": 0, "interviews": 0 } }, "quota": { "periodStart": "2019-08-24T14:15:22Z", "periodEnd": "2019-08-24T14:15:22Z", "reports": { "limit": 0, "used": 0, "remaining": 0 }, "interviews": { "limit": 0, "used": 0, "remaining": 0 } }, "rates": [ { "product": "report", "versionId": "string", "label": "string", "credits": 0 } ]}