Retention

Price an extension of hosted evidence retention

Prices keeping the hosted evidence of the chosen audits (every hosted artifact of each) and artifacts for months whole months past each one's current deadline. New audits are promised the standard retention (30 days in the draft catalogue); an extension is how evidence stays hosted longer. The quantity is in the audit.retention_extension meter's unit: the selection's bytes rounded up to that unit's share of a decimal gigabyte, times the months, never below ten GB-months. amount is the fixed price of that quantity at the organisation's position this month, exact and before tax, charged on the month's invoice through the billing account. A quote can be bought until expires_at (about fifteen minutes), in the month and at the catalogue version it was made in; it moves nothing and charges nothing by itself, and nothing ever renews. Expired (deleted) evidence cannot be extended. An extension that would take the storage held under extended retention past the deployment's capacity is refused, paid or not. Needs audit.read: a quote is a price, not a purchase.

post/v1/retention/quotes

Request

  • Base URL: https://api.ironfang.com/audit
  • URL: https://api.ironfang.com/audit/v1/retention/quotes
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Request body

artifact_idsstring[]
audit_idsstring[]
monthsinteger required

Whole months of extra retention past each current deadline.

Response

The quote, with each artifact's deadline before and after.

amountstring required

The fixed price, exact, before tax, in pounds.

amount_minorinteger required

The price rounded to pence.

artifactsinteger required
audit_idsstring[] required
bytesinteger required

Hosted bytes the quote covers.

catalogue_versionstring required
created_atstring date-time required
currency'GBP' required
expires_atstring date-time required

The quote can be bought until then.

idstring uuid required
meter'audit.retention_extension' required
monthsinteger required
prices_exclude_taxtrue required
purchased_atstring date-time
quantityinteger required

In the meter's unit (unit): the bytes rounded up to the unit's share of a decimal gigabyte, times months, at least ten GB-months.

status'open' | 'expired' | 'purchased' required
unitstring required

The meter's unit, for example 0.1 GB-month.

Changes

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