Me API
The Me operations of the BuildBase HTTP API: method, path, sign-in, request fields, answers and errors for each.
182 operations, 0 fully described.
| Method | Path | What it does |
|---|---|---|
| DELETE | /api/v1/public/me | Delete the signed-in user's account, now or after the org's grace period |
| GET | /api/v1/public/me/access | Check whether the signed-in user may use one app resource now |
| GET | /api/v1/public/me/affiliate-invitations | List the signed-in user's pending invitations to affiliate programs |
| POST | /api/v1/public/me/affiliate-invitations/{id}/accept | Accept an invitation and join the seller's affiliate program |
| POST | /api/v1/public/me/affiliate-invitations/{id}/decline | Decline an invitation to a seller's affiliate program |
| GET | /api/v1/public/me/affiliate-programs | List the affiliate programs the signed-in user runs as a seller |
| POST | /api/v1/public/me/affiliate-programs | Create an affiliate program on the signed-in seller's own items |
| POST | /api/v1/public/me/affiliate-programs/affiliates/{id}/approve | Approve a pending affiliate in one of the signed-in seller's programs |
| POST | /api/v1/public/me/affiliate-programs/affiliates/{id}/ban | Ban an affiliate from one of the signed-in seller's programs |
| POST | /api/v1/public/me/affiliate-programs/affiliates/{id}/pause | Pause an active affiliate in one of the signed-in seller's programs |
| POST | /api/v1/public/me/affiliate-programs/affiliates/{id}/resume | Resume a paused affiliate in one of the signed-in seller's programs |
| GET | /api/v1/public/me/affiliate-programs/payouts/wise.csv | Download the signed-in seller's pending Wise payouts as a CSV file |
| POST | /api/v1/public/me/affiliate-programs/payouts/{id}/mark-paid | Mark a manual or Wise payout of the signed-in seller's program paid |
| GET | /api/v1/public/me/affiliate-programs/payouts/{id}/wise.csv | Download one of the signed-in seller's Wise payouts as a CSV file |
| GET | /api/v1/public/me/affiliate-programs/{id} | Get one of the signed-in seller's affiliate programs |
| PATCH | /api/v1/public/me/affiliate-programs/{id} | Update the terms of one of the signed-in seller's affiliate programs |
| DELETE | /api/v1/public/me/affiliate-programs/{id} | Delete one of the signed-in seller's affiliate programs |
| GET | /api/v1/public/me/affiliate-programs/{id}/affiliates | List the affiliates of one of the signed-in seller's programs |
| POST | /api/v1/public/me/affiliate-programs/{id}/affiliates | Add a person to a program directly (refused for sellers) |
| GET | /api/v1/public/me/affiliate-programs/{id}/commissions | List the commissions earned in one of the signed-in seller's programs |
| POST | /api/v1/public/me/affiliate-programs/{id}/invitations | Invite a person by email or user id to the signed-in seller's program |
| GET | /api/v1/public/me/affiliate-programs/{id}/payouts | List the payouts of one of the signed-in seller's programs |
| GET | /api/v1/public/me/affiliates | List the affiliate programs the signed-in user has joined |
| POST | /api/v1/public/me/affiliates | Join an affiliate program as the signed-in user |
| GET | /api/v1/public/me/affiliates/commissions | List the signed-in user's affiliate commissions |
| POST | /api/v1/public/me/affiliates/payout-account | Start a Stripe onboarding session for the signed-in affiliate's payouts |
| POST | /api/v1/public/me/affiliates/payout-account/sync | Refresh the status of the signed-in affiliate's Stripe payout account |
| GET | /api/v1/public/me/affiliates/payouts | List the signed-in user's affiliate payouts |
| GET | /api/v1/public/me/affiliates/{id} | Get one of the signed-in user's affiliate rows |
| PUT | /api/v1/public/me/affiliates/{id}/code | Change the signed-in user's referral code in one program |
| PUT | /api/v1/public/me/affiliates/{id}/contact-consent | Share or stop sharing the signed-in user's email with a program's seller |
| PUT | /api/v1/public/me/affiliates/{id}/payout-method | Choose how one program pays the signed-in affiliate |
| POST | /api/v1/public/me/billing/add-ons/{grantId}/cancel | Remove a recurring add-on from the signed-in user's own subscription |
| POST | /api/v1/public/me/billing/add-ons/{grantId}/cancel/preview | Preview removing a recurring add-on from the signed-in user's subscription |
| POST | /api/v1/public/me/billing/add-ons/{grantId}/decrease | Lower the quantity of a recurring add-on on the signed-in user's subscription |
| POST | /api/v1/public/me/billing/add-ons/{grantId}/decrease/preview | Preview lowering the quantity of a recurring add-on the signed-in user holds |
| POST | /api/v1/public/me/billing/add-ons/{grantId}/future-versions | Opt a lifetime add-on the signed-in user holds out of later versions, or back in |
| GET | /api/v1/public/me/billing/add-ons/{grantId}/upgrade | Quote upgrading a one-time or lifetime add-on to its offer's current version |
| POST | /api/v1/public/me/billing/add-ons/{grantId}/upgrade | Buy the upgrade of an add-on the signed-in user holds to its current version |
| POST | /api/v1/public/me/billing/checkout | Buy an add-on offer for the signed-in user |
| POST | /api/v1/public/me/billing/checkout/preview | Preview the cost of a recurring add-on on the user's own subscription |
| GET | /api/v1/public/me/billing/offers | List the add-on offers the signed-in user can buy, with what they hold |
| POST | /api/v1/public/me/billing/payment-method/default | Make a confirmed card the signed-in user's default payment method |
| POST | /api/v1/public/me/billing/payment-method/setup | Start a card setup on the signed-in user's own Stripe customer |
| GET | /api/v1/public/me/bookings | List the signed-in user's bookings, soonest first |
| GET | /api/v1/public/me/bookings/{id} | Get one of the signed-in user's bookings |
| GET | /api/v1/public/me/bookings/{id}/calendar.ics | Download one of the signed-in user's bookings as a calendar file |
| POST | /api/v1/public/me/bookings/{id}/cancel | Cancel one of the signed-in user's bookings |
| POST | /api/v1/public/me/bookings/{id}/reschedule | Move one of the signed-in user's bookings to another slot |
| GET | /api/v1/public/me/calendars | List the signed-in user's shared booking calendars as a seller |
| POST | /api/v1/public/me/calendars | Create a shared booking calendar for the signed-in user as a seller |
| GET | /api/v1/public/me/calendars/{id} | Get one of the signed-in user's shared booking calendars |
| PUT | /api/v1/public/me/calendars/{id} | Replace the name, grid and settings of one of the user's calendars |
| DELETE | /api/v1/public/me/calendars/{id} | Delete one of the signed-in user's shared booking calendars |
| GET | /api/v1/public/me/carts/{cartId} | Get a cart the signed-in user checked out, with its orders |
| POST | /api/v1/public/me/carts/{cartId}/next | Open the next payment step of the signed-in user's storefront cart |
| GET | /api/v1/public/me/coupons | List the signed-in user's coupons as a seller |
| POST | /api/v1/public/me/coupons | Create a coupon for the signed-in user's own items |
| GET | /api/v1/public/me/coupons/{id} | Get one of the signed-in user's coupons |
| PATCH | /api/v1/public/me/coupons/{id} | Update the terms of one of the signed-in user's coupons |
| DELETE | /api/v1/public/me/coupons/{id} | Delete one of the signed-in user's coupons |
| GET | /api/v1/public/me/credits | Get the signed-in user's own credit balance |
| GET | /api/v1/public/me/credits/auto-top-up | Get the automatic top-up setting of the user's own credit wallet |
| PATCH | /api/v1/public/me/credits/auto-top-up | Change the automatic top-up setting of the user's own credit wallet |
| GET | /api/v1/public/me/credits/buckets | List the credit buckets in the user's own wallet, newest first |
| POST | /api/v1/public/me/credits/consume | Spend credits from the signed-in user's own wallet |
| GET | /api/v1/public/me/credits/expiring | List the user's own credits that expire within a number of days |
| GET | /api/v1/public/me/credits/holds | List the credit holds on the signed-in user's own wallet |
| POST | /api/v1/public/me/credits/holds/{holdId}/release | Release a credit hold on the user's own wallet, returning its credits |
| POST | /api/v1/public/me/credits/holds/{holdId}/settle | Settle a credit hold on the user's own wallet for the real cost |
| GET | /api/v1/public/me/credits/packages | List the credit packs on sale, in the order the app set |
| POST | /api/v1/public/me/credits/payment-method-setup | Open a Stripe page that saves a card for the user's automatic top-up |
| POST | /api/v1/public/me/credits/purchase | Start a Stripe checkout to buy a credit pack for the signed-in user |
| POST | /api/v1/public/me/credits/reserve | Put credits from the user's own wallet on hold for work not yet costed |
| GET | /api/v1/public/me/credits/transactions | List the credit transactions on the user's own wallet, newest first |
| GET | /api/v1/public/me/deletion | Preview what deleting the signed-in user's account would forfeit |
| POST | /api/v1/public/me/entitlements/check | Check one entitlement slug against the user and their workspaces |
| GET | /api/v1/public/me/files | List the signed-in seller's files for buyers, newest first |
| POST | /api/v1/public/me/files/uploads | Start an upload of one file for buyers as the signed-in seller |
| POST | /api/v1/public/me/files/uploads/{uploadId}/complete | Finish a seller's file upload and record the file |
| GET | /api/v1/public/me/files/{fileId} | Get one of the signed-in seller's files and the releases that hold it |
| DELETE | /api/v1/public/me/files/{fileId} | Delete one of the signed-in seller's files that no release holds |
| GET | /api/v1/public/me/grants | List what the signed-in user holds beyond their plan |
| GET | /api/v1/public/me/holdings | List the signed-in user's holdings from purchases, newest first |
| POST | /api/v1/public/me/holdings/{id}/deactivate | Remove one activation from a license key the signed-in user holds |
| POST | /api/v1/public/me/holdings/{id}/downloads | Get a short-lived download link for one file of a holding |
| GET | /api/v1/public/me/item-subscriptions | List the subscriptions the signed-in user holds from items they bought |
| GET | /api/v1/public/me/item-subscriptions/{id} | Get one item subscription the signed-in user holds |
| POST | /api/v1/public/me/item-subscriptions/{id}/cancel | Cancel an item subscription the signed-in user holds at the period end |
| POST | /api/v1/public/me/item-subscriptions/{id}/change | Move an item subscription the signed-in user holds to another tier |
| GET | /api/v1/public/me/item-subscriptions/{id}/change-preview | Preview moving an item subscription the signed-in user holds to another tier |
| POST | /api/v1/public/me/item-subscriptions/{id}/resume | Undo the cancel of an item subscription the signed-in user holds |
| GET | /api/v1/public/me/items | List the items the signed-in user sells, most recently updated first |
| POST | /api/v1/public/me/items | Create an item the signed-in user sells, as a draft |
| GET | /api/v1/public/me/items/{id} | Get one item the signed-in user sells |
| PUT | /api/v1/public/me/items/{id} | Save the whole content of an item the signed-in user sells |
| DELETE | /api/v1/public/me/items/{id} | Delete a never-listed item the signed-in user sells |
| POST | /api/v1/public/me/items/{id}/archive | Archive an item the signed-in user sells |
| POST | /api/v1/public/me/items/{id}/booking/calendar-move | Move an item's bookings onto another of the signed-in user's calendars |
| POST | /api/v1/public/me/items/{id}/booking/calendar-move/preview | Preview moving an item's bookings onto another of the user's calendars |
| POST | /api/v1/public/me/items/{id}/publish | Publish an item the signed-in user sells |
| POST | /api/v1/public/me/items/{id}/unlist | Unlist an item the signed-in user sells |
| GET | /api/v1/public/me/limits/{slug} | Get one of the signed-in user's limits and how much is claimed |
| POST | /api/v1/public/me/limits/{slug}/claim | Claim a resource against one of the signed-in user's limits |
| GET | /api/v1/public/me/limits/{slug}/claims | List the signed-in user's claims on one limit |
| POST | /api/v1/public/me/limits/{slug}/release | Release a claimed resource from one of the signed-in user's limits |
| GET | /api/v1/public/me/orders | List the signed-in user's orders as a buyer |
| GET | /api/v1/public/me/orders/{id} | Get one of the signed-in user's orders as a buyer |
| POST | /api/v1/public/me/orders/{id}/parts/{index}/pay | Pay one part of the signed-in user's order sold in parts |
| GET | /api/v1/public/me/orders/{id}/returns | List the returns of one of the signed-in user's orders |
| POST | /api/v1/public/me/orders/{id}/returns | Ask to return units of one of the signed-in user's orders |
| GET | /api/v1/public/me/quotas/{slug} | Get one of the signed-in user's quotas and its usage this period |
| PATCH | /api/v1/public/me/quotas/{slug} | Set the signed-in user's spend cap and alert thresholds on a quota |
| GET | /api/v1/public/me/releases | List the signed-in seller's releases |
| POST | /api/v1/public/me/releases | Create a draft release in a series as the signed-in seller |
| GET | /api/v1/public/me/releases/{id} | Get one of the signed-in seller's releases with its files |
| PATCH | /api/v1/public/me/releases/{id} | Update one of the signed-in seller's releases |
| DELETE | /api/v1/public/me/releases/{id} | Delete one of the signed-in seller's draft releases |
| POST | /api/v1/public/me/releases/{id}/publish | Publish one of the signed-in seller's draft releases |
| GET | /api/v1/public/me/sales | List the orders of items the signed-in user sells, a page at a time |
| GET | /api/v1/public/me/sales/bookings | List the bookings made on items the signed-in user sells |
| GET | /api/v1/public/me/sales/bookings/{id} | Get one booking made on an item the signed-in user sells |
| PUT | /api/v1/public/me/sales/bookings/{id}/attendance | Mark whether the buyer came to a booking on the user's item |
| POST | /api/v1/public/me/sales/bookings/{id}/cancel | Cancel a booking on an item the signed-in user sells |
| POST | /api/v1/public/me/sales/bookings/{id}/reschedule | Move a booking on the user's item to another slot |
| GET | /api/v1/public/me/sales/export | Download the signed-in user's paid sales as a CSV file |
| GET | /api/v1/public/me/sales/subscriptions | List the subscriptions sold by the signed-in user, a page at a time |
| GET | /api/v1/public/me/sales/subscriptions/{id} | Get one subscription the signed-in user sold |
| POST | /api/v1/public/me/sales/subscriptions/{id}/cancel | Cancel a subscription the signed-in user sold |
| GET | /api/v1/public/me/sales/{id} | Get one order of an item the signed-in user sells |
| POST | /api/v1/public/me/sales/{id}/lines/{lineKey}/fulfil | Mark a line of the user's sale in progress or fulfilled |
| POST | /api/v1/public/me/sales/{id}/parts/{index}/charge | Charge the balance of a deposit order the signed-in user sold |
| POST | /api/v1/public/me/sales/{id}/refund | Refund all or part of an order the signed-in user sold |
| GET | /api/v1/public/me/sales/{id}/returns | List the returns of an order the signed-in user sold |
| POST | /api/v1/public/me/sales/{id}/returns/{returnId}/approve | Approve a return on an order the signed-in user sold |
| POST | /api/v1/public/me/sales/{id}/returns/{returnId}/refund | Refund a return on an order the signed-in user sold |
| POST | /api/v1/public/me/sales/{id}/returns/{returnId}/reject | Reject a return on an order the signed-in user sold |
| GET | /api/v1/public/me/sales/{id}/shipments | List the shipments of an order the signed-in user sold |
| POST | /api/v1/public/me/sales/{id}/shipments | Ship units of an order the signed-in user sold |
| GET | /api/v1/public/me/sales/{id}/shipments/{shipmentId}/label | Download the label of a shipment on an order the signed-in user sold |
| POST | /api/v1/public/me/sales/{id}/shipments/{shipmentId}/status | Set the status of a shipment on an order the signed-in user sold |
| GET | /api/v1/public/me/selling | Get the signed-in user's seller account and the app's selling settings |
| POST | /api/v1/public/me/selling | Start selling as the signed-in user |
| GET | /api/v1/public/me/selling/co-sellers | List co-seller invitations the user's seller account received or sent |
| POST | /api/v1/public/me/selling/co-sellers | Invite another seller to share the sales of one of the user's items |
| POST | /api/v1/public/me/selling/co-sellers/{invitationId}/accept | Accept a co-seller invitation sent to the signed-in user |
| POST | /api/v1/public/me/selling/co-sellers/{invitationId}/decline | Decline a co-seller invitation sent to the signed-in user |
| POST | /api/v1/public/me/selling/co-sellers/{invitationId}/withdraw | Withdraw an open co-seller invitation the signed-in user sent |
| POST | /api/v1/public/me/selling/debit-terms/accept | Accept the app owner's account debit terms as the signed-in seller |
| POST | /api/v1/public/me/selling/session | Create a session for Stripe's embedded seller components |
| GET | /api/v1/public/me/selling/shipping | Get the shipping settings of the signed-in user's seller account |
| PUT | /api/v1/public/me/selling/shipping | Update the shipping settings of the signed-in user's seller account |
| POST | /api/v1/public/me/selling/sync | Refresh the signed-in user's seller account from Stripe |
| GET | /api/v1/public/me/selling/tax | Get the signed-in user's own tax choice as a seller |
| PUT | /api/v1/public/me/selling/tax | Choose whether Stripe Tax works out the tax on the user's own sales |
| GET | /api/v1/public/me/shipping-rates | List the signed-in user's shipping rates as a seller |
| POST | /api/v1/public/me/shipping-rates | Create a shipping rate for the signed-in user as a seller |
| GET | /api/v1/public/me/shipping-rates/{id} | Get one of the signed-in user's shipping rates |
| PUT | /api/v1/public/me/shipping-rates/{id} | Replace one of the signed-in user's shipping rates |
| DELETE | /api/v1/public/me/shipping-rates/{id} | Delete one of the signed-in user's shipping rates |
| GET | /api/v1/public/me/subscription | Get the signed-in user's own subscription, standing and entitlement |
| PATCH | /api/v1/public/me/subscription | Change the signed-in user's own plan, or start a checkout for it |
| POST | /api/v1/public/me/subscription/billing-portal | Open the Stripe billing portal on the signed-in user's own customer |
| POST | /api/v1/public/me/subscription/cancel-at-period-end | Cancel the signed-in user's own plan at the end of the billing period |
| POST | /api/v1/public/me/subscription/cancel-now | End the signed-in user's own plan now, with the app's refund |
| POST | /api/v1/public/me/subscription/checkout | Start a Stripe checkout for a plan on the signed-in user's own account |
| POST | /api/v1/public/me/subscription/convert-to-paid | End the signed-in user's trial now and start paying for the plan |
| GET | /api/v1/public/me/subscription/entitlement | Get the signed-in user's resolved entitlement |
| GET | /api/v1/public/me/subscription/invoices | List the invoices on the signed-in user's own Stripe customer |
| GET | /api/v1/public/me/subscription/invoices/{invoiceId} | Get one invoice of the signed-in user's own Stripe customer |
| POST | /api/v1/public/me/subscription/invoices/{invoiceId}/pay | Pay an open invoice of the signed-in user's own subscription now |
| POST | /api/v1/public/me/subscription/pause | Pause the signed-in user's own monthly plan after the paid period |
| GET | /api/v1/public/me/subscription/plan-group | Get the plan group the signed-in user picks personal plans from |
| POST | /api/v1/public/me/subscription/preview | Preview what changing the signed-in user's own plan will cost |
| POST | /api/v1/public/me/subscription/resume | Resume the signed-in user's own plan, undoing a pause or cancel |
| GET | /api/v1/public/me/subscription/retention-offer | Get the cancel dialog's context for the signed-in user's own plan |
| POST | /api/v1/public/me/subscription/retention-offer/accept | Accept the retention offer instead of cancelling the user's own plan |
| POST | /api/v1/public/me/subscription/select-free-plan | Put the signed-in user on a free plan |
| GET | /api/v1/public/me/subscription/trial-eligibility | Check whether the signed-in user would get a trial on each personal plan |
| GET | /api/v1/public/me/subscription/upcoming-invoice | Get the next invoice of the signed-in user's own subscription |
| POST | /api/v1/public/me/subscription/usage | Record usage against one of the signed-in user's quotas |
| POST | /api/v1/public/me/subscription/usage/batch | Record several usage items against the signed-in user's quotas |
Related
- API reference: every tag