PaperTiger.Resources.Subscription (PaperTiger v0.9.20)

Handles Subscription resource endpoints.

Endpoints

POST /v1/subscriptions - Create subscription
GET /v1/subscriptions/:id - Retrieve subscription
POST /v1/subscriptions/:id - Update subscription
DELETE /v1/subscriptions/:id - Cancel subscription
GET /v1/subscriptions - List subscriptions

Subscription Object

%{
  id: "sub_...",
  object: "subscription",
  created: 1234567890,
  status: "active",
  customer: "cus_...",
  items: %{
    data: [%{id: "si_...", price: %{id: "price_...", object: "price", ...}, quantity: 1}]
  },
  current_period_start: 1234567890,
  current_period_end: 1237159890,
  # ... other fields
}

Subscription Statuses

active - Subscription is active
trialing - In trial period
past_due - Payment failed
canceled - Canceled
unpaid - Unpaid and canceled
incomplete - Incomplete (needs payment)
incomplete_expired - Incomplete and expired

Summary

Functions

cancel(conn, id)

Cancels a subscription immediately.

create(conn)

Creates a new subscription.

delete(conn, id)

Cancels a subscription.

list(conn)

Lists all subscriptions with pagination.

retrieve(conn, id)

Retrieves a subscription by ID.

update(conn, id)

Updates a subscription.

Functions

cancel(conn, id)

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

Cancels a subscription immediately.

POST /v1/subscriptions/:id/cancel

Cancels the subscription right away without waiting for the current period to end.

create(conn)

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

Creates a new subscription.

Required Parameters

customer - Customer ID
items - Array of subscription items (each with price and quantity)

Optional Parameters

id - Custom ID (must start with "sub_"). Useful for seeding deterministic data.
default_payment_method - Payment method ID
trial_period_days - Days of trial period
metadata - Key-value metadata
billing_cycle_anchor - Anchor for billing cycle
cancel_at_period_end - Cancel at end of current period