basalt / subscriptions/src / SwapInput

Interface: SwapInput

Defined in: subscriptions/src/gateway.ts:167

Input for changing a subscription's plan mid-cycle with proration.

Properties

period

> period: BillingPeriod

Defined in: subscriptions/src/gateway.ts:169

---

plan

> plan: string

Defined in: subscriptions/src/gateway.ts:168

---

prorationBehavior?

> optional prorationBehavior?: "none" | "create_prorations" | "always_invoice"

Defined in: subscriptions/src/gateway.ts:171

How the gateway settles the mid-cycle difference. Default create_prorations.