Skip to content

Idempotency helpers

Pass caller-owned idempotency values only to Admin operations that declare the header.

Updated View as Markdown
Audience: application-backendPlane: adminAuth: management-keyStatus: beta

The SDK deliberately does not generate keys or decide which commands are retryable. The accepted OpenAPI operation determines whether Idempotency-Key is required.

import { idempotencyKey } from '@nexus/sdk-typescript';

const options = idempotencyKey('checkout:access-123:attempt-1');

idempotencyKey(value) returns an AdminRequestOptions fragment. Reuse a value only when repeating the same logical command with the same intended inputs; use a new value for a new command.

Generated operation pages show the header explicitly whenever the OpenAPI contract requires it. The current contract requires it for hosted Checkout creation and billing-period synchronization.

Navigation

Type to search…

↑↓ navigate↵ selectEsc close