Auth_api.PlanReservation.md

saasus-sdk / Auth/api / PlanReservation

Interface: PlanReservation

Auth/api.PlanReservation

Export

PlanReservation

Table of contents

Properties

• delete_usage
• next_plan_id
• next_plan_tax_rate_id
• proration_behavior
• using_next_plan_from

Properties

delete_usage

• Optional delete_usage: boolean

If you have a stripe linkage, you can set whether to delete pay-as-you-go items when changing plans. When you change plan, you can remove all pay-as-you-go items included in your current subscription to stop being billed based on pay-as-you-go items. The recorded usage is cleared immediately. Since it cannot be restored, please note that plan change reservations with delete_usage set to true cannot be canceled.

Memberof

PlanReservation

Defined in

src/generated/Auth/api.ts:1221

---

next_plan_id

• Optional next_plan_id: string

Memberof

PlanReservation

Defined in

src/generated/Auth/api.ts:1197

---

next_plan_tax_rate_id

• Optional next_plan_tax_rate_id: string

Memberof

PlanReservation

Defined in

src/generated/Auth/api.ts:1209

---

proration_behavior

• Optional proration_behavior: ProrationBehavior

Memberof

PlanReservation

Defined in

src/generated/Auth/api.ts:1215

---

using_next_plan_from

• Optional using_next_plan_from: number

Next billing plan start time (When using stripe, you can create a subscription that starts at the beginning of the current month by specifying 00:00 (UTC) at the beginning of the current month. Ex. 1672531200 for January 2023.)

Memberof

PlanReservation

Defined in

src/generated/Auth/api.ts:1203