`ISubscriptionRenewRequest`

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

ISubscriptionRenewRequest

Additional paid-period request.

interfaces/orionplace/subscribes/ISubscriptionApi.ts

TypeScript

export interface ISubscriptionRenewRequest {
  // Customer subscription ID from `subscriptions_get`. A current period is
  // required.
  paid_subscription: number;
  // Price ID for the additional period of the current tariff.
  period_to_add: number;
  // Tariff-price ID for automatic renewal. Omission disables renewal.
  renew_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;
}