Interface SubscriptionCancelParams

interface SubscriptionCancelParams {
    cancellation_details?: Stripe.SubscriptionCancelParams.CancellationDetails;
    expand?: string[];
    invoice_now?: boolean;
    prorate?: boolean;
}

Properties

Details about why this subscription was cancelled

expand?: string[]

Specifies which fields in the response should be expanded.

invoice_now?: boolean

Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items. Defaults to false.

prorate?: boolean

Will generate a proration invoice item that credits remaining unused time until the subscription period end. Defaults to false.