Interface RecurringIntentInput

interface RecurringIntentInput {
    amount?: number;
    create?: "auto" | "manual";
    interval?: SubscriptionInterval;
    intervalCount?: number;
    intervalUnit?: SubscriptionIntervalUnit;
    plan: string;
    planName?: string;
    totalPayments?: number;
    trialDays?: number;
}

Index

Properties

amount? create? interval? intervalCount? intervalUnit? plan planName? totalPayments? trialDays?

Properties

`Optional`amount

amount?: number

`Optional`create

create?: "auto" | "manual"

`Optional`interval

interval?: SubscriptionInterval

A named interval. Or send intervalUnit + intervalCount for any cadence from 1 hour to 1 year.

`Optional`intervalCount

intervalCount?: number

`Optional`intervalUnit

intervalUnit?: SubscriptionIntervalUnit

plan

plan: string

`Optional`planName

planName?: string

`Optional`totalPayments

totalPayments?: number

Makes the subscription an installment plan of exactly this many payments (2–60). Not combinable with trialDays.

`Optional`trialDays

trialDays?: number