PaperTiger.Resources.PaymentMethod (PaperTiger v1.0.2)

Handles PaymentMethod resource endpoints.

Endpoints

POST /v1/payment_methods - Create payment method
GET /v1/payment_methods/:id - Retrieve payment method
POST /v1/payment_methods/:id - Update payment method
DELETE /v1/payment_methods/:id - Delete payment method
GET /v1/payment_methods - List payment methods

PaymentMethod Object

%{
  id: "pm_...",
  object: "payment_method",
  created: 1234567890,
  type: "card",
  customer: "cus_...",
  metadata: %{},
  card: %{
    brand: "visa",
    last4: "4242",
    exp_month: 12,
    exp_year: 2025
  },
  billing_details: %{
    name: "John Doe",
    email: "john@example.com",
    phone: "+1234567890",
    address: %{
      country: "US",
      postal_code: "12345",
      state: "CA",
      city: "San Francisco",
      line1: "123 Main St",
      line2: nil
    }
  }
}

Summary

Functions

attach(conn, id)

Attaches a payment method to a customer.

create(conn)

Creates a new payment method.

delete(conn, id)

Deletes a payment method.

detach(conn, id)

Detaches a payment method from a customer.

list(conn)

Lists payment methods for a customer.

retrieve(conn, id)

Retrieves a payment method by ID.

update(conn, id)

Updates a payment method.

Functions

attach(conn, id)

@spec attach(Plug.Conn.t(), String.t()) :: Plug.Conn.t()

Attaches a payment method to a customer.

POST /v1/payment_methods/:id/attach

Associates a payment method with a customer ID.

create(conn)

@spec create(Plug.Conn.t()) :: Plug.Conn.t()

Creates a new payment method.

Required Parameters

type - Payment method type ("card", "us_bank_account", etc.)

Optional Parameters

id - Custom ID (must start with "pm_"). Useful for seeding deterministic data.
customer - Customer ID to associate with
metadata - Key-value metadata
card - Card details (when type=card)
billing_details - Billing address and contact info

delete(conn, id)

@spec delete(Plug.Conn.t(), String.t()) :: Plug.Conn.t()

Deletes a payment method.

Returns a deletion confirmation object.

detach(conn, id)

@spec detach(Plug.Conn.t(), String.t()) :: Plug.Conn.t()

Detaches a payment method from a customer.

POST /v1/payment_methods/:id/detach

Removes the association between a payment method and a customer.