Billing

Get current billing period usage

get/api/v1/billing/usage

Request

  • Base URL: https://api.korala.ai
  • URL: https://api.korala.ai/api/v1/billing/usage
  • Auth: one of:
    • API key in header X-API-Key
    • bearer (a scheme the document does not define)

Response

signingCountnumber required

Document signings used this period

signingLimitnumber nullable

Signing limit (null = unlimited)

signingRemainingnumber nullable

Signings remaining (null = unlimited)

fillCountnumber required

Template fills used this period

fillLimitnumber nullable

Fill limit (null = unlimited)

fillRemainingnumber nullable

Fills remaining (null = unlimited)

periodStartstring date-time required

Current billing period start

periodEndstring date-time required

Current billing period end

planType'api_sandbox' | 'api_payg' | 'api_startup' | 'api_scale' | 'web_free' | 'web_pro' | 'web_business' | 'web_enterprise' required

Current plan type

planNamestring required

Current plan display name

signingOverageCentsnumber required

Signing overage charges this period (cents)

fillOverageCentsnumber required

Fill overage charges this period (cents)

Changes

No recorded changes to this operation across all 1 revision of this API.