Mayson Monorepo Documentation
    Preparing search index...

    Interface SubscriptionScheduleCancelParams

    interface SubscriptionScheduleCancelParams {
        expand?: string[];
        invoice_now?: boolean;
        prorate?: boolean;
    }
    Index

    Properties

    expand?: string[]

    Specifies which fields in the response should be expanded.

    invoice_now?: boolean

    If the subscription schedule is active, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Defaults to true.

    prorate?: boolean

    If the subscription schedule is active, indicates if the cancellation should be prorated. Defaults to true.