cloudflare/resources/billing/unpaid-invoice.d.mts

The official TypeScript library for the Cloudflare API

import { APIResource } from "../../core/resource.mjs";
import { APIPromise } from "../../core/api-promise.mjs";
import { RequestOptions } from "../../internal/request-options.mjs";
export declare class BaseUnpaidInvoice extends APIResource {
    static readonly _key: readonly ['billing', 'unpaidInvoice'];
    /**
     * Gets unpaid invoice information for an account.
     *
     * @example
     * ```ts
     * const unpaidInvoice =
     *   await client.billing.unpaidInvoice.get({
     *     account_id: '023e105f4ecef8ad9ca31a8372d0c353',
     *   });
     * ```
     */
    get(params: UnpaidInvoiceGetParams, options?: RequestOptions): APIPromise<UnpaidInvoiceGetResponse>;
}
export declare class UnpaidInvoice extends BaseUnpaidInvoice {
}
export interface UnpaidInvoiceGetResponse {
    /**
     * List of unpaid invoices.
     */
    invoices?: Array<UnpaidInvoiceGetResponse.Invoice>;
}
export declare namespace UnpaidInvoiceGetResponse {
    interface Invoice {
        /**
         * Billing history item identifier.
         */
        id?: string;
        /**
         * The billing item action.
         */
        action?: string;
        /**
         * The amount associated with this billing item.
         */
        amount?: number;
        /**
         * The amount remaining to pay.
         */
        amount_to_pay?: number;
        /**
         * The currency of the billing item.
         */
        currency?: string;
        /**
         * The billing item description.
         */
        description?: string;
        /**
         * The external invoice identifier.
         */
        external_invoice_id?: string;
        /**
         * URL to the hosted invoice.
         */
        hosted_invoice_url?: string;
        /**
         * The associated invoice identifier.
         */
        invoice_id?: string;
        /**
         * When the billing event occurred.
         */
        occurred_at?: string;
        /**
         * The associated receipt identifier.
         */
        receipt_id?: string;
        /**
         * The source of the billing item.
         */
        source?: string;
        /**
         * The source invoice identifier.
         */
        source_invoice_id?: string;
        /**
         * The status of the billing item.
         */
        status?: string;
        /**
         * The billing item type.
         */
        type?: string;
    }
}
export interface UnpaidInvoiceGetParams {
    /**
     * Identifier
     */
    account_id: string;
}
export declare namespace UnpaidInvoice {
    export { type UnpaidInvoiceGetResponse as UnpaidInvoiceGetResponse, type UnpaidInvoiceGetParams as UnpaidInvoiceGetParams, };
}
//# sourceMappingURL=unpaid-invoice.d.mts.map