Skip to main content

@dialstack/sdk / index / Tos

Interface: Tos

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

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​

acceptance: TosAcceptance | null;

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

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

body?​

optional body?: string;

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

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​

content: string;

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

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

pricing?​

optional pricing?: AccountPricing | null;

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

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

url​

url: string;

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

Canonical URL of the full agreement.

version​

version: string;

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

The current agreement version.