paddle

type Alert string

type Client struct {
	BaseURL         *url.URL
	CheckoutBaseURL *url.URL
	UserAgent       string
	// contains filtered or unexported fields
}

type ErrorCode int

type GeneratePayLinkRequest struct {
	// ProductID is The Paddle Product ID/Plan ID that you want to base this custom checkout on.
	// Required if not using custom products.
	// If no ProductID is set, custom non-subscription product checkouts can be generated instead by specifying the required fields: Title, WebhookURL and prices.
	// Note that CouponCode cannot be used with custom products.
	ProductID int
	// Title is the name of the product/title of the checkout. Required if ProductID is not set.
	Title string
	// WebhookURL is an endpoint that we will call with transaction information upon successful checkout, to allow you to fulfill the purchase.
	// Only valid (and required) if ProductID is not set. Not valid for subscription plans.
	// Note: testing on localhost is not supported. Please use an internet-accessible URL.
	WebhookURL string
	// Prices is price (s) of the checkout for a one-time purchase or the initial payment of a subscription.
	// If ProductID is set, you must also provide the price for the product’s default currency.If a given currency is enabled in the dashboard, it will default to a conversion of the product’s default currency price set in this field unless specified here as well.
	// If the currency specified is not enabled in the dashboard and the ProductID is a subscription, the currency’s RecurringPrices must be set as well.
	Prices map[string]string
	// RecurringPrices is recurring price(s) of the checkout (excluding the initial payment) only if the ProductID specified is a subscription.
	// To override the initial payment and all recurring payment amounts, both Prices and RecurringPrices must be set.
	// You must also provide the price for the subscription’s default currency.
	// If a given currency is enabled in the dashboard, it will default to a conversion of the subscription’s default currency price set in this field unless specified here as well.
	// If the currency specified is not enabled in the dashboard, the currency’s prices must be set as well.
	RecurringPrices map[string]string
	// TrialDays is for subscription plans only.
	// The number of days for the initial billing cycle.
	// If you leave this field empty, the default trial days of the plan will be used.
	// Note: The prices might additionally need to be set in order to achieve the desired behaviour (free trial/paid trial),
	// depending on whether the plan had a trial period set originally.
	TrialDays int
	// CustomMessage is a short message displayed below the product name on the checkout.
	CustomMessage string
	// CouponCode is a coupon to be applied to the checkout.
	// Note that this cannot be used with custom products, and is only valid if a ProductID is set.
	CouponCode string
	// Discountable specifies if a coupon can be applied to the checkout.
	// “Add Coupon” button on the checkout will be hidden as well if set to false.
	Discountable *bool
	// ImageURL is a URL for the product image/icon displayed on the checkout.
	ImageURL string
	// ReturnURL is a URL to redirect to once the checkout is completed.
	// If the variable {checkout_hash} is included within the URL
	// (e.g.https://example.com/thanks?checkout={checkout_hash}), the API will automatically populate the Paddle checkout ID in the redirected URL.
	ReturnURL string
	// QuantityVariable specifies if the user is allowed to alter the quantity of the checkout.
	QuantityVariable *bool
	// Quantity pre-fills the quantity selector on the checkout.Please note that free products/subscription plans are fixed to a quantity of 1.
	// Any quantity over the maximum value will default to a quantity of 1.
	Quantity int
	// Expires specifies if the checkout link should expire.
	// The generated checkout URL will be accessible until 23:59:59 (UTC) on the date specified.
	// If this is not specified, the checkout link will automatically expire 60 days after it has been first opened.
	Expires time.Time
	// Affiliates contains other Paddle vendor IDs whom you would like to split the funds from this checkout with.
	Affiliates map[string]string
	// RecurringAffiliateLimit limits the number of times other Paddle vendors will receive funds from the recurring payments (for subscription products).
	// The initial checkout payment is included in the limit.
	// If you leave this field empty, the limit will not be applied.
	// Note: if your plan has a trial period, set this to 2 or greater in order for your affiliates to correctly receive their commission on paid payments after the trial.
	RecurringAffiliateLimit int
	// MarketingConsent specifies whether you have gathered consent to market to the customer.
	// CustomerEmail is required if this property is set, and you want to opt the customer into marketing.
	MarketingConsent bool
	// CustomerEmail pre-fills the customer email field on the checkout.
	CustomerEmail string
	// CustomerCountry pre-fills the customer country field on the checkout.
	// List of supported ISO country codes - https://developer.paddle.com/reference/platform-parameters/supported-countries
	// Only pre-filled if CustomerEmail is set.
	CustomerCountry string
	// CustomerPostcode pre-fills the customer postcode field on the checkout.
	// This field is required if the CustomerCountry requires postcode.
	// List of the countries requiring this field - https://developer.paddle.com/reference/platform-parameters/supported-countries#countries-requiring-postcode
	CustomerPostcode string
	// IsRecoverable Specifies if checkout recovery emails can be sent to users who abandon the checkout process after entering their email address.
	// An additional 10% transaction fee applies to checkouts we recover.
	// This will override the checkout recovery setting specified in your page.
	IsRecoverable *bool
	// Passthrough is a string of metadata you wish to store with the checkout.
	// Will be sent alongside all webhooks associated with the order.
	// See the documentation for more information.
	Passthrough string
	// VatNumber pre-fills the sales tax identifier (VAT number) field on the checkout.
	VatNumber string
	// VatCompanyName pre-fills the Company Name field on the checkout.
	// Required if VatNumber is set.
	VatCompanyName string
	// VatStreet pre-fills the Street field on the checkout.
	// Required if VatNumber is set.
	VatStreet string
	// VatCity pre-fills the Town/City field on the checkout.
	// Required if VatNumber is set.
	VatCity string
	// VatState pre-fills the State field on the checkout.
	VatState string
	// VatCountry pre-fills the Country field on the checkout.
	// Required if VatNumber is set.
	// List of the list of supported ISO country codes - https://developer.paddle.com/reference/platform-parameters/supported-countries
	VatCountry string
	// VatPostcode pre-fills the Postcode field on the checkout.
	VatPostcode string
}

type InvoiceOverdue struct {
	AlertName                    Alert
	AlertID                      string
	PaymentID                    string
	Amount                       string
	SaleGross                    string
	TermDays                     string
	Status                       Status
	PurchaseOrderNumber          string
	InvoicedAt                   time.Time
	Currency                     string
	ProductID                    string
	ProductName                  string
	ProductAdditionalInformation string
	CustomerID                   string
	CustomerName                 string
	Email                        string
	CustomerVatNumber            string
	CustomerCompanyNumber        string
	CustomerAddress              string
	CustomerCity                 string
	CustomerState                string
	CustomerZipcode              string
	Country                      string
	ContractID                   string
	ContractStartDate            time.Time
	ContractEndDate              time.Time
	Passthrough                  string
	DateCreated                  time.Time
	BalanceCurrency              string
	PaymentTax                   string
	PaymentMethod                PaymentMethod
	Fee                          string
	Earnings                     string
	EventTime                    time.Time
}

type InvoicePaid struct {
	AlertName                    Alert
	AlertID                      string
	PaymentID                    string
	Amount                       string
	SaleGross                    string
	TermDays                     string
	Status                       Status
	PurchaseOrderNumber          string
	InvoicedAt                   time.Time
	Currency                     string
	ProductID                    string
	ProductName                  string
	ProductAdditionalInformation string
	CustomerID                   string
	CustomerName                 string
	Email                        string
	CustomerVatNumber            string
	CustomerCompanyNumber        string
	CustomerAddress              string
	CustomerCity                 string
	CustomerState                string
	CustomerZipcode              string
	Country                      string
	ContractID                   string
	ContractStartDate            time.Time
	ContractEndDate              time.Time
	Passthrough                  string
	DateCreated                  time.Time
	BalanceCurrency              string
	PaymentTax                   string
	PaymentMethod                PaymentMethod
	Fee                          string
	Earnings                     string
	BalanceEarnings              string
	BalanceFee                   string
	BalanceTax                   string
	BalanceGross                 string
	DateReconciled               time.Time
	EventTime                    time.Time
}

type InvoiceSent struct {
	AlertName                    Alert
	AlertID                      string
	PaymentID                    string
	Amount                       string
	SaleGross                    string
	TermDays                     string
	Status                       Status
	PurchaseOrderNumber          string
	InvoicedAt                   time.Time
	Currency                     string
	ProductID                    string
	ProductName                  string
	ProductAdditionalInformation string
	CustomerID                   string
	CustomerName                 string
	Email                        string
	CustomerVatNumber            string
	CustomerCompanyNumber        string
	CustomerAddress              string
	CustomerCity                 string
	CustomerState                string
	CustomerZipcode              string
	Country                      string
	ContractID                   string
	ContractStartDate            time.Time
	ContractEndDate              time.Time
	Passthrough                  string
	DateCreated                  time.Time
	BalanceCurrency              string
	PaymentTax                   string
	PaymentMethod                PaymentMethod
	Fee                          string
	Earnings                     string
	EventTime                    time.Time
}

type PausedReason string

type PaymentMethod string

type PaymentSucceeded struct {
	AlertName        Alert
	AlertID          string
	BalanceCurrency  string
	BalanceEarnings  string
	BalanceFee       string
	BalanceGross     string
	BalanceTax       string
	CheckoutID       string
	Country          string
	Coupon           string
	Currency         string
	CustomerName     string
	Earnings         string
	Email            string
	EventTime        time.Time
	Fee              string
	MarketingConsent bool
	OrderID          string
	// IP defines user IP.
	// Deprecated, see https://developer.paddle.com/webhook-reference/one-off-purchase-alerts/payment-succeeded
	IP                string
	Passthrough       string
	PaymentMethod     PaymentMethod
	PaymentTax        string
	ProductID         string
	ProductName       string
	Quantity          int
	ReceiptURL        string
	SaleGross         string
	UsedPriceOverride bool
}

type RefundType string

type Settings struct {
	URL            string
	CheckoutURL    string
	Client         *http.Client
	VendorID       string
	VendorAuthCode string
}

type Status string

type SubscriptionCancelled struct {
	AlertName                 Alert
	AlertID                   string
	CancellationEffectiveDate time.Time
	CheckoutID                string
	Currency                  string
	Email                     string
	EventTime                 time.Time
	MarketingConsent          bool
	Passthrough               string
	Quantity                  int
	Status                    Status
	SubscriptionID            string
	SubscriptionPlanID        string
	UnitPrice                 string
	UserID                    string
}

type SubscriptionCreated struct {
	AlertName          Alert
	AlertID            string
	CancelURL          string
	CheckoutID         string
	Currency           string
	Email              string
	EventTime          time.Time
	MarketingConsent   bool
	NextBillDate       time.Time
	Passthrough        string
	Quantity           int
	Source             string
	Status             Status
	SubscriptionID     string
	SubscriptionPlanID string
	UnitPrice          string
	UserID             string
	UpdateURL          string
}

type SubscriptionPaymentFailed struct {
	AlertName             Alert
	AlertID               string
	Amount                string
	CancelURL             string
	CheckoutID            string
	Currency              string
	Email                 string
	EventTime             time.Time
	MarketingConsent      bool
	NextRetryDate         time.Time
	Passthrough           string
	Quantity              int
	Status                Status
	SubscriptionID        string
	SubscriptionPlanID    string
	UnitPrice             string
	UpdateURL             string
	SubscriptionPaymentID string
	Installments          int
	OrderID               string
	UserID                string
	AttemptNumber         int
}

type SubscriptionPaymentRefunded struct {
	AlertName               Alert
	AlertID                 string
	Amount                  string
	BalanceCurrency         string
	BalanceEarningsDecrease string
	BalanceFeeRefund        string
	BalanceGrossRefund      string
	BalanceTaxRefund        string
	CheckoutID              string
	Currency                string
	EarningsDecrease        string
	Email                   string
	EventTime               time.Time
	FeeRefund               string
	GrossRefund             string
	InitialPayment          bool
	Instalments             string
	MarketingConsent        bool
	OrderID                 string
	Passthrough             string
	Quantity                int
	RefundReason            string
	RefundType              RefundType
	Status                  Status
	SubscriptionID          string
	SubscriptionPaymentID   string
	SubscriptionPlanID      string
	TaxRefund               string
	UnitPrice               string
	UserID                  string
}

type SubscriptionPaymentSucceeded struct {
	AlertName             Alert
	AlertID               string
	BalanceCurrency       string
	BalanceEarnings       string
	BalanceFee            string
	BalanceGross          string
	BalanceTax            string
	CheckoutID            string
	Country               string
	Coupon                string
	Currency              string
	CustomerName          string
	Earnings              string
	Email                 string
	EventTime             time.Time
	Fee                   string
	InitialPayment        bool
	Instalments           string
	MarketingConsent      bool
	NextBillDate          time.Time
	NextPaymentAmount     string
	OrderID               string
	Passthrough           string
	PaymentMethod         PaymentMethod
	PaymentTax            string
	PlanName              string
	Quantity              int
	ReceiptURL            string
	SaleGross             string
	Status                Status
	SubscriptionID        string
	SubscriptionPaymentID string
	SubscriptionPlanID    string
	UnitPrice             string
	UserID                string
}

type SubscriptionUpdated struct {
	AlertName Alert
	AlertID   string

	UpdateURL string
	CancelURL string

	CheckoutID       string
	Currency         string
	Email            string
	EventTime        time.Time
	MarketingConsent bool

	NewPrice     string
	NewQuantity  int
	NewUnitPrice string
	NextBillDate time.Time

	Passthrough        string
	Status             Status
	SubscriptionID     string
	SubscriptionPlanID string
	UserID             string

	OldNextBillDate       time.Time
	OldPrice              string
	OldQuantity           int
	OldStatus             Status
	OldSubscriptionPlanID string
	OldUnitPrice          string

	PausedAt     time.Time
	PausedFrom   time.Time
	PausedReason PausedReason
}

type TransferCreated struct {
	AlertName Alert
	AlertID   string
	Amount    string
	Currency  string
	EventTime time.Time
	PayoutID  string
	Status    Status
}

type TransferPaid struct {
	AlertName Alert
	AlertID   string
	Amount    string
	Currency  string
	EventTime time.Time
	PayoutID  string
	Status    Status
}

type WebhookClient struct {
	// contains filtered or unexported fields
}