`ISubscriptionChangeTariffRequest`

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

ISubscriptionChangeTariffRequest

Fields sent to move a subscription to another plan.

src/lib/interfaces/orionplace/subscribes/ISubscriptionApi.ts

TypeScript

export interface ISubscriptionChangeTariffRequest {
  // Customer subscription ID from `subscriptions_get`. A current period and an
  // active paid period are required.
  existed_subscription: number;
  // Plan ID to move to. It belongs to the same subscription as the current
  // plan, is sold on this storefront and differs from the plan in use.
  new_tariff: number;
  // Tariff-cost ID of the period to buy, belonging to `new_tariff`. A period of
  // zero days is not accepted for a change.
  period: number;
  // Service option ID for the new plan. Without it the option of the current
  // period is used, which the new plan has to sell as well.
  option?: number;
  // Tariff-cost ID saved as the automatic renewal after the change, from the
  // same plan. Omission leaves automatic renewal off; sending it also clears
  // `cancelled_date`.
  renew_period?: number;
  // Promo code applied to the new period, at most 20 characters.
  attach_issue?: string;
}