Skip to content
BuildBase
HTTP API menu

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.

MethodPathWhat it does
DELETE/api/v1/public/meDelete the signed-in user's account, now or after the org's grace period
GET/api/v1/public/me/accessCheck whether the signed-in user may use one app resource now
GET/api/v1/public/me/affiliate-invitationsList the signed-in user's pending invitations to affiliate programs
POST/api/v1/public/me/affiliate-invitations/{id}/acceptAccept an invitation and join the seller's affiliate program
POST/api/v1/public/me/affiliate-invitations/{id}/declineDecline an invitation to a seller's affiliate program
GET/api/v1/public/me/affiliate-programsList the affiliate programs the signed-in user runs as a seller
POST/api/v1/public/me/affiliate-programsCreate an affiliate program on the signed-in seller's own items
POST/api/v1/public/me/affiliate-programs/affiliates/{id}/approveApprove a pending affiliate in one of the signed-in seller's programs
POST/api/v1/public/me/affiliate-programs/affiliates/{id}/banBan an affiliate from one of the signed-in seller's programs
POST/api/v1/public/me/affiliate-programs/affiliates/{id}/pausePause an active affiliate in one of the signed-in seller's programs
POST/api/v1/public/me/affiliate-programs/affiliates/{id}/resumeResume a paused affiliate in one of the signed-in seller's programs
GET/api/v1/public/me/affiliate-programs/payouts/wise.csvDownload the signed-in seller's pending Wise payouts as a CSV file
POST/api/v1/public/me/affiliate-programs/payouts/{id}/mark-paidMark a manual or Wise payout of the signed-in seller's program paid
GET/api/v1/public/me/affiliate-programs/payouts/{id}/wise.csvDownload 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}/affiliatesList the affiliates of one of the signed-in seller's programs
POST/api/v1/public/me/affiliate-programs/{id}/affiliatesAdd a person to a program directly (refused for sellers)
GET/api/v1/public/me/affiliate-programs/{id}/commissionsList the commissions earned in one of the signed-in seller's programs
POST/api/v1/public/me/affiliate-programs/{id}/invitationsInvite a person by email or user id to the signed-in seller's program
GET/api/v1/public/me/affiliate-programs/{id}/payoutsList the payouts of one of the signed-in seller's programs
GET/api/v1/public/me/affiliatesList the affiliate programs the signed-in user has joined
POST/api/v1/public/me/affiliatesJoin an affiliate program as the signed-in user
GET/api/v1/public/me/affiliates/commissionsList the signed-in user's affiliate commissions
POST/api/v1/public/me/affiliates/payout-accountStart a Stripe onboarding session for the signed-in affiliate's payouts
POST/api/v1/public/me/affiliates/payout-account/syncRefresh the status of the signed-in affiliate's Stripe payout account
GET/api/v1/public/me/affiliates/payoutsList 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}/codeChange the signed-in user's referral code in one program
PUT/api/v1/public/me/affiliates/{id}/contact-consentShare or stop sharing the signed-in user's email with a program's seller
PUT/api/v1/public/me/affiliates/{id}/payout-methodChoose how one program pays the signed-in affiliate
POST/api/v1/public/me/billing/add-ons/{grantId}/cancelRemove a recurring add-on from the signed-in user's own subscription
POST/api/v1/public/me/billing/add-ons/{grantId}/cancel/previewPreview removing a recurring add-on from the signed-in user's subscription
POST/api/v1/public/me/billing/add-ons/{grantId}/decreaseLower the quantity of a recurring add-on on the signed-in user's subscription
POST/api/v1/public/me/billing/add-ons/{grantId}/decrease/previewPreview lowering the quantity of a recurring add-on the signed-in user holds
POST/api/v1/public/me/billing/add-ons/{grantId}/future-versionsOpt 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}/upgradeQuote upgrading a one-time or lifetime add-on to its offer's current version
POST/api/v1/public/me/billing/add-ons/{grantId}/upgradeBuy the upgrade of an add-on the signed-in user holds to its current version
POST/api/v1/public/me/billing/checkoutBuy an add-on offer for the signed-in user
POST/api/v1/public/me/billing/checkout/previewPreview the cost of a recurring add-on on the user's own subscription
GET/api/v1/public/me/billing/offersList the add-on offers the signed-in user can buy, with what they hold
POST/api/v1/public/me/billing/payment-method/defaultMake a confirmed card the signed-in user's default payment method
POST/api/v1/public/me/billing/payment-method/setupStart a card setup on the signed-in user's own Stripe customer
GET/api/v1/public/me/bookingsList 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.icsDownload one of the signed-in user's bookings as a calendar file
POST/api/v1/public/me/bookings/{id}/cancelCancel one of the signed-in user's bookings
POST/api/v1/public/me/bookings/{id}/rescheduleMove one of the signed-in user's bookings to another slot
GET/api/v1/public/me/calendarsList the signed-in user's shared booking calendars as a seller
POST/api/v1/public/me/calendarsCreate 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}/nextOpen the next payment step of the signed-in user's storefront cart
GET/api/v1/public/me/couponsList the signed-in user's coupons as a seller
POST/api/v1/public/me/couponsCreate 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/creditsGet the signed-in user's own credit balance
GET/api/v1/public/me/credits/auto-top-upGet the automatic top-up setting of the user's own credit wallet
PATCH/api/v1/public/me/credits/auto-top-upChange the automatic top-up setting of the user's own credit wallet
GET/api/v1/public/me/credits/bucketsList the credit buckets in the user's own wallet, newest first
POST/api/v1/public/me/credits/consumeSpend credits from the signed-in user's own wallet
GET/api/v1/public/me/credits/expiringList the user's own credits that expire within a number of days
GET/api/v1/public/me/credits/holdsList the credit holds on the signed-in user's own wallet
POST/api/v1/public/me/credits/holds/{holdId}/releaseRelease a credit hold on the user's own wallet, returning its credits
POST/api/v1/public/me/credits/holds/{holdId}/settleSettle a credit hold on the user's own wallet for the real cost
GET/api/v1/public/me/credits/packagesList the credit packs on sale, in the order the app set
POST/api/v1/public/me/credits/payment-method-setupOpen a Stripe page that saves a card for the user's automatic top-up
POST/api/v1/public/me/credits/purchaseStart a Stripe checkout to buy a credit pack for the signed-in user
POST/api/v1/public/me/credits/reservePut credits from the user's own wallet on hold for work not yet costed
GET/api/v1/public/me/credits/transactionsList the credit transactions on the user's own wallet, newest first
GET/api/v1/public/me/deletionPreview what deleting the signed-in user's account would forfeit
POST/api/v1/public/me/entitlements/checkCheck one entitlement slug against the user and their workspaces
GET/api/v1/public/me/filesList the signed-in seller's files for buyers, newest first
POST/api/v1/public/me/files/uploadsStart an upload of one file for buyers as the signed-in seller
POST/api/v1/public/me/files/uploads/{uploadId}/completeFinish 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/grantsList what the signed-in user holds beyond their plan
GET/api/v1/public/me/holdingsList the signed-in user's holdings from purchases, newest first
POST/api/v1/public/me/holdings/{id}/deactivateRemove one activation from a license key the signed-in user holds
POST/api/v1/public/me/holdings/{id}/downloadsGet a short-lived download link for one file of a holding
GET/api/v1/public/me/item-subscriptionsList 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}/cancelCancel an item subscription the signed-in user holds at the period end
POST/api/v1/public/me/item-subscriptions/{id}/changeMove an item subscription the signed-in user holds to another tier
GET/api/v1/public/me/item-subscriptions/{id}/change-previewPreview moving an item subscription the signed-in user holds to another tier
POST/api/v1/public/me/item-subscriptions/{id}/resumeUndo the cancel of an item subscription the signed-in user holds
GET/api/v1/public/me/itemsList the items the signed-in user sells, most recently updated first
POST/api/v1/public/me/itemsCreate 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}/archiveArchive an item the signed-in user sells
POST/api/v1/public/me/items/{id}/booking/calendar-moveMove an item's bookings onto another of the signed-in user's calendars
POST/api/v1/public/me/items/{id}/booking/calendar-move/previewPreview moving an item's bookings onto another of the user's calendars
POST/api/v1/public/me/items/{id}/publishPublish an item the signed-in user sells
POST/api/v1/public/me/items/{id}/unlistUnlist 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}/claimClaim a resource against one of the signed-in user's limits
GET/api/v1/public/me/limits/{slug}/claimsList the signed-in user's claims on one limit
POST/api/v1/public/me/limits/{slug}/releaseRelease a claimed resource from one of the signed-in user's limits
GET/api/v1/public/me/ordersList 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}/payPay one part of the signed-in user's order sold in parts
GET/api/v1/public/me/orders/{id}/returnsList the returns of one of the signed-in user's orders
POST/api/v1/public/me/orders/{id}/returnsAsk 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/releasesList the signed-in seller's releases
POST/api/v1/public/me/releasesCreate 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}/publishPublish one of the signed-in seller's draft releases
GET/api/v1/public/me/salesList the orders of items the signed-in user sells, a page at a time
GET/api/v1/public/me/sales/bookingsList 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}/attendanceMark whether the buyer came to a booking on the user's item
POST/api/v1/public/me/sales/bookings/{id}/cancelCancel a booking on an item the signed-in user sells
POST/api/v1/public/me/sales/bookings/{id}/rescheduleMove a booking on the user's item to another slot
GET/api/v1/public/me/sales/exportDownload the signed-in user's paid sales as a CSV file
GET/api/v1/public/me/sales/subscriptionsList 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}/cancelCancel 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}/fulfilMark a line of the user's sale in progress or fulfilled
POST/api/v1/public/me/sales/{id}/parts/{index}/chargeCharge the balance of a deposit order the signed-in user sold
POST/api/v1/public/me/sales/{id}/refundRefund all or part of an order the signed-in user sold
GET/api/v1/public/me/sales/{id}/returnsList the returns of an order the signed-in user sold
POST/api/v1/public/me/sales/{id}/returns/{returnId}/approveApprove a return on an order the signed-in user sold
POST/api/v1/public/me/sales/{id}/returns/{returnId}/refundRefund a return on an order the signed-in user sold
POST/api/v1/public/me/sales/{id}/returns/{returnId}/rejectReject a return on an order the signed-in user sold
GET/api/v1/public/me/sales/{id}/shipmentsList the shipments of an order the signed-in user sold
POST/api/v1/public/me/sales/{id}/shipmentsShip units of an order the signed-in user sold
GET/api/v1/public/me/sales/{id}/shipments/{shipmentId}/labelDownload the label of a shipment on an order the signed-in user sold
POST/api/v1/public/me/sales/{id}/shipments/{shipmentId}/statusSet the status of a shipment on an order the signed-in user sold
GET/api/v1/public/me/sellingGet the signed-in user's seller account and the app's selling settings
POST/api/v1/public/me/sellingStart selling as the signed-in user
GET/api/v1/public/me/selling/co-sellersList co-seller invitations the user's seller account received or sent
POST/api/v1/public/me/selling/co-sellersInvite another seller to share the sales of one of the user's items
POST/api/v1/public/me/selling/co-sellers/{invitationId}/acceptAccept a co-seller invitation sent to the signed-in user
POST/api/v1/public/me/selling/co-sellers/{invitationId}/declineDecline a co-seller invitation sent to the signed-in user
POST/api/v1/public/me/selling/co-sellers/{invitationId}/withdrawWithdraw an open co-seller invitation the signed-in user sent
POST/api/v1/public/me/selling/debit-terms/acceptAccept the app owner's account debit terms as the signed-in seller
POST/api/v1/public/me/selling/sessionCreate a session for Stripe's embedded seller components
GET/api/v1/public/me/selling/shippingGet the shipping settings of the signed-in user's seller account
PUT/api/v1/public/me/selling/shippingUpdate the shipping settings of the signed-in user's seller account
POST/api/v1/public/me/selling/syncRefresh the signed-in user's seller account from Stripe
GET/api/v1/public/me/selling/taxGet the signed-in user's own tax choice as a seller
PUT/api/v1/public/me/selling/taxChoose whether Stripe Tax works out the tax on the user's own sales
GET/api/v1/public/me/shipping-ratesList the signed-in user's shipping rates as a seller
POST/api/v1/public/me/shipping-ratesCreate 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/subscriptionGet the signed-in user's own subscription, standing and entitlement
PATCH/api/v1/public/me/subscriptionChange the signed-in user's own plan, or start a checkout for it
POST/api/v1/public/me/subscription/billing-portalOpen the Stripe billing portal on the signed-in user's own customer
POST/api/v1/public/me/subscription/cancel-at-period-endCancel the signed-in user's own plan at the end of the billing period
POST/api/v1/public/me/subscription/cancel-nowEnd the signed-in user's own plan now, with the app's refund
POST/api/v1/public/me/subscription/checkoutStart a Stripe checkout for a plan on the signed-in user's own account
POST/api/v1/public/me/subscription/convert-to-paidEnd the signed-in user's trial now and start paying for the plan
GET/api/v1/public/me/subscription/entitlementGet the signed-in user's resolved entitlement
GET/api/v1/public/me/subscription/invoicesList 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}/payPay an open invoice of the signed-in user's own subscription now
POST/api/v1/public/me/subscription/pausePause the signed-in user's own monthly plan after the paid period
GET/api/v1/public/me/subscription/plan-groupGet the plan group the signed-in user picks personal plans from
POST/api/v1/public/me/subscription/previewPreview what changing the signed-in user's own plan will cost
POST/api/v1/public/me/subscription/resumeResume the signed-in user's own plan, undoing a pause or cancel
GET/api/v1/public/me/subscription/retention-offerGet the cancel dialog's context for the signed-in user's own plan
POST/api/v1/public/me/subscription/retention-offer/acceptAccept the retention offer instead of cancelling the user's own plan
POST/api/v1/public/me/subscription/select-free-planPut the signed-in user on a free plan
GET/api/v1/public/me/subscription/trial-eligibilityCheck whether the signed-in user would get a trial on each personal plan
GET/api/v1/public/me/subscription/upcoming-invoiceGet the next invoice of the signed-in user's own subscription
POST/api/v1/public/me/subscription/usageRecord usage against one of the signed-in user's quotas
POST/api/v1/public/me/subscription/usage/batchRecord several usage items against the signed-in user's quotas