Retention

Buy a retention quote

Buys a quote exactly as quoted, in one step: the quoted quantity of audit.retention_extension is admitted by the billing account, every quoted deadline moves to its quoted date, and the usage is committed - all of it or none. Needs billing.manage from a signed-in person with a verified email address: API keys and connected apps are refused (insufficient_scope, person_required), as for every billing change. A refusal from the billing account (paid usage not enabled, a budget reached) is the shared billing answer. A quote past its expires_at, made in another month or at another catalogue version, that the account's position would now price differently, or whose evidence has changed since (deleted, or its deadline moved) is quote_expired: ask for a new quote. Buying a quote that is already bought returns it with 200 and charges nothing more.

post/v1/retention/purchases

Request

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

Request body

quote_idstring uuid required

Response

Already bought; the quote as it was bought.

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.