@burdenoff/sdk-libs 2026.501.6

package/dist/modules/billing/index.d.cts

@@ -0,0 +1,377 @@
+import { J as Json, S as SdkModule } from '../../module-JDbvil5h.cjs';
+import 'graphql-request';
+
+interface MoneyAmount {
+    amount: number;
+    currency: string;
+}
+type SubscriptionStatus = 'active' | 'canceled' | 'expired' | 'past_due' | 'trialing' | 'paused' | 'incomplete' | 'incomplete_expired' | 'upgraded' | 'downgraded' | 'completed';
+interface BillingSubscription {
+    id: string;
+    billingAccountId: string;
+    planId: string;
+    status: SubscriptionStatus;
+    startDate: string;
+    endDate: string;
+    recurrence: boolean;
+    autoRenewal?: boolean | null;
+    seatCount?: number | null;
+    lastSeatChangeAt?: string | null;
+    paymentGateway?: string | null;
+    canceledAt?: string | null;
+    cancellationReason?: string | null;
+    canceledBy?: string | null;
+    nextBillingDate?: string | null;
+    lastBillingDate?: string | null;
+    lastRenewalDate?: string | null;
+    context?: Json;
+    createdAt: string;
+    updatedAt: string;
+}
+interface PaginatedSubscriptions {
+    subscriptions: BillingSubscription[];
+    totalCount: number;
+    hasMore: boolean;
+    page: number;
+    pageSize: number;
+    totalPages: number;
+}
+interface UpdateSubscriptionSeatsInput {
+    subscriptionId: string;
+    seatCount: number;
+}
+interface Plan {
+    id: string;
+    name: string;
+    description?: string | null;
+    price?: number | null;
+    currency?: string | null;
+    duration?: string | null;
+    productId?: string | null;
+    isActive?: boolean | null;
+    features?: Json;
+    metadata?: Json;
+    createdAt?: string | null;
+    updatedAt?: string | null;
+}
+interface PlansFilter {
+    productId?: string;
+    isActive?: boolean;
+}
+interface Addon {
+    id: string;
+    name: string;
+    description?: string | null;
+    price?: number | null;
+    currency?: string | null;
+    productId?: string | null;
+    isActive?: boolean | null;
+    createdAt?: string | null;
+    updatedAt?: string | null;
+}
+interface AddonsFilter {
+    productId?: string;
+    isActive?: boolean;
+}
+interface CreateAddOnsInput {
+    name: string;
+    description?: string;
+    price?: number;
+    currency?: string;
+    productId?: string;
+}
+interface UpdateAddOnsInput {
+    id: string;
+    name?: string;
+    description?: string;
+    price?: number;
+    currency?: string;
+}
+type InvoiceStatus = 'draft' | 'open' | 'paid' | 'void' | 'uncollectible';
+interface Invoice {
+    id: string;
+    invoiceNumber?: string | null;
+    billingAccountId?: string | null;
+    status: InvoiceStatus;
+    amount?: number | null;
+    currency?: string | null;
+    dueDate?: string | null;
+    paidAt?: string | null;
+    pdfUrl?: string | null;
+    metadata?: Json;
+    createdAt?: string | null;
+    updatedAt?: string | null;
+}
+interface Coupon {
+    id: string;
+    code: string;
+    description?: string | null;
+    discountType?: string | null;
+    discountValue?: number | null;
+    currency?: string | null;
+    expiresAt?: string | null;
+    maxRedemptions?: number | null;
+    redemptions?: number | null;
+    isActive?: boolean | null;
+    createdAt?: string | null;
+    updatedAt?: string | null;
+}
+interface CouponFilterInput {
+    isActive?: boolean;
+    productId?: string;
+}
+interface CouponsListResponse {
+    coupons: Coupon[];
+    totalCount: number;
+}
+interface CreateCouponInput {
+    code: string;
+    description?: string;
+    discountType: string;
+    discountValue: number;
+    currency?: string;
+    expiresAt?: string;
+    maxRedemptions?: number;
+}
+interface UpdateCouponInput {
+    description?: string;
+    discountValue?: number;
+    expiresAt?: string;
+    maxRedemptions?: number;
+    isActive?: boolean;
+}
+interface RefundRecord {
+    id: string;
+    paymentId?: string | null;
+    invoiceId?: string | null;
+    amount?: number | null;
+    currency?: string | null;
+    status?: string | null;
+    reason?: string | null;
+    createdAt?: string | null;
+    updatedAt?: string | null;
+}
+interface PaginatedRefundRecords {
+    records: RefundRecord[];
+    totalCount: number;
+    page: number;
+    pageSize: number;
+    totalPages: number;
+}
+interface RequestRefundInput {
+    paymentId?: string;
+    invoiceId?: string;
+    amount?: number;
+    reason?: string;
+}
+interface CreditTransaction {
+    id: string;
+    billingAccountId?: string | null;
+    amount: number;
+    type?: string | null;
+    reason?: string | null;
+    metadata?: Json;
+    createdAt?: string | null;
+}
+interface CreditBalanceByType {
+    total: number;
+    byType: Array<{
+        type: string;
+        balance: number;
+    }>;
+}
+interface SpendCreditsInput {
+    billingAccountId: string;
+    amount: number;
+    reason?: string;
+    metadata?: Json;
+}
+interface SpendCreditResponse {
+    success: boolean;
+    remainingBalance?: number | null;
+    transactionId?: string | null;
+    error?: string | null;
+}
+interface RequestCreditWithdrawalInput {
+    billingAccountId: string;
+    amount: number;
+    payoutAccountId?: string;
+}
+interface PayoutRequest {
+    id: string;
+    billingAccountId?: string | null;
+    amount: number;
+    status?: string | null;
+    createdAt?: string | null;
+}
+interface QuotaAssignment {
+    id: string;
+    subscriptionId?: string | null;
+    type?: string | null;
+    limit: number;
+    used?: number | null;
+    remaining?: number | null;
+    metadata?: Json;
+    createdAt?: string | null;
+    updatedAt?: string | null;
+}
+type AnalyticsPeriod = 'TODAY' | 'LAST_7_DAYS' | 'LAST_30_DAYS' | 'LAST_90_DAYS' | 'YEAR_TO_DATE';
+interface UsageDashboard {
+    period: AnalyticsPeriod;
+    totalEvents?: number | null;
+    byTag?: Json;
+    byResource?: Json;
+}
+interface PaymentMethod {
+    id: string;
+    billingAccountId?: string | null;
+    type?: string | null;
+    brand?: string | null;
+    last4?: string | null;
+    expiryMonth?: number | null;
+    expiryYear?: number | null;
+    isDefault?: boolean | null;
+    createdAt?: string | null;
+    updatedAt?: string | null;
+}
+interface CreatePaymentMethodInput {
+    billingAccountId: string;
+    type: string;
+    token?: string;
+    isDefault?: boolean;
+    metadata?: Json;
+}
+interface EarningsSummary {
+    billingAccountId: string;
+    totalEarned: number;
+    totalPaid: number;
+    pendingPayout: number;
+    currency?: string | null;
+}
+interface PayoutAccount {
+    id: string;
+    billingAccountId?: string | null;
+    type?: string | null;
+    isDefault?: boolean | null;
+    metadata?: Json;
+    createdAt?: string | null;
+}
+interface AddPayoutAccountInput {
+    billingAccountId: string;
+    type: string;
+    metadata?: Json;
+}
+interface RequestPayoutInput {
+    billingAccountId: string;
+    amount: number;
+    payoutAccountId?: string;
+    notes?: string;
+}
+interface GetCheckoutUrlOpts {
+    billingAccountId?: string;
+    returnUrl?: string;
+    cancelUrl?: string;
+    couponCode?: string;
+    seatCount?: number;
+}
+
+interface AddonsApi {
+    list(filter?: AddonsFilter, opts?: {
+        limit?: number;
+    }): Promise<Addon[]>;
+    get(id: string): Promise<Addon | null>;
+}
+
+interface AffiliateApi {
+    earnings(billingAccountId: string): Promise<EarningsSummary>;
+    payoutAccounts(billingAccountId: string): Promise<PayoutAccount[]>;
+    addPayoutAccount(input: AddPayoutAccountInput): Promise<PayoutAccount>;
+    requestPayout(input: RequestPayoutInput): Promise<PayoutRequest>;
+}
+
+interface CouponsApi {
+    list(filter?: CouponFilterInput): Promise<CouponsListResponse>;
+    get(code: string): Promise<Coupon | null>;
+    create(input: CreateCouponInput): Promise<Coupon>;
+    update(id: string, input: UpdateCouponInput): Promise<Coupon>;
+}
+
+interface CreditsApi {
+    balance(billingAccountId: string): Promise<CreditBalanceByType>;
+    spend(input: SpendCreditsInput): Promise<SpendCreditResponse>;
+    withdraw(input: RequestCreditWithdrawalInput): Promise<PayoutRequest>;
+}
+
+interface PaginatedInvoices {
+    invoices: Invoice[];
+    totalCount: number;
+    hasMore: boolean;
+}
+interface InvoicesApi {
+    list(billingAccountId: string, opts?: {
+        page?: number;
+        pageSize?: number;
+    }): Promise<PaginatedInvoices>;
+    get(id: string): Promise<Invoice | null>;
+}
+
+interface PaymentMethodsApi {
+    list(billingAccountId: string): Promise<PaymentMethod[]>;
+    add(input: CreatePaymentMethodInput): Promise<PaymentMethod>;
+    delete(id: string): Promise<{
+        success: boolean;
+    }>;
+}
+
+interface PlansApi {
+    list(filter?: PlansFilter): Promise<Plan[]>;
+    get(id: string): Promise<Plan | null>;
+}
+
+interface RefundsApi {
+    list(opts?: {
+        page?: number;
+        pageSize?: number;
+    }): Promise<PaginatedRefundRecords>;
+    request(input: RequestRefundInput): Promise<RefundRecord>;
+}
+
+interface SubscriptionsApi {
+    list(opts?: {
+        billingAccountId?: string;
+        page?: number;
+        pageSize?: number;
+    }): Promise<PaginatedSubscriptions>;
+    get(id: string): Promise<BillingSubscription | null>;
+    active(billingAccountId: string): Promise<BillingSubscription[]>;
+    updateSeats(input: UpdateSubscriptionSeatsInput): Promise<BillingSubscription>;
+    cancel(input: {
+        subscriptionId: string;
+        reason?: string;
+    }): Promise<BillingSubscription>;
+}
+
+interface UsageApi {
+    dashboard(period: AnalyticsPeriod): Promise<UsageDashboard>;
+}
+
+interface CheckoutUrl {
+    url: string;
+    sessionId: string;
+}
+interface BillingApi {
+    subscriptions: SubscriptionsApi;
+    plans: PlansApi;
+    addons: AddonsApi;
+    invoices: InvoicesApi;
+    coupons: CouponsApi;
+    refunds: RefundsApi;
+    credits: CreditsApi;
+    usage: UsageApi;
+    paymentMethods: PaymentMethodsApi;
+    affiliate: AffiliateApi;
+    getCheckoutUrl(planId: string, opts?: GetCheckoutUrlOpts): Promise<CheckoutUrl>;
+}
+declare const billingModule: SdkModule<BillingApi>;
+
+export { type AddPayoutAccountInput, type Addon, type AddonsApi, type AddonsFilter, type AffiliateApi, type AnalyticsPeriod, type BillingApi, type BillingSubscription, type CheckoutUrl, type Coupon, type CouponFilterInput, type CouponsApi, type CouponsListResponse, type CreateAddOnsInput, type CreateCouponInput, type CreatePaymentMethodInput, type CreditBalanceByType, type CreditTransaction, type CreditsApi, type EarningsSummary, type GetCheckoutUrlOpts, type Invoice, type InvoiceStatus, type InvoicesApi, type MoneyAmount, type PaginatedInvoices, type PaginatedRefundRecords, type PaginatedSubscriptions, type PaymentMethod, type PaymentMethodsApi, type PayoutAccount, type PayoutRequest, type Plan, type PlansApi, type PlansFilter, type QuotaAssignment, type RefundRecord, type RefundsApi, type RequestCreditWithdrawalInput, type RequestPayoutInput, type RequestRefundInput, type SpendCreditResponse, type SpendCreditsInput, type SubscriptionStatus, type SubscriptionsApi, type UpdateAddOnsInput, type UpdateCouponInput, type UpdateSubscriptionSeatsInput, type UsageApi, type UsageDashboard, billingModule as default };