PATCH
Update a digital product's fulfilment terms

Authorizations

Authorization
string
header
required

A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.

Headers

Idempotency-Key
string
required

A unique key per logical write. Replaying a request with the same key returns the first response byte for byte instead of applying the write twice.

Path Parameters

configId
string
required

Body

application/json

An omitted field is left unchanged, and the merged result is revalidated, so switching to fulfillment_type file without a file_object_key is refused rather than producing a product with nothing behind it. The variant, the reveal mode, the default expiry and the subscription mode are NOT settable: each would change the terms of entitlements already granted, and none is reversible from the buyer's side.

fulfillment_type
enum<string>
Available options:
file,
license_key,
subscription
file_object_key
string
write-only

Must be in this store's namespace. WRITE-ONLY and never returned on a read, so a patch that repoints a paid download cannot be confirmed through this API: keep your own record of what you sent.

max_downloads
integer
subscription_period_days
integer

Response

Success

data
object