| You send | You get |
|---|---|
Api-Version-Date: 2026-06-09 | The API as it worked on that date |
| No header | The original 2025-01-01 behavior |
| An unknown date | A 400 error with the supported versions |
If you don’t pass an
Api-Version-Date, the stable API model is used. Requests without the header are served by the pre-versioning behavior, so existing integrations keep working unchanged. Pin a dated version to opt into the latest API.Changelog
Business referral earnings now identify the polymorphic resource that generated the earning.
receiptis replaced byresource.access_passis replaced byproduct.- Receipt-backed earnings return
resource.object: "receipt"with receipt payment details. - The
resourcefield can support additional earning resources in future versions without reusing receipt-specific fields. - Older pinned versions continue to return
receiptandaccess_pass.
Business referral volume and earnings are now reported as reconciling groups.
processing_volume,total_earnings,pending_payout, andcompleted_payoutare replaced by nestedvolume_usdandearnings_usdobjects.- Earnings rename
base_amount/amounttotransaction_amount_usd/commission_amount_usdand expresspayout_percentageas a fraction. - Older pinned versions continue to return the previous flat shape.
Plans now use the Account model consistently.
- Request parameters and request bodies use
account_idinstead ofcompany_id. - Plan responses return
accountinstead ofcompany. - Older pinned versions continue to accept
company_idand returncompany.
User access requests now use the Account model consistently.
- Request parameters and request bodies use
account_idinstead ofcompany_id. - Response shapes are unchanged.
- Older pinned versions continue to accept
company_id.
The original Experimental API behavior before dated versioning existed.Requests without
Api-Version-Date use this version so existing integrations keep working.
