@getopenpay/client/models/DeleteSubscriptionRequest.d.ts

OpenPay API TypeScript SDK

/**
 * OpenPay API
 * super charge your subscription management.
 *
 * The version of the OpenAPI document: 1.2.1
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import type { SubscriptionCancellationDetails } from './SubscriptionCancellationDetails';
/**
 *
 * @export
 * @interface DeleteSubscriptionRequest
 */
export interface DeleteSubscriptionRequest {
    /**
     * Mark unpaid invoices as uncollectible
     * @type {boolean}
     * @memberof DeleteSubscriptionRequest
     */
    cancelUnpaidInvoices?: boolean;
    /**
     *
     * @type {SubscriptionCancellationDetails}
     * @memberof DeleteSubscriptionRequest
     */
    cancellationDetails?: SubscriptionCancellationDetails | null;
    /**
     * Flag to decide whether full refund should be given or not.
     * @type {boolean}
     * @memberof DeleteSubscriptionRequest
     */
    fullRefund?: boolean;
    /**
     * Whether the request is in preview mode (subscriptions won't actually be deleted)
     * @type {boolean}
     * @memberof DeleteSubscriptionRequest
     */
    isPreview?: boolean;
    /**
     * Will generate a proration invoice_item that credits remaining unused time until the subscription period end, also creates invoice_item for un-invoiced metered usage.Setting this to false will not invoice for un-invoiced metered usage.
     * @type {boolean}
     * @memberof DeleteSubscriptionRequest
     */
    prorate?: boolean;
}
/**
 * Check if a given object implements the DeleteSubscriptionRequest interface.
 */
export declare function instanceOfDeleteSubscriptionRequest(value: object): value is DeleteSubscriptionRequest;
export declare function DeleteSubscriptionRequestFromJSON(json: any): DeleteSubscriptionRequest;
export declare function DeleteSubscriptionRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): DeleteSubscriptionRequest;
export declare function DeleteSubscriptionRequestToJSON(json: any): DeleteSubscriptionRequest;
export declare function DeleteSubscriptionRequestToJSONTyped(value?: DeleteSubscriptionRequest | null, ignoreDiscriminator?: boolean): any;