Created
May 18, 2022 11:13
Revisions
-
dsumer created this gist
May 18, 2022 .There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode charactersOriginal file line number Diff line number Diff line change @@ -0,0 +1,100 @@ export interface PaddlePassthrough { userId: string; // the id of the user in our supabase database } export enum PaddleSubscriptionStatus { Active = 'active', Trialing = 'trialing', // at the moment we don't support trial phases PastDue = 'past_due', // Payment is pending, we should inform he user that he needs to update his payment method Paused = 'paused', // at the moment we don't support pausing subscriptions Cancelled = 'deleted', } enum AlertName { SubscriptionCreated = 'subscription_created', SubscriptionUpdated = 'subscription_updated', SubscriptionCancelled = 'subscription_cancelled', SubscriptionPaymentSucceeded = 'subscription_payment_succeeded', SubscriptionPaymentFailed = 'subscription_payment_failed', SubscriptionPaymentRefunded = 'subscription_payment_refunded', } enum PaymentStatus { Success = 'success', Error = 'error', Refund = 'refund', } interface BasePaddleRequest { alert_id: string; alert_name: AlertName; status: PaddleSubscriptionStatus; /** * Holds the data we pass to Paddle at the checkout as a JSON string. * Take a look at {@link PaddlePassthrough} to see what it contains. */ passthrough: string; subscription_id: string; subscription_plan_id: string; } interface SubscriptionCreatedRequest extends BasePaddleRequest { alert_name: AlertName.SubscriptionCreated; next_bill_date: string; cancel_url: string; update_url: string; } interface SubscriptionUpdatedRequest extends BasePaddleRequest { alert_name: AlertName.SubscriptionUpdated; next_bill_date: string; cancel_url: string; update_url: string; } interface SubscriptionCancelledRequest extends BasePaddleRequest { alert_name: AlertName.SubscriptionCancelled; cancellation_effective_date: string; } interface SubscriptionPaymentSucceededRequest extends BasePaddleRequest { alert_name: AlertName.SubscriptionPaymentSucceeded; subscription_payment_id: string; country: string; currency: string; customer_name: string; fee: string; payment_method: string; payment_tax: string; receipt_url: string; sale_gross: string; next_bill_date: string; } interface SubscriptionPaymentFailedRequest extends BasePaddleRequest { alert_name: AlertName.SubscriptionPaymentFailed; subscription_payment_id: string; amount: string; currency: string; next_retry_date?: string; attempt_number: string; } interface SubscriptionPaymentRefundedRequest extends BasePaddleRequest { alert_name: AlertName.SubscriptionPaymentRefunded; subscription_payment_id: string; gross_refund: string; fee_refund: string; tax_refund: string; currency: string; refund_reason: string; refund_type: string; } type PaddleRequest = | SubscriptionCreatedRequest | SubscriptionUpdatedRequest | SubscriptionCancelledRequest | SubscriptionPaymentSucceededRequest | SubscriptionPaymentFailedRequest | SubscriptionPaymentRefundedRequest;