Application Load

ISubscribe

The physical TypeScript declaration from the Nuxt starter, with linked types and field comments.

ISubscribe

Subscription offering and its availability settings.

app/interfaces/orionplace/subscribes/ISubscribe.ts
TypeScript
export interface ISubscribe {
	// Value of id.
	id: number;
	// Value of locale.
	locale: Record<string, ISubscribeLocale>;
	// Value of is_new_subs_allowed.
	is_new_subs_allowed: boolean;
	// Value of only_admin_can_subscribe.
	only_admin_can_subscribe: boolean;
	// Labels for keys used by the returned plan configuration or customer service
	// headings. For a custom parameter, translations[key].trans[localeCode]
	// supplies its name. Missing/blank names, or names equal to the raw key, leave
	// an unknown feature hidden. Built-in names use the client’s localized
	// reference.
	translations: Record<string, JsonValue>;
	// Service-defined customer heading configuration, which may be empty. It
	// describes presentation keys, not the purchased subscription’s current
	// values. Current customer data is returned separately in subscriptions_get →
	// data[].plugin.remote_subscription_data_user. The supplied generic plan
	// summary does not turn these headings into controls.
	user_data: Record<string, JsonValue>;
}