Skip to content

Coach API docs: Connect billing reads list every field they return - #62

Merged
DrAlexHarrison merged 1 commit into
mainfrom
billfields
Oct 5, 2026
Merged

DrAlexHarrison merged 1 commit into
mainfrom
billfields

Conversation

@DrAlexHarrison

Copy link
Copy Markdown
Member

The Coach API's Connect billing reads return fields the guide never mentioned, so a coach integrating them could not tell a partly refunded charge from a fully refunded one, or who paid Stripe's fee.

  • Connect transactions: the example gains a partly refunded charge; refund_amount_cents, stripe_fee_paid_by (coach or saturday) and platform_fee_returned_cents are explained, with when each is left out.
  • Connect earnings: the summary gains total_refunded_cents, total_platform_fee_returned_cents, total_disputes_cents, total_dispute_costs_recovered_cents; each breakdown gains stripe_fee_paid_by, refunded_cents, platform_fee_returned_cents, disputes_cents, dispute_costs_recovered_cents, and how the net is computed.
  • Connect summary: the fee terms every summary carries (platform_fee_minimum_cents, coach_pays_stripe_fees_from, stripe_fee_domestic_bps, stripe_fee_international_bps, stripe_fee_fixed_cents).
  • The ledger and transactions next_cursor examples use the timestamp|id form the API returns.

Fields diffed against the Go JSON tags of connect.ConnectCharge, connect.ChargeBreakdown, connect.CoachEarningsSummary and connect.DashboardSummary on fuel-backend main 26ee95de. The SDK types follow in saturday-node and saturday-python (branch billfields).

Checks run: scripts/check-docs-drift.py (clean), scripts/test-response-examples.py (passed).

🤖 Generated with Claude Code

The transactions example gains a partly refunded charge, with refund_amount_cents,
stripe_fee_paid_by and platform_fee_returned_cents explained. The earnings summary and
breakdowns gain the refund, returned-fee and dispute fields, and the Connect summary its fee
terms (minimum platform fee, when coaches start paying Stripe's fee, Stripe's rates). The
ledger and transactions next_cursor examples take the timestamp|id form the API returns.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

Ci-From: linux
Ci-Session: 558b5692-58d2-410d-98ee-4771e5b99c97
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant