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
Members and memberships now use native resources with an account-oriented membership model and redesigned lifecycle actions.
- Membership responses return
plan_idandproduct_idinstead of nestedplanandproductobjects. - Listing memberships returns everything the caller can read — their own plus their managed accounts’ — and
account_id/user_idnarrow that list instead of switching modes or erroring. - Set
cancel_at_period_endto schedule cancellation; thecancelaction ends access immediately. - The
extendaction replacesadd_free_days.
REST response and timestamp consistency
The Experimental API now uses consistent delete responses, timestamp inputs, and Account naming.
- Delete endpoints for products, plans, checkout configurations, ads, ad groups, ad campaigns, social accounts, and bounty submissions return
{ id, deleted: true }instead of a bare boolean. - Timestamp filters on products, plans, checkout configurations, transfers, and financial reports accept ISO 8601 only instead of also accepting epoch seconds.
- Product responses return
accountinstead ofcompany.
Partner business payout percentages
Partner businesses now expose separate payout rates for every income source.
payout_percentageis replaced bypayout_percentages.- The nested object includes
sales,ad_spend,transfer, andcard_interchangerates.
Products and checkout configurations
Products and checkout configurations now use the Account model consistently.
- Product request parameters use
account_idinstead ofcompany_id. - Checkout configuration requests use
account_idat the top level and inside inlineplanobjects. - Checkout configuration responses return
account_idinstead ofcompany_id.
Checkout configuration timestamps
Checkout configuration timestamps now use the same format as the rest of the API.
created_atandupdated_atare ISO 8601 strings instead of Unix epoch integers.
User balances
User balances now provide a complete, structured balance summary.
- The flat
total_usdandbalancesfields are replaced by a nestedbalanceobject. - The summary separates cash, crypto, in-flight treasury deposits, and balances for accounts the user owns.
Business referral earnings resources
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.
Business referrals resource
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.
Plans resource
Plans now use the Account model consistently.
- Request parameters and request bodies use
account_idinstead ofcompany_id. - Plan responses return
accountinstead ofcompany.
Users resource
User access requests now use the Account model consistently.
- Request parameters and request bodies use
account_idinstead ofcompany_id. - Response shapes are unchanged.
Original version
The original Experimental API behavior before dated versioning existed.Requests without
Api-Version-Date use this version so existing integrations keep working.
