@becomes/cms-cloud-client/b-types/paddle/models/transaction.d.ts

SDK for accessing BCMS Cloud API

import { FSDBEntity } from '@becomes/purple-cheetah-mod-fsdb/types';
import type { ObjectSchema } from '@becomes/purple-cheetah/types';
export declare enum PaddleTransactionType {
    subscription_created = "subscription_created",
    subscription_updated = "subscription_updated",
    subscription_cancelled = "subscription_cancelled",
    subscription_payment_succeeded = "subscription_payment_succeeded",
    subscription_payment_failed = "subscription_payment_failed",
    subscription_payment_refunded = "subscription_payment_refunded",
    locker_processed = "locker_processed",
    payment_refunded = "payment_refunded",
    payment_succeeded = "payment_succeeded"
}
export interface PaddleData {
    alert_id: string;
    alert_name: PaddleTransactionType;
    balance_currency?: string;
    balance_earnings?: string;
    balance_fee?: string;
    balance_gross?: string;
    balance_tax?: string;
    checkout_id: string;
    country?: string;
    coupon?: string;
    currency?: string;
    custom_data?: string;
    customer_name?: string;
    earnings?: string;
    email?: string;
    event_time?: string;
    fee?: string;
    initial_payment?: string;
    instalments?: string;
    marketing_consent?: string;
    next_bill_date?: string;
    next_payment_amount?: string;
    order_id?: string;
    passthrough?: string;
    payment_method?: string;
    payment_tax?: string;
    plan_name?: string;
    quantity?: string;
    receipt_url?: string;
    sale_gross?: string;
    status?: string;
    subscription_id?: string;
    subscription_payment_id?: string;
    subscription_plan_id?: string;
    unit_price?: string;
    user_id?: string;
    cancel_url?: string;
    linked_subscriptions?: string;
    source?: string;
    update_url?: string;
    next_retry_date?: string;
}
export interface PaddleTransaction extends FSDBEntity {
    alertId: string;
    type: PaddleTransactionType;
    orgId: string;
    userId: string;
    instanceId?: string;
    data: string;
    checkoutId: string;
}
export declare const PaddleTransactionSchema: ObjectSchema;