opensettle

package module

Go to main page

Versions in this module

v0

v0.5.0

May 14, 2026

Changes in this version

+ type ChainID string

+ type RequestOption func(*requestConfig)

+ func WithIdempotencyKey(key string) RequestOption

+ type UnsignedEVMTx struct

+ AmountBaseUnits string

+ ChainID int

+ Data string

+ Recipient string

+ To string

+ TokenAddress string

+ Value string

v0.4.0

May 14, 2026

Changes in this version

type Checkout

+ HostedURL string

v0.3.0

May 12, 2026

Changes in this version

+ func WaitFor[T any](ctx context.Context, retrieve func(ctx context.Context, id string) (T, error), ...) (T, error)

type CustomersResource

+ func (r *CustomersResource) ListIter(ctx context.Context, query *ListCustomersQuery) *Iter[Customer]

type InvoicesResource

+ func (r *InvoicesResource) ListIter(ctx context.Context, query *ListInvoicesQuery) *Iter[Invoice]

+ type Iter struct

+ func (it *Iter[T]) Err() error

+ func (it *Iter[T]) Item() *T

+ func (it *Iter[T]) Next() bool

type PaymentsResource

+ func (r *PaymentsResource) ListIter(ctx context.Context, query *ListPaymentsQuery) *Iter[Payment]

type ProductsResource

+ func (r *ProductsResource) ListIter(ctx context.Context, query *ListProductsQuery) *Iter[Product]

type SubscriptionsResource

+ func (r *SubscriptionsResource) ListIter(ctx context.Context, query *ListSubscriptionsQuery) *Iter[Subscription]

+ type WaitOptions struct

+ Interval time.Duration

+ Timeout time.Duration

+ type WaitTimeoutError struct

+ Last any

+ ResourceID string

+ Timeout time.Duration

+ func (e *WaitTimeoutError) Error() string

v0.2.0

May 12, 2026

v0.1.0

May 12, 2026

Changes in this version

+ const Version

+ func FromEnvelope(body []byte, status int, retryAfter float64) error

+ func IsOpenSettleError(err error) bool

+ type APIError struct

+ func (e *APIError) Unwrap() error

+ type AuthenticationError struct

+ func (e *AuthenticationError) Unwrap() error

+ type AutopayMode string

+ const AutopayAllowance

+ const AutopayManual

+ const AutopaySmartWallet

+ type CancelMode string

+ const CancelAtPeriodEnd

+ const CancelImmediately

+ type CancelSubscriptionRequest struct

+ Mode CancelMode

+ Reason string

+ type ChainId string

+ const ChainArbitrum

+ const ChainBase

+ const ChainEthereum

+ const ChainPolygon

+ const ChainSolana

+ const ChainTron

+ type ChangePlanRequest struct

+ PriceID string

+ ProrationMode ProrationMode

+ type Checkout struct

+ AmountMinor int

+ CancelURL *string

+ Chain ChainId

+ CompletedAt *string

+ CreatedAt string

+ Currency string

+ CustomerID string

+ Description *string

+ ExpiresAt string

+ ID string

+ InvoiceID *string

+ Metadata Metadata

+ Mode CheckoutMode

+ PriceID *string

+ Status CheckoutStatus

+ SuccessURL string

+ Token TokenSymbol

+ UpdatedAt string

+ WorkspaceID string

+ type CheckoutMode string

+ const CheckoutPayment

+ const CheckoutSubscription

+ type CheckoutStatus string

+ const CheckoutExpired

+ const CheckoutFailed

+ const CheckoutOpen

+ const CheckoutPending

+ const CheckoutSucceeded

+ type CheckoutsResource struct

+ func (r *CheckoutsResource) Create(ctx context.Context, input CreateCheckoutRequest) (*Checkout, error)

+ func (r *CheckoutsResource) Retrieve(ctx context.Context, id string) (*Checkout, error)

+ type Client struct

+ Checkouts *CheckoutsResource

+ Customers *CustomersResource

+ Invoices *InvoicesResource

+ Payments *PaymentsResource

+ Products *ProductsResource

+ Subscriptions *SubscriptionsResource

+ WebhookEndpoints *WebhookEndpointsResource

+ func NewClient(apiKey, workspaceID string, opts ...Option) (*Client, error)

+ type ConfigError struct

+ Message string

+ func (e *ConfigError) Error() string

+ type ConflictError struct

+ func (e *ConflictError) Unwrap() error

+ type CreateCheckoutRequest struct

+ CancelURL string

+ Chain ChainId

+ CustomerEmail string

+ CustomerID string

+ CustomerName string

+ ExpiresInMinutes int

+ InvoiceID string

+ Metadata Metadata

+ Mode CheckoutMode

+ PriceID string

+ SuccessURL string

+ Token TokenSymbol

+ type CreateCustomerRequest struct

+ Country string

+ Email string

+ Metadata Metadata

+ Name string

+ Wallet string

+ type CreateInvoiceRequest struct

+ Chain ChainId

+ Currency string

+ CustomerID string

+ DueInDays int

+ LineItems []LineItem

+ Memo string

+ Metadata Metadata

+ SubscriptionID string

+ Token TokenSymbol

+ type CreatePriceRequest struct

+ Amount int

+ Currency string

+ Interval PriceInterval

+ Metadata Metadata

+ type CreateProductRequest struct

+ Description string

+ Metadata Metadata

+ Name string

+ type CreateSubscriptionRequest struct

+ Autopay AutopayMode

+ Chain ChainId

+ CustomerID string

+ Metadata Metadata

+ PriceID string

+ Token TokenSymbol

+ TrialDays int

+ type CreateWebhookEndpointRequest struct

+ Description string

+ Events []string

+ URL string

+ type CreateWebhookEndpointResponse struct

+ Endpoint WebhookEndpoint

+ SigningSecret string

+ type CursorPage struct

+ Data []T

+ HasMore bool

+ NextCursor string

+ type Customer struct

+ ActiveSubscriptions int

+ Country *string

+ CreatedAt string

+ DeletedAt *string

+ Email string

+ ID string

+ LifetimeValue int

+ Metadata Metadata

+ Name string

+ Status CustomerStatus

+ Wallet *string

+ WorkspaceID string

+ type CustomerStatus string

+ const CustomerActive

+ const CustomerAtRisk

+ const CustomerChurned

+ type CustomersResource struct

+ func (r *CustomersResource) Create(ctx context.Context, input CreateCustomerRequest) (*Customer, error)

+ func (r *CustomersResource) Delete(ctx context.Context, customerID string) error

+ func (r *CustomersResource) List(ctx context.Context, query *ListCustomersQuery) (*CursorPage[Customer], error)

+ func (r *CustomersResource) Retrieve(ctx context.Context, customerID string) (*Customer, error)

+ func (r *CustomersResource) Update(ctx context.Context, customerID string, input UpdateCustomerRequest) (*Customer, error)

+ type ErrorCode string

+ const CodeAALRequired

+ const CodeChainReverted

+ const CodeConflict

+ const CodeForbidden

+ const CodeInsufficientConfirmations

+ const CodeInternalError

+ const CodeInvalidRequest

+ const CodeInvalidStateTransition

+ const CodeNetworkError

+ const CodeNotFound

+ const CodeRateLimited

+ const CodeSigningRequired

+ const CodeUnauthorized

+ type ForbiddenError struct

+ func (e *ForbiddenError) Unwrap() error

+ type InitiateRefundRequest struct

+ AmountMinor int

+ Reason string

+ RecipientAddress string

+ type InitiateRefundResponse struct

+ Payment Payment

+ UnsignedTx UnsignedTxEnvelope

+ type InvalidRequestError struct

+ func (e *InvalidRequestError) Unwrap() error

+ type InvalidStateTransitionError struct

+ func (e *InvalidStateTransitionError) Unwrap() error

+ type Invoice struct

+ AmountMinor int

+ Chain ChainId

+ CreatedAt string

+ Currency string

+ CustomerID string

+ DueAt string

+ HostedURL string

+ ID string

+ IssuedAt *string

+ LineItems []LineItem

+ Memo *string

+ Metadata Metadata

+ Number string

+ PaidAt *string

+ PaymentID *string

+ Status InvoiceStatus

+ SubscriptionID *string

+ Token TokenSymbol

+ VoidedAt *string

+ WorkspaceID string

+ type InvoiceStatus string

+ const InvoiceDraft

+ const InvoiceOpen

+ const InvoicePaid

+ const InvoicePastDue

+ const InvoiceVoid

+ type InvoicesResource struct

+ func (r *InvoicesResource) Create(ctx context.Context, input CreateInvoiceRequest) (*Invoice, error)

+ func (r *InvoicesResource) List(ctx context.Context, query *ListInvoicesQuery) (*CursorPage[Invoice], error)

+ func (r *InvoicesResource) Remind(ctx context.Context, invoiceID string) (*Invoice, error)

+ func (r *InvoicesResource) Retrieve(ctx context.Context, invoiceID string) (*Invoice, error)

+ func (r *InvoicesResource) Send(ctx context.Context, invoiceID string) (*Invoice, error)

+ func (r *InvoicesResource) Void(ctx context.Context, invoiceID string) (*Invoice, error)

+ type LineItem struct

+ Description string

+ Quantity int

+ UnitAmountMinor int

+ type ListCustomersQuery struct

+ Cursor string

+ Limit int

+ Q string

+ Status CustomerStatus

+ type ListInvoicesQuery struct

+ Cursor string

+ CustomerID string

+ Limit int

+ Status InvoiceStatus

+ type ListPaymentsQuery struct

+ Cursor string

+ CustomerID string

+ Limit int

+ Status PaymentStatus

+ type ListProductsQuery struct

+ Active *bool

+ Cursor string

+ Limit int

+ type ListSubscriptionsQuery struct

+ Cursor string

+ CustomerID string

+ Limit int

+ Status SubscriptionStatus

+ type Metadata map[string]any

+ type NetworkError struct

+ func (e *NetworkError) Unwrap() error

+ type NotFoundError struct

+ func (e *NotFoundError) Unwrap() error

+ type OpenSettleError struct

+ Code ErrorCode

+ Message string

+ Param string

+ RequestID string

+ Status int

+ func (e *OpenSettleError) Error() string

+ type Option func(*clientConfig)

+ func WithBaseURL(url string) Option

+ func WithHTTPClient(hc *http.Client) Option

+ func WithMaxRetries(n int) Option

+ func WithTestMode(test bool) Option

+ func WithTimeout(d time.Duration) Option

+ func WithUserAgent(ua string) Option

+ type Payment struct

+ AmountMinor int

+ BlockNumber *int

+ Chain ChainId

+ Confirmations int

+ ConfirmedAt *string

+ CreatedAt string

+ Currency string

+ CustomerID *string

+ Description *string

+ FailureReason *string

+ FeeMinor int

+ ID string

+ InvoiceID *string

+ NetMinor int

+ RefundAmountMinor *int

+ RefundBroadcastAt *string

+ RefundReason *string

+ RefundTxHash *string

+ RefundedAt *string

+ Status PaymentStatus

+ SubscriptionID *string

+ Token TokenSymbol

+ TxHash *string

+ WalletID *string

+ WorkspaceID string

+ type PaymentStatus string

+ const PaymentConfirmed

+ const PaymentFailed

+ const PaymentPending

+ const PaymentRefunded

+ const PaymentReorged

+ type PaymentsResource struct

+ func (r *PaymentsResource) List(ctx context.Context, query *ListPaymentsQuery) (*CursorPage[Payment], error)

+ func (r *PaymentsResource) Refund(ctx context.Context, paymentID string, input InitiateRefundRequest) (*InitiateRefundResponse, error)

+ func (r *PaymentsResource) RefundBroadcast(ctx context.Context, paymentID string, input RecordRefundBroadcastRequest) (*Payment, error)

+ func (r *PaymentsResource) Retrieve(ctx context.Context, paymentID string) (*Payment, error)

+ type Price struct

+ Active bool

+ Amount int

+ CreatedAt string

+ Currency string

+ ID string

+ Interval PriceInterval

+ Metadata Metadata

+ ProductID string

+ WorkspaceID string

+ type PriceInterval string

+ const PriceMonth

+ const PriceOneTime

+ const PriceWeek

+ const PriceYear

+ type Product struct

+ Active bool

+ CreatedAt string

+ Description *string

+ ID string

+ Metadata Metadata

+ Name string

+ WorkspaceID string

+ type ProductsResource struct

+ func (r *ProductsResource) Create(ctx context.Context, input CreateProductRequest) (*Product, error)

+ func (r *ProductsResource) CreatePrice(ctx context.Context, productID string, input CreatePriceRequest) (*Price, error)

+ func (r *ProductsResource) Delete(ctx context.Context, productID string) error

+ func (r *ProductsResource) DeletePrice(ctx context.Context, priceID string) error

+ func (r *ProductsResource) List(ctx context.Context, query *ListProductsQuery) (*CursorPage[Product], error)

+ func (r *ProductsResource) ListPrices(ctx context.Context, productID string) ([]Price, error)

+ func (r *ProductsResource) Retrieve(ctx context.Context, productID string) (*Product, error)

+ func (r *ProductsResource) Update(ctx context.Context, productID string, input UpdateProductRequest) (*Product, error)

+ type ProrationMode string

+ const ProrationAtPeriodEnd

+ const ProrationImmediately

+ type RateLimitError struct

+ RetryAfter float64

+ func (e *RateLimitError) Unwrap() error

+ type RecordRefundBroadcastRequest struct

+ RefundTxHash string

+ type RotateWebhookSecretRequest struct

+ GraceSeconds int

+ type RotateWebhookSecretResponse struct

+ RotationGraceUntil string

+ Secret string

+ type SettlementError struct

+ func (e *SettlementError) Unwrap() error

+ type StepUpRequiredError struct

+ func (e *StepUpRequiredError) Unwrap() error

+ type Subscription struct

+ AllowanceRemaining *int

+ AllowanceTx *string

+ AmountMinor int

+ Autopay AutopayMode

+ CancelReason *string

+ CanceledAt *string

+ Chain ChainId

+ CreatedAt string

+ Currency string

+ CurrentPeriodEnd string

+ CustomerID string

+ ID string

+ MRRMinor int

+ Metadata Metadata

+ NextBillingDate string

+ PausedAt *string

+ PriceID string

+ ProductID string

+ StartedAt string

+ Status SubscriptionStatus

+ Token TokenSymbol

+ TrialEndsAt *string

+ WorkspaceID string

+ type SubscriptionStatus string

+ const SubActive

+ const SubCanceled

+ const SubPastDue

+ const SubPaused

+ const SubTrialing

+ type SubscriptionsResource struct

+ func (r *SubscriptionsResource) Cancel(ctx context.Context, subID string, input CancelSubscriptionRequest) (*Subscription, error)

+ func (r *SubscriptionsResource) ChangePlan(ctx context.Context, subID string, input ChangePlanRequest) (*Subscription, error)

+ func (r *SubscriptionsResource) Create(ctx context.Context, input CreateSubscriptionRequest) (*Subscription, error)

+ func (r *SubscriptionsResource) List(ctx context.Context, query *ListSubscriptionsQuery) (*CursorPage[Subscription], error)

+ func (r *SubscriptionsResource) Pause(ctx context.Context, subID string) (*Subscription, error)

+ func (r *SubscriptionsResource) Resume(ctx context.Context, subID string) (*Subscription, error)

+ func (r *SubscriptionsResource) Retrieve(ctx context.Context, subID string) (*Subscription, error)

+ type TestWebhookEndpointRequest struct

+ EventType string

+ type TestWebhookEndpointResponse struct

+ LatencyMs int

+ OK bool

+ Status int

+ type TokenSymbol string

+ const TokenUSDC

+ const TokenUSDT

+ type UnsignedEvmTx struct

+ AmountBaseUnits string

+ ChainID int

+ Data string

+ Recipient string

+ To string

+ TokenAddress string

+ Value string

+ type UnsignedTxEnvelope struct

+ AmountMinor int

+ Chain ChainId

+ EVM *UnsignedEvmTx

+ Instructions string

+ Memo string

+ To string

+ Token TokenSymbol

+ type UpdateCustomerRequest struct

+ Country *string

+ Metadata Metadata

+ Name *string

+ Wallet *string

+ type UpdateProductRequest struct

+ Active *bool

+ Description *string

+ Metadata Metadata

+ Name *string

+ type UpdateWebhookEndpointRequest struct

+ Description *string

+ Events []string

+ Status *WebhookEndpointStatus

+ URL *string

+ type WebhookEndpoint struct

+ CreatedAt string

+ Description *string

+ Events []string

+ ID string

+ RotationGraceUntil *string

+ Status WebhookEndpointStatus

+ SuccessRate float64

+ URL string

+ WorkspaceID string

+ type WebhookEndpointStatus string

+ const WebhookDisabled

+ const WebhookEnabled

+ type WebhookEndpointsResource struct

+ func (r *WebhookEndpointsResource) Create(ctx context.Context, input CreateWebhookEndpointRequest) (*CreateWebhookEndpointResponse, error)

+ func (r *WebhookEndpointsResource) Delete(ctx context.Context, endpointID string) error

+ func (r *WebhookEndpointsResource) List(ctx context.Context) ([]WebhookEndpoint, error)

+ func (r *WebhookEndpointsResource) Retrieve(ctx context.Context, endpointID string) (*WebhookEndpoint, error)

+ func (r *WebhookEndpointsResource) RotateSecret(ctx context.Context, endpointID string, input RotateWebhookSecretRequest) (*RotateWebhookSecretResponse, error)

+ func (r *WebhookEndpointsResource) Test(ctx context.Context, endpointID string, input TestWebhookEndpointRequest) (*TestWebhookEndpointResponse, error)

+ func (r *WebhookEndpointsResource) Update(ctx context.Context, endpointID string, input UpdateWebhookEndpointRequest) (*WebhookEndpoint, error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL