@vercel/sdk
Version:
<p align="center"> <a href="https://vercel.com"> <img src="https://assets.vercel.com/image/upload/v1588805858/repositories/vercel/logo.png" height="96"> <h3 align="center">Vercel</h3> </a> <p align="center">Develop. Preview. Ship.</p> </p>
204 lines • 6.04 kB
TypeScript
import * as z from "zod/v3";
import { ClosedEnum } from "../types/enums.js";
import { Result as SafeParseResult } from "../types/fp.js";
import { SDKValidationError } from "./sdkvalidationerror.js";
export type GetInvoiceRequest = {
integrationConfigurationId: string;
invoiceId: string;
};
/**
* Invoice state.
*/
export declare const GetInvoiceState: {
readonly Draft: "draft";
readonly Invoiced: "invoiced";
readonly Notpaid: "notpaid";
readonly Overdue: "overdue";
readonly Paid: "paid";
readonly Pending: "pending";
readonly RefundRequested: "refund_requested";
readonly Refunded: "refunded";
readonly Scheduled: "scheduled";
};
/**
* Invoice state.
*/
export type GetInvoiceState = ClosedEnum<typeof GetInvoiceState>;
/**
* Subscription period for this billing cycle. ISO 8601 timestamps.
*/
export type GetInvoicePeriod = {
start: string;
end: string;
};
/**
* Invoice items.
*/
export type GetInvoiceItems = {
/**
* Partner's billing plan ID.
*/
billingPlanId: string;
/**
* Partner's resource ID. If not specified, indicates installation-wide item.
*/
resourceId?: string | undefined;
/**
* Start and end are only needed if different from the period's start/end. ISO 8601 timestamp.
*/
start?: string | undefined;
/**
* Start and end are only needed if different from the period's start/end. ISO 8601 timestamp.
*/
end?: string | undefined;
/**
* Invoice item name.
*/
name: string;
/**
* Additional item details.
*/
details?: string | undefined;
/**
* Item price. A dollar-based decimal string.
*/
price: string;
/**
* Item quantity.
*/
quantity: number;
/**
* Units for item's quantity.
*/
units: string;
/**
* Item total. A dollar-based decimal string.
*/
total: string;
};
/**
* Invoice discounts.
*/
export type GetInvoiceDiscounts = {
/**
* Partner's billing plan ID.
*/
billingPlanId: string;
/**
* Partner's resource ID. If not specified, indicates installation-wide discount.
*/
resourceId?: string | undefined;
/**
* Start and end are only needed if different from the period's start/end. ISO 8601 timestamp.
*/
start?: string | undefined;
/**
* Start and end are only needed if different from the period's start/end. ISO 8601 timestamp.
*/
end?: string | undefined;
/**
* Discount name.
*/
name: string;
/**
* Additional discount details.
*/
details?: string | undefined;
/**
* Discount amount. A dollar-based decimal string.
*/
amount: string;
};
export type GetInvoiceResponseBody = {
/**
* Whether the invoice is in the testmode (no real transaction created).
*/
test?: boolean | undefined;
/**
* Vercel Marketplace Invoice ID.
*/
invoiceId: string;
/**
* Partner-supplied Invoice ID, if applicable.
*/
externalId?: string | undefined;
/**
* Invoice state.
*/
state: GetInvoiceState;
/**
* User-readable invoice number.
*/
invoiceNumber?: string | undefined;
/**
* Invoice date. ISO 8601 timestamp.
*/
invoiceDate: string;
/**
* Subscription period for this billing cycle. ISO 8601 timestamps.
*/
period: GetInvoicePeriod;
/**
* Moment the invoice was paid. ISO 8601 timestamp.
*/
paidAt?: string | undefined;
/**
* Most recent moment the invoice was refunded. ISO 8601 timestamp.
*/
refundedAt?: string | undefined;
/**
* Additional memo for the invoice.
*/
memo?: string | undefined;
/**
* Invoice items.
*/
items: Array<GetInvoiceItems>;
/**
* Invoice discounts.
*/
discounts?: Array<GetInvoiceDiscounts> | undefined;
/**
* Invoice total amount. A dollar-based decimal string.
*/
total: string;
/**
* The reason for refund. Only applicable for states "refunded" or "refund_request".
*/
refundReason?: string | undefined;
/**
* Refund amount. Only applicable for states "refunded" or "refund_request". A dollar-based decimal string.
*/
refundTotal?: string | undefined;
/**
* System creation date. ISO 8601 timestamp.
*/
created: string;
/**
* System update date. ISO 8601 timestamp.
*/
updated: string;
};
/** @internal */
export type GetInvoiceRequest$Outbound = {
integrationConfigurationId: string;
invoiceId: string;
};
/** @internal */
export declare const GetInvoiceRequest$outboundSchema: z.ZodType<GetInvoiceRequest$Outbound, z.ZodTypeDef, GetInvoiceRequest>;
export declare function getInvoiceRequestToJSON(getInvoiceRequest: GetInvoiceRequest): string;
/** @internal */
export declare const GetInvoiceState$inboundSchema: z.ZodNativeEnum<typeof GetInvoiceState>;
/** @internal */
export declare const GetInvoicePeriod$inboundSchema: z.ZodType<GetInvoicePeriod, z.ZodTypeDef, unknown>;
export declare function getInvoicePeriodFromJSON(jsonString: string): SafeParseResult<GetInvoicePeriod, SDKValidationError>;
/** @internal */
export declare const GetInvoiceItems$inboundSchema: z.ZodType<GetInvoiceItems, z.ZodTypeDef, unknown>;
export declare function getInvoiceItemsFromJSON(jsonString: string): SafeParseResult<GetInvoiceItems, SDKValidationError>;
/** @internal */
export declare const GetInvoiceDiscounts$inboundSchema: z.ZodType<GetInvoiceDiscounts, z.ZodTypeDef, unknown>;
export declare function getInvoiceDiscountsFromJSON(jsonString: string): SafeParseResult<GetInvoiceDiscounts, SDKValidationError>;
/** @internal */
export declare const GetInvoiceResponseBody$inboundSchema: z.ZodType<GetInvoiceResponseBody, z.ZodTypeDef, unknown>;
export declare function getInvoiceResponseBodyFromJSON(jsonString: string): SafeParseResult<GetInvoiceResponseBody, SDKValidationError>;
//# sourceMappingURL=getinvoiceop.d.ts.map