`ISubscriptionCreateRequest`

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

ISubscriptionCreateRequest

New subscription request.

interfaces/orionplace/subscribes/ISubscriptionApi.ts

TypeScript

export interface ISubscriptionCreateRequest {
  // Tariff ID from `subscriptions_guest_search`.
  tariff: number;
  // Option ID attached to this tariff. Required for a subscription with a
  // plugin; the option must have free capacity and, for a trial, permit trials.
  option?: number;
  // Price ID for the selected tariff. Omit for a trial.
  period?: number;
  // Optional promo-code text, up to 20 characters. It must support the tariff
  // and a paid period; a promo code cannot be attached to a trial.
  attach_issue?: string;
}