API Reference LatticeStripe v#1.7.10

Copy Markdown View Source

Modules

A production-grade, idiomatic Elixir SDK for the Stripe API.

Operations on Stripe Connect Account objects.

Represents the business_profile nested object on a Stripe Account.

A single capability entry from Account.capabilities.

Represents the company nested object on a Stripe Account.

Represents the individual nested object on a Stripe Account.

Represents the requirements nested object on a Stripe Account.

Represents the settings nested object on a Stripe Account.

Represents the tos_acceptance nested object on a Stripe Account.

Operations on Stripe Connect Account Links — short-lived onboarding URLs.

Stripe Balance singleton.

A single currency-denominated amount in a Stripe Balance.

Operations on Stripe BalanceTransaction objects — the server-side ledger entries that back every Charge, Refund, Transfer, Payout, and fee on a Stripe account.

A single fee line on a Stripe BalanceTransaction.

A Stripe bank account attached to a Connect connected account (external account).

Execute multiple Stripe API calls concurrently.

Stripe Billing Meter resource — usage-based billing schema.

How a LatticeStripe.Billing.MeterEvent payload is mapped to a Stripe customer. Currently Stripe exposes "by_id" with event_payload_key naming the field inside payload that carries a cus_* customer ID. :extra captures any future mapping types Stripe adds.

Lifecycle timestamps for LatticeStripe.Billing.Meter. Currently only deactivated_at (Unix epoch seconds, nil when the meter is active). :extra captures any future transitions Stripe adds.

Value-extraction settings for sum/last meters. event_payload_key names the field inside MeterEvent.payload from which Stripe reads the numeric value. Defaults server-side to "value" when omitted in Meter.create/3.

Stripe Billing MeterEvent — hot-path usage reporting. Create-only; Stripe exposes no retrieve/list operations for events. See guides/metering.md for the full AccrueLike.UsageReporter recipe and the two-layer idempotency contract.

Stripe Billing MeterEventAdjustment — correct a previously-reported MeterEvent within Stripe's 24-hour cancellation window. Create-only.

Stripe v2 Billing Meter Event Stream — high-throughput session-token API.

Short-lived session struct returned by MeterEventStream.create_session/2.

Manages Stripe customer portal configurations controlling branding, features, and business info.

Operations on Stripe Billing Portal Session objects.

Optional fluent builders for LatticeStripe.BillingPortal.Session flow_data params.

Fluent builder for a single subscription schedule phase.

A Stripe debit card attached to a Connect connected account (external account).

Stripe Charge objects — the result record of a payment attempt.

Represents a line item in a Checkout Session.

Operations on Stripe Checkout Session objects.

The main entry point for making Stripe API requests.

Client configuration schema and validation.

Operations on Stripe Coupon objects.

Typed representation of a Coupon's applies_to restriction.

Operations on Stripe Credit Note objects.

Represents a line item on a Stripe Credit Note.

Operations on Stripe Customer objects.

Operations on Stripe Dispute objects.

Represents the evidence object nested on a Stripe Dispute.

Represents evidence submission details nested on a Stripe Dispute.

Represents the polymorphic payment method details nested on a Stripe Dispute.

Structured error type for Stripe API errors.

Operations on Stripe Event objects.

Represents a Stripe thin-event notification (/v2/events).

Represents the related_object sub-resource referenced by a Stripe thin-event notification (or a v2-fetched %LatticeStripe.Event{}).

Polymorphic dispatcher for external accounts on a Stripe Connect connected account.

Forward-compatibility fallback for LatticeStripe.ExternalAccount responses whose object is neither "bank_account" nor "card". Preserves the raw payload in :extra so user code does not crash on a new Stripe object type.

Represents a file uploaded to Stripe.

Represents a link to a Stripe file that can be shared outside your account.

Operations on Stripe Invoice objects.

Represents automatic tax calculation settings on a Stripe Invoice.

Represents a line item on a Stripe Invoice.

Tracks lifecycle Unix timestamps for a Stripe Invoice.

Operations on Stripe InvoiceItem objects.

Billing period for an InvoiceItem.

JSON codec behaviour for LatticeStripe.

Represents a paginated list of Stripe objects.

Operations on Stripe Express Login Links — single-use dashboard return URLs for Express connected accounts.

Operations on Stripe Mandate objects.

Represents the customer_acceptance nested object on a Stripe Mandate.

Represents the single_use nested object on a Stripe Mandate.

Operations on Stripe PaymentIntent objects.

Operations on Stripe PaymentMethod objects.

Operations on Stripe Payout objects.

Trace identifier for a Stripe Payout.

Operations on Stripe Price objects.

Typed representation of a Price's recurring nested object.

Typed representation of a single tier in a tiered Price.

Operations on Stripe Product objects.

Operations on Stripe Promotion Code objects.

Operations on Stripe Quote objects.

Bounded computed summary data for a Stripe Quote.

Represents a line item returned by Stripe Quote APIs.

Tracks lifecycle Unix timestamps for a Stripe Quote.

Operations on Stripe Refund objects.

A Stripe API request as pure data.

Wraps a successful Stripe API response with metadata.

Behaviour for controlling retry logic on failed Stripe API requests.

Operations on Stripe SetupAttempt objects.

Represents the historical setup_error nested object on a Stripe SetupAttempt.

Operations on Stripe SetupIntent objects.

Operations on Stripe Subscription objects.

Represents the cancellation_details nested object on a Stripe Subscription.

Represents the pause_collection nested object on a Stripe Subscription.

Represents the trial_settings nested object on a Stripe Subscription.

Operations on Stripe Subscription Item objects.

Operations on Stripe Subscription Schedule objects.

A one-off invoice item to add at the start of a SubscriptionSchedule phase.

The current phase of a Subscription Schedule, or nil if the schedule has not yet started or has completed.

A single phase of a Stripe Subscription Schedule.

A single item inside a SubscriptionSchedule phase.

Calculate tax for custom payment flows via Stripe's standalone Tax Calculations API.

Represents a line item on a Stripe Tax Calculation.

Stripe Tax Registration objects for declaring where you collect tax.

Account-level Stripe Tax configuration singleton.

Record and reverse tax via Stripe's standalone Tax Transactions API.

Represents a line item on a Stripe Tax Transaction.

Operations on Stripe Tax ID objects.

Telemetry integration for LatticeStripe.

Operations on Stripe Test Clock objects.

Test helpers for apps using LatticeStripe.

Public raw-map fixtures for downstream app tests.

Canonical raw fixtures for Stripe CreditNote objects.

Canonical raw fixtures for Stripe Dispute objects.

Canonical raw fixtures for Stripe File objects.

Canonical raw fixtures for Stripe FileLink objects.

Canonical raw fixtures for Stripe Mandate objects.

Canonical raw fixtures for Stripe Quote objects.

Canonical raw fixtures for Stripe SetupAttempt objects.

Canonical raw fixtures for Stripe Tax Calculation objects.

Canonical raw fixtures for Stripe TaxId objects.

Canonical raw fixtures for Stripe Tax Transaction objects.

ExUnit ergonomics for Stripe Test Clocks.

GenServer-backed registry that owns per-test LatticeStripe.Testing.TestClock ids so integration tests can isolate time-travel state.

Exception raised by LatticeStripe.Testing.TestClock when a test-time precondition fails — e.g., advance/2 is called with an unsupported unit (:months, :years on Elixir 1.15), or no client is bound at the call site.

Operations on Stripe Transfer objects — the Connect separate-charge-and-transfer primitive.

Operations on Stripe Transfer Reversal objects — standalone top-level module.

HTTP transport behaviour for LatticeStripe.

Stripe webhook signature verification and event construction.

Behaviour for handling verified Stripe webhook events.

Phoenix Plug for Stripe webhook signature verification and event dispatch.

Exception raised when Stripe webhook signature verification fails.

Mix Tasks

Compares Stripe's published OpenAPI specification against LatticeStripe's @known_fields module attributes and reports any drift.

Mix task backstop for cleaning up leaked test clocks.