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

## Related

- [API reference](/http-api/reference): every tag
