Update a coverage product

Authorization

AuthorizationBearer <token>

Present an API key (sb_live_… / sb_test_…), an OAuth2 access token, or a static token as a Bearer credential. The operator is implied by the credential; it is never in the path. Only a SHA-256 hash of an API key is stored server-side.

In: header

Path Parameters

id*string

UUIDv7 identifier of the resource.

Formatuuid

Header Parameters

Idempotency-Key?string

A unique key that makes this mutation safe to retry. Repeats replay the stored response; reuse with a different body returns 409 idempotency_conflict.

Lengthlength <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

All fields optional; only supplied fields are changed. An explicit null clears regulatory_basis_ref, rate_per_thousand_minor, min_cover_minor, max_cover_minor, rounding_step or insurer_name; the price is checked as it will be stored, merged onto the product. Once customers have a product, its type is fixed, and an insurance product keeps its regulatory_basis_ref and insurer_name while their cover is live (409 cover_in_force). Its prices may change: cover already on a customer's plan keeps its own amount each period.

site_id?|

Formatuuid

name?string

A waiver's name may not say insurance — read as it prints, so a soft hyphen or a zero-width space inside the word still says it: 422 on name, "A waiver can't be called insurance." Judged on the name and type the product will have, so a rename and a retype to a waiver are both refused.

type?string

Value in

"contractual_liability_waiver"
"insurance"

declared_value_minor?integer

A fixed level's cover ceiling (the most goods it covers), minor units. Unused for per_thousand. NOT NULL in the database.

Formatint64

premium_minor?integer

A fixed level's premium, its tax included, per the operator's billing cycle (ADR 0031), minor units. Unused for per_thousand. NOT NULL in the database.

Formatint64

currency?string

ISO-4217 currency of the money fields on this resource.

Length3 <= length <= 3

billing_cycle?"monthly"

monthly only: a fixed level's premium_minor is billed each period, per the operator's billing cycle (ADR 0031). weekly, annual and one_off are refused (422): nothing bills a premium per week or per year, and the website checkout sells no cover once.

Value in

"monthly"

vat_treatment?string

Value in

"standard_20"
"exempt"
"outside_scope"
"zero"

ipt_bps?integer

Informational: insurance=1200, waiver=0. The insurance premium tax billed is the operator's IPT rate in force on the day the premium is invoiced (their tax rates), never this figure.

regulatory_basis_ref?|

An insurance product's regulatory basis (FCA authorisation / AR / exemption): 1–200 printable characters, stored trimmed. With insurer_name, required before an insurance product is active (422 insurance_regulatory_basis_missing).

Lengthlength <= 200

pricing_mode?string

How the premium is worked out. fixed: premium_minor for goods up to declared_value_minor, per the operator's billing cycle like every catalogue price (ADR 0031) — billing_cycle does not set how often it is charged. per_thousand: rate_per_thousand_minor a month for each £1,000 of the customer's goods, between min_cover_minor and max_cover_minor, rounded by rounding_step; premium_minor and declared_value_minor are unused. Checkout sells a fixed level only.

Value in

"fixed"
"per_thousand"

rate_per_thousand_minor?|

A per_thousand product's premium a month for each £1,000 of goods, minor units, its tax included: above 0 and at most 100000 (£1,000.00 for each £1,000). Null for fixed.

Formatint64

Range1 <= value <= 100000

min_cover_minor?|

The least goods value a per_thousand product covers, minor units. Null for fixed, or no least.

Formatint64

max_cover_minor?|

The most goods value a per_thousand product covers, minor units. Null for fixed, or no most.

Formatint64

rounding_step?|

How a per_thousand product prices goods between two thousands: per_thousand_or_part charges each £1,000 or part of one, exact charges the exact share. Null for fixed.

Value in

"per_thousand_or_part"
"exact"
null

insurer_name?|

An insurance product's insurer. A waiver has none.

Lengthlength <= 120

is_active?boolean

Response Body

`application/json`

curl -X PATCH "https://example.com/coverage-products/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'

{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "object": "coverage_product",    "site_id": "72771e6a-6f5e-4de4-a5b9-1266c4197811",    "name": "string",    "type": "contractual_liability_waiver",    "declared_value_minor": 0,    "premium_minor": 0,    "currency": "str",    "billing_cycle": "monthly",    "vat_treatment": "standard_20",    "ipt_bps": 0,    "regulatory_basis_ref": "string",    "pricing_mode": "fixed",    "rate_per_thousand_minor": 1,    "min_cover_minor": 0,    "max_cover_minor": 0,    "rounding_step": "per_thousand_or_part",    "insurer_name": "string",    "is_active": true,    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z"  }}

{  "error": {    "code": "unauthorized",    "message": "Missing or invalid credential."  }}

{  "error": {    "code": "insufficient_scope",    "message": "The credential lacks a scope required by this endpoint."  }}

{  "error": {    "code": "not_found",    "message": "Resource not found."  }}

{  "error": {    "code": "cover_in_force",    "message": "Customers have this plan. Make a new one instead."  }}

{  "error": {    "code": "validation_error",    "message": "One or more fields are invalid.",    "details": [      {        "field": "email",        "issue": "must be a valid email address"      }    ]  }}

{  "error": {    "code": "rate_limited",    "message": "Rate limit exceeded. Retry after 7s."  }}

{  "error": {    "code": "validation_error",    "message": "string",    "details": [      {        "field": "string",        "issue": "string"      }    ]  }}

Authorization

Path Parameters

Header Parameters

Request Body

Response Body

200application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

defaultapplication/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`