Skip to main content

@dialstack/sdk-dev / js/src / Tos

Interface: Tos

Defined in: sdk/js/src/types/account-onboarding.ts:177

The current subscription agreement plus this account's acceptance state. Returned by account.tos.retrieve(); pricing is only present when requested via expand: ['pricing'].

Properties

acceptance

TypeScript
acceptance: TosAcceptance | null;

Defined in: sdk/js/src/types/account-onboarding.ts:191

The latest acceptance for this account, or null if never accepted.


body?

TypeScript
optional body?: string;

Defined in: sdk/js/src/types/account-onboarding.ts:189

Full agreement text (HTML) to render as the agreement body. Optional: an older API during a mixed-version deploy may omit it, so consumers must handle its absence (the acceptance gate fails closed when it is missing).


content

TypeScript
content: string;

Defined in: sdk/js/src/types/account-onboarding.ts:183

The short affirmation to tick (the checkbox label, including the 911/E911 acknowledgement).


pricing?

TypeScript
optional pricing?: AccountPricing | null;

Defined in: sdk/js/src/types/account-onboarding.ts:193

Present only when expanded; null when the account's pricing is incomplete.


url

TypeScript
url: string;

Defined in: sdk/js/src/types/account-onboarding.ts:181

Canonical URL of the full agreement.


version

TypeScript
version: string;

Defined in: sdk/js/src/types/account-onboarding.ts:179

The current agreement version.