Skip to main content

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

Interface: Tos

Defined in: sdk/server/src/index.ts:496

The account's subscription-agreement resource: the agreement currently in effect plus the account's acceptance state.

Properties​

acceptance​

TypeScript
acceptance: TosAcceptance | null;

Defined in: sdk/server/src/index.ts:513

The current acceptance, or null if the account has not accepted.


body​

TypeScript
body: string;

Defined in: sdk/server/src/index.ts:511

Full agreement text (HTML) to render as the body.


content​

TypeScript
content: string;

Defined in: sdk/server/src/index.ts:509

Short affirmation the customer ticks to accept — the clickwrap checkbox label, including the 911/E911 acknowledgement.


pricing?​

TypeScript
pricing?: AccountPricing | null;

Defined in: sdk/server/src/index.ts:524

The account's agreed pricing. Present only when expand: ['pricing'] is requested; null when pricing has not been set.


service_setup_fee​

TypeScript
service_setup_fee: number;

Defined in: sdk/server/src/index.ts:519

The one-time service set-up fee, in cents: the fee the account was shown when it accepted, otherwise the fee for an account accepting now. The agreement points to this amount rather than stating one, so show it with the agreement.


url​

TypeScript
url: string;

Defined in: sdk/server/src/index.ts:504

Canonical URL of the full agreement.


version​

TypeScript
version: string;

Defined in: sdk/server/src/index.ts:502

Version of the agreement in effect (date-based YYYY-MM-DD, which is also its effective date). Echo it back when accepting so the server can reject acceptance of stale text.