Skip to main content
GET
Get paid registry storage

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

authorization
string | null
x-ankra-organisation-id
string | null

Response

Successful Response

The organisation's paid registry storage: blocks it holds on top of its base limit, what they cost, and whether more can be bought.

available
boolean
required

false when storage cannot be bought at all: sales are paused, the base limit is already no limit, or the organisation is on no paid plan. Reducing is always possible.

unavailable_reason
string | null
required

Why available is false, in plain words.

block_gib
integer
required

The size of one block in GiB.

price_cents_per_block_month
integer
required

What one block costs this organisation per month, in cents of currency: the price it holds its blocks at, or the platform price when it holds none.

currency
string
required

Always eur: every invoice is euro-denominated.

max_blocks
integer
required

The most blocks an organisation may buy itself; for more, request more storage.

blocks
integer
required

The blocks held now.

base_limit_bytes
integer
required

The limit before blocks; -1 is no limit.

effective_limit_bytes
integer
required

base_limit_bytes + blocks x block_gib GiB: the limit every registry project carries; -1 is no limit.

monthly_cents
integer
required

What the blocks held now cost per month.

scheduled_price_cents_per_block_month
integer | null
required

A staff price change that reaches the blocks held at scheduled_price_from (the next calendar month); null when none.

scheduled_price_from
string<date-time>
required
billing_ready
boolean | null
required

true when billing can pay for more blocks, false when it cannot (billing_blocker says why), null when billing could not be checked (billing_blocker says so).

billing_blocker
string | null
required

A plain sentence for the Billing page link: no paid plan, no payment method, an overdue invoice, or that billing could not be checked.

updated_by
string | null
required
updated_at
string<date-time>
required
version
string
required

Opaque version of the stored add-on and its price. Send it back as expected_version.