Transaction

Server

List transactions

GET

http://api.community-management.test/api

/transactions

Paginated, filterable, and sortable transaction ledger for reporting and managed-API-key consumers. Every row is scoped to the current tenant.

List transactions › query Parameters

filter[range]

string

Filter to transactions whose effective date falls between two dates. Pass as comma-separated start,end (or an array): filter[range]=2025-01-01,2025-01-31.

filter[starting_at]

string

Filter to transactions with an effective date on or after this date.

filter[ending_at]

string

Filter to transactions with an effective date on or before this date (end of day).

filter[type]

string

Filter by transaction type. Supports comma-separated values. Options: membership, program, charge, invoice, donation, booking, refund, transfer. Each option (other than refund) matches both the charge and its refund type.

filter[query]

string

Search transactions by related user/guest/account name or email, or by program signup id (subscription schedule lookup).

filter[membership_type_id]

integer

Filter to transactions for the given membership type (plan product) id.

filter[amount]

string

Filter by amount in dollars. Pass a bare value for an exact match, or prefix with lte: / gte: for a range bound.

filter[id]

string

Filter by exact transaction id. Supports comma-separated values.

filter[payout_id]

string

Filter by exact payout id.

filter[subscription_schedule_id]

integer

Filter by the local subscription schedule id (transactions.subscription_schedule_id). This is not the Stripe sub_sched_... id, which lives on subscription_schedules.stripe_schedule_id.

filter[user_id]

integer

Filter by exact owning user id.

filter[promotion_code_id]

integer

Filter by exact promotion code id.

filter[tags]

string

Filter by tag name(s). Supports comma-separated values.

filter[with_product]

integer

Filter to transactions associated with the given product (membership/plan) id. Takes a product id, not a boolean — it matches both transaction line items and invoice items for that product.

filter[with_parent_program]

string

Filter to transactions associated with the given parent program id(s), including the refunds of those charges. Takes parent program id(s), not a boolean. Supports comma-separated values.

include

string

Include related resources (comma-separated). Only these two options visibly change the response; every other loadable relation is already eager-loaded and always present. Options: tags (adds the tags field), invoice.bookings.bookableEntity (populates bookable_entity inside invoice.bookings).

sort

string

Sort by effective date (falls back to created_at). Options: -created_at (descending) or created_at (ascending).

page[number]

integer

Page number for pagination.

page[size]

integer

Number of results per page.

List transactions › Headers

X-Api-Version

string

Optional API version for this request. When omitted, the server uses the default version. This documentation describes version 2026-08-25.

List transactions › Responses

Paginated set of TransactionResource

TransactionResource[] · required

current_page

integer · min: 1 · required

from

integer | null · min: 1 · required

last_page

integer · min: 1 · required

per_page

integer · min: 1 · required

to

integer | null · min: 1 · required

total

integer · min: 0 · required

GET/transactions

curl http://api.community-management.test/api/transactions \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "id": 1042,
      "amount": 5000,
      "original_amount": 5000,
      "discount_amount": 0,
      "tax_amount": 0,
      "fees": 175,
      "currency": "usd",
      "type": 1,
      "transaction_id": "ch_1AbCdEfGhIjKlMnO",
      "associated_transaction_id": "ch_1AbCdEfGhIjKlMnO",
      "refund_id": "re_1AbCdEfGhIjKlMnO",
      "payment_refund_id": "pyr_1AbCdEfGhIjKlMnO",
      "dispute_transaction_id": "ch_1AbCdEfGhIjKlMnO",
      "payment_method": "card",
      "credit_card": "Visa",
      "metadata": {
        "description": "Membership renewal",
        "cheque_number": "42"
      },
      "created_at": "2026-01-15T18:32:00.000000Z",
      "effective_at": "2026-01-15T18:32:00.000000Z",
      "readable_type": "Charge",
      "readable_created_at": "Jan 15, 2026",
      "item_summary": "Membership for Adult (Monthly)",
      "net_amount": 4825,
      "net_fees": 175,
      "remaining_to_refund": 5000,
      "has_dispute": false,
      "associated_bookings": [
        42
      ],
      "associated_booking_requests": [],
      "owner": {
        "id": 7,
        "user_id": 7,
        "email": "member@example.com",
        "name": "Jane Doe"
      },
      "invoice": {
        "id": 12,
        "stripe_invoice_number": "INV-0012",
        "exposed_invoice_number": "INV-0012",
        "provenance": "stripe",
        "uuid": "9c1b3f2a-...",
        "bookings": [
          {
            "id": 42,
            "starting_at": "2026-01-15T18:00:00.000000Z",
            "readable_start_time": "6:00 PM",
            "bookable_entity": {
              "name": "Court 1"
            }
          }
        ]
      },
      "associated_transaction": {
        "id": 9,
        "invoice": {
          "id": 12,
          "stripe_invoice_number": "INV-0012",
          "exposed_invoice_number": "INV-0012",
          "provenance": "stripe",
          "uuid": "9c1b3f2a-...",
          "bookings": [
            {
              "id": 42,
              "starting_at": "2026-01-15T18:00:00.000000Z",
              "readable_start_time": "6:00 PM"
            }
          ]
        }
      },
      "promotion_code": {
        "id": 3,
        "name": "SUMMER10",
        "coupon": {
          "id": 5,
          "name": "10% Off",
          "percent_off": 10,
          "amount_off": null
        }
      },
      "tags": [
        {
          "id": 1,
          "name": "Offline",
          "is_system": true
        }
      ],
      "transaction_line_items": [
        {
          "id": 88,
          "quantity": 1,
          "item_name": "Adult Registration",
          "amount": 5000,
          "tax_amount": 0,
          "transaction_line_itemable": {
            "id": 4,
            "name": "Youth Basketball"
          }
        }
      ]
    }
  ],
  "current_page": 1,
  "from": 1,
  "last_page": 1,
  "per_page": 1,
  "to": 1,
  "total": 0
}

json

application/json

Get a transaction

GET

http://api.community-management.test/api

/transactions/{transaction}

Returns a single transaction, scoped to the current tenant. Relations are always eager-loaded to match the fields the resource can return (e.g. invoice, associated_transaction, promotion_code); unlike the index endpoint, this endpoint does not accept include or append. The tags field is only ever populated via include=tags on the index endpoint, so it is never present in this response.

Get a transaction › path Parameters

transaction

string · required

Get a transaction › Headers

X-Api-Version

string

Optional API version for this request. When omitted, the server uses the default version. This documentation describes version 2026-08-25.

Get a transaction › Responses

TransactionResource

TransactionResource · required

GET/transactions/{transaction}

curl http://api.community-management.test/api/transactions/:transaction \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": {
    "id": 1042,
    "amount": 5000,
    "original_amount": 5000,
    "discount_amount": 0,
    "tax_amount": 0,
    "fees": 175,
    "currency": "usd",
    "type": 1,
    "transaction_id": "ch_1AbCdEfGhIjKlMnO",
    "associated_transaction_id": "ch_1AbCdEfGhIjKlMnO",
    "refund_id": "re_1AbCdEfGhIjKlMnO",
    "payment_refund_id": "pyr_1AbCdEfGhIjKlMnO",
    "dispute_transaction_id": "ch_1AbCdEfGhIjKlMnO",
    "payment_method": "card",
    "credit_card": "Visa",
    "metadata": {
      "description": "Membership renewal",
      "cheque_number": "42"
    },
    "created_at": "2026-01-15T18:32:00.000000Z",
    "effective_at": "2026-01-15T18:32:00.000000Z",
    "readable_type": "Charge",
    "readable_created_at": "Jan 15, 2026",
    "item_summary": "Membership for Adult (Monthly)",
    "net_amount": 4825,
    "net_fees": 175,
    "remaining_to_refund": 5000,
    "has_dispute": false,
    "associated_bookings": [
      42
    ],
    "associated_booking_requests": [],
    "owner": {
      "id": 7,
      "user_id": 7,
      "email": "member@example.com",
      "name": "Jane Doe"
    },
    "invoice": {
      "id": 12,
      "stripe_invoice_number": "INV-0012",
      "exposed_invoice_number": "INV-0012",
      "provenance": "stripe",
      "uuid": "9c1b3f2a-...",
      "bookings": [
        {
          "id": 42,
          "starting_at": "2026-01-15T18:00:00.000000Z",
          "readable_start_time": "6:00 PM",
          "bookable_entity": {
            "name": "Court 1"
          }
        }
      ]
    },
    "associated_transaction": {
      "id": 9,
      "invoice": {
        "id": 12,
        "stripe_invoice_number": "INV-0012",
        "exposed_invoice_number": "INV-0012",
        "provenance": "stripe",
        "uuid": "9c1b3f2a-...",
        "bookings": [
          {
            "id": 42,
            "starting_at": "2026-01-15T18:00:00.000000Z",
            "readable_start_time": "6:00 PM"
          }
        ]
      }
    },
    "promotion_code": {
      "id": 3,
      "name": "SUMMER10",
      "coupon": {
        "id": 5,
        "name": "10% Off",
        "percent_off": 10,
        "amount_off": null
      }
    },
    "tags": [
      {
        "id": 1,
        "name": "Offline",
        "is_system": true
      }
    ],
    "transaction_line_items": [
      {
        "id": 88,
        "quantity": 1,
        "item_name": "Adult Registration",
        "amount": 5000,
        "tax_amount": 0,
        "transaction_line_itemable": {
          "id": 4,
          "name": "Youth Basketball"
        }
      }
    ]
  }
}

json

application/json

User Membership Activity

List transactions

GET

http://api.community-management.test/api

/transactions

Paginated, filterable, and sortable transaction ledger for reporting and managed-API-key consumers. Every row is scoped to the current tenant.

List transactions › query Parameters

filter[range]

string

Filter to transactions whose effective date falls between two dates. Pass as comma-separated start,end (or an array): filter[range]=2025-01-01,2025-01-31.

filter[starting_at]

string

Filter to transactions with an effective date on or after this date.

filter[ending_at]

string

Filter to transactions with an effective date on or before this date (end of day).

filter[type]

string

filter[query]

string

Search transactions by related user/guest/account name or email, or by program signup id (subscription schedule lookup).

filter[membership_type_id]

integer

Filter to transactions for the given membership type (plan product) id.

filter[amount]

string

Filter by amount in dollars. Pass a bare value for an exact match, or prefix with lte: / gte: for a range bound.

filter[id]

string

Filter by exact transaction id. Supports comma-separated values.

filter[payout_id]

string

Filter by exact payout id.

filter[subscription_schedule_id]

integer

Filter by the local subscription schedule id (transactions.subscription_schedule_id). This is not the Stripe sub_sched_... id, which lives on subscription_schedules.stripe_schedule_id.

filter[user_id]

integer

Filter by exact owning user id.

filter[promotion_code_id]

integer

Filter by exact promotion code id.

filter[tags]

string

Filter by tag name(s). Supports comma-separated values.

filter[with_product]

integer

Filter to transactions associated with the given product (membership/plan) id. Takes a product id, not a boolean — it matches both transaction line items and invoice items for that product.

filter[with_parent_program]

string

Filter to transactions associated with the given parent program id(s), including the refunds of those charges. Takes parent program id(s), not a boolean. Supports comma-separated values.

include

string

sort

string

Sort by effective date (falls back to created_at). Options: -created_at (descending) or created_at (ascending).

page[number]

integer

Page number for pagination.

page[size]

integer

Number of results per page.

List transactions › Headers

X-Api-Version

string

Optional API version for this request. When omitted, the server uses the default version. This documentation describes version 2026-08-25.

List transactions › Responses

Paginated set of TransactionResource

TransactionResource[] · required

current_page

integer · min: 1 · required

from

integer | null · min: 1 · required

last_page

integer · min: 1 · required

per_page

integer · min: 1 · required

to

integer | null · min: 1 · required

total

integer · min: 0 · required

Get a transaction

GET

http://api.community-management.test/api

/transactions/{transaction}

Get a transaction › path Parameters

transaction

string · required

Get a transaction › Headers

X-Api-Version

string

Optional API version for this request. When omitted, the server uses the default version. This documentation describes version 2026-08-25.

Get a transaction › Responses

TransactionResource

TransactionResource · required