Skip to content
BuildBase
HTTP API menu

Workspaces API

The Workspaces operations of the BuildBase HTTP API: method, path, sign-in, request fields, answers and errors for each.

251 operations, 79 fully described. For how this part of BuildBase works, start with the guide.

MethodPathWhat it does
GET/api/v1/public/workspacesList the workspaces the signed-in user belongs to
POST/api/v1/public/workspacesCreate a workspace owned by the signed-in user
GET/api/v1/public/workspaces/featuresList the workspace features members can toggle
PATCH/api/v1/public/workspaces/settingsRefuses a change to the organization's workspace settings
GET/api/v1/public/workspaces/{workspaceId}Get one workspace the signed-in user belongs to
PUT/api/v1/public/workspaces/{workspaceId}Update a workspace's name or image
DELETE/api/v1/public/workspaces/{workspaceId}Delete a workspace
GET/api/v1/public/workspaces/{workspaceId}/affiliate-programsList the workspace's affiliate programs
POST/api/v1/public/workspaces/{workspaceId}/affiliate-programsCreate an affiliate program for the workspace's items
POST/api/v1/public/workspaces/{workspaceId}/affiliate-programs/affiliates/{id}/approveApprove a pending affiliate of one of the workspace's programs
POST/api/v1/public/workspaces/{workspaceId}/affiliate-programs/affiliates/{id}/banBan an affiliate of one of the workspace's programs
POST/api/v1/public/workspaces/{workspaceId}/affiliate-programs/affiliates/{id}/pausePause an active affiliate of one of the workspace's programs
POST/api/v1/public/workspaces/{workspaceId}/affiliate-programs/affiliates/{id}/resumeResume a paused affiliate of one of the workspace's programs
GET/api/v1/public/workspaces/{workspaceId}/affiliate-programs/payouts/wise.csvDownload the Wise batch file of the workspace's pending Wise payouts
POST/api/v1/public/workspaces/{workspaceId}/affiliate-programs/payouts/{id}/mark-paidMark a manual or Wise payout as paid
GET/api/v1/public/workspaces/{workspaceId}/affiliate-programs/payouts/{id}/wise.csvDownload the Wise batch file of one pending Wise payout
GET/api/v1/public/workspaces/{workspaceId}/affiliate-programs/{id}Get one of the workspace's affiliate programs
PATCH/api/v1/public/workspaces/{workspaceId}/affiliate-programs/{id}Update one of the workspace's affiliate programs
DELETE/api/v1/public/workspaces/{workspaceId}/affiliate-programs/{id}Delete one of the workspace's affiliate programs
GET/api/v1/public/workspaces/{workspaceId}/affiliate-programs/{id}/affiliatesList the affiliates of one of the workspace's programs
POST/api/v1/public/workspaces/{workspaceId}/affiliate-programs/{id}/affiliatesAdd a person to an affiliate program directly (refused for workspaces)
GET/api/v1/public/workspaces/{workspaceId}/affiliate-programs/{id}/commissionsList the commissions of one of the workspace's programs
POST/api/v1/public/workspaces/{workspaceId}/affiliate-programs/{id}/invitationsInvite a person to one of the workspace's affiliate programs
GET/api/v1/public/workspaces/{workspaceId}/affiliate-programs/{id}/payoutsList the payouts of one of the workspace's programs
POST/api/v1/public/workspaces/{workspaceId}/billing/add-ons/{grantId}/cancelRemove a recurring add-on from the workspace subscription
POST/api/v1/public/workspaces/{workspaceId}/billing/add-ons/{grantId}/cancel/previewPreview removing a recurring add-on
POST/api/v1/public/workspaces/{workspaceId}/billing/add-ons/{grantId}/decreaseLower the quantity of a recurring add-on
POST/api/v1/public/workspaces/{workspaceId}/billing/add-ons/{grantId}/decrease/previewPreview lowering the quantity of a recurring add-on
POST/api/v1/public/workspaces/{workspaceId}/billing/add-ons/{grantId}/future-versionsOpt a lifetime add-on out of or back into future versions
GET/api/v1/public/workspaces/{workspaceId}/billing/add-ons/{grantId}/upgradeQuote upgrading a one-time or lifetime add-on to its current version
POST/api/v1/public/workspaces/{workspaceId}/billing/add-ons/{grantId}/upgradeUpgrade a one-time or lifetime add-on to its current version
POST/api/v1/public/workspaces/{workspaceId}/billing/checkoutBuy an add-on for the workspace
POST/api/v1/public/workspaces/{workspaceId}/billing/checkout/previewPreview the cost of buying a recurring add-on
GET/api/v1/public/workspaces/{workspaceId}/billing/offersList the add-ons on sale to the workspace
POST/api/v1/public/workspaces/{workspaceId}/billing/payment-method/defaultMake a saved card the workspace's default payment method
POST/api/v1/public/workspaces/{workspaceId}/billing/payment-method/setupStart a card setup for the workspace
GET/api/v1/public/workspaces/{workspaceId}/calendarsList the workspace's shared booking calendars
POST/api/v1/public/workspaces/{workspaceId}/calendarsCreate a shared booking calendar for the workspace
GET/api/v1/public/workspaces/{workspaceId}/calendars/{id}Get one of the workspace's calendars with the items booked on it
PUT/api/v1/public/workspaces/{workspaceId}/calendars/{id}Replace a calendar's name, grid and settings
DELETE/api/v1/public/workspaces/{workspaceId}/calendars/{id}Delete a calendar that no item is booked on
GET/api/v1/public/workspaces/{workspaceId}/couponsList the workspace's coupons
POST/api/v1/public/workspaces/{workspaceId}/couponsCreate a coupon for the workspace's items
GET/api/v1/public/workspaces/{workspaceId}/coupons/{id}Get one of the workspace's coupons
PATCH/api/v1/public/workspaces/{workspaceId}/coupons/{id}Update the terms of one of the workspace's coupons
DELETE/api/v1/public/workspaces/{workspaceId}/coupons/{id}Delete one of the workspace's coupons
GET/api/v1/public/workspaces/{workspaceId}/creditsGet the workspace's credit balance
GET/api/v1/public/workspaces/{workspaceId}/credits/auto-top-upGet the workspace's automatic credit top-up setting
PATCH/api/v1/public/workspaces/{workspaceId}/credits/auto-top-upUpdate the workspace's automatic credit top-up setting
GET/api/v1/public/workspaces/{workspaceId}/credits/bucketsList the workspace's credit buckets
POST/api/v1/public/workspaces/{workspaceId}/credits/consumeConsume credits from the workspace balance
GET/api/v1/public/workspaces/{workspaceId}/credits/expiringList credits expiring soon
GET/api/v1/public/workspaces/{workspaceId}/credits/holdsList the workspace's credit holds
POST/api/v1/public/workspaces/{workspaceId}/credits/holds/{holdId}/releaseRelease a credit hold in full
POST/api/v1/public/workspaces/{workspaceId}/credits/holds/{holdId}/settleSettle a credit hold at its final cost
GET/api/v1/public/workspaces/{workspaceId}/credits/packagesList the credit packages on sale
POST/api/v1/public/workspaces/{workspaceId}/credits/payment-method-setupStart a Stripe page that saves a card for credit top-ups
POST/api/v1/public/workspaces/{workspaceId}/credits/purchaseStart a Stripe Checkout session for a credit package
POST/api/v1/public/workspaces/{workspaceId}/credits/reservePut workspace credits on hold
GET/api/v1/public/workspaces/{workspaceId}/credits/transactionsList the workspace's credit transactions
GET/api/v1/public/workspaces/{workspaceId}/enterpriseGet the enterprise SSO status of a workspace
GET/api/v1/public/workspaces/{workspaceId}/enterprise/adminsList the company admins and their company roles
POST/api/v1/public/workspaces/{workspaceId}/enterprise/adminsName a company admin
PATCH/api/v1/public/workspaces/{workspaceId}/enterprise/admins/{userId}Change a company admin's company role
DELETE/api/v1/public/workspaces/{workspaceId}/enterprise/admins/{userId}Remove a company admin
GET/api/v1/public/workspaces/{workspaceId}/enterprise/agent-accessGet the company's agent access settings
PATCH/api/v1/public/workspaces/{workspaceId}/enterprise/agent-accessTurn agent access on or off, or change its token lifetime
POST/api/v1/public/workspaces/{workspaceId}/enterprise/agent-access/checkRe-read the agent issuer's discovery document and keys
PUT/api/v1/public/workspaces/{workspaceId}/enterprise/agent-access/issuerSet the identity provider trusted to approve agents
DELETE/api/v1/public/workspaces/{workspaceId}/enterprise/agent-access/issuerStop trusting the company's agent issuer
GET/api/v1/public/workspaces/{workspaceId}/enterprise/auditList the company's sign-in audit trail
GET/api/v1/public/workspaces/{workspaceId}/enterprise/audit/exportExport the company's audit trail as CSV
POST/api/v1/public/workspaces/{workspaceId}/enterprise/audit/exportsRequest an export of the company's WorkOS audit log
GET/api/v1/public/workspaces/{workspaceId}/enterprise/audit/exports/{exportId}Get a WorkOS audit log export and its download link
POST/api/v1/public/workspaces/{workspaceId}/enterprise/claimBring accounts on the company's domains into the company
GET/api/v1/public/workspaces/{workspaceId}/enterprise/connected-appsList the apps and agents the company's people have connected
POST/api/v1/public/workspaces/{workspaceId}/enterprise/connected-apps/revokeDisconnect an app or agent for one person or the whole company
GET/api/v1/public/workspaces/{workspaceId}/enterprise/connected-apps/{clientId}List one app's grants among the company's people
POST/api/v1/public/workspaces/{workspaceId}/enterprise/domains/syncRe-read the company's verified domains from WorkOS
GET/api/v1/public/workspaces/{workspaceId}/enterprise/groupsList the company's groups
POST/api/v1/public/workspaces/{workspaceId}/enterprise/groupsCreate a company group
GET/api/v1/public/workspaces/{workspaceId}/enterprise/groups/{groupId}Get a company group
PATCH/api/v1/public/workspaces/{workspaceId}/enterprise/groups/{groupId}Update a company group's name, people, workspaces or role
DELETE/api/v1/public/workspaces/{workspaceId}/enterprise/groups/{groupId}Delete a company group
GET/api/v1/public/workspaces/{workspaceId}/enterprise/groups/{groupId}/candidatesSearch the company's people who can be added to a group
POST/api/v1/public/workspaces/{workspaceId}/enterprise/groups/{groupId}/managersName a group manager
DELETE/api/v1/public/workspaces/{workspaceId}/enterprise/groups/{groupId}/managers/{userId}Remove a group manager
POST/api/v1/public/workspaces/{workspaceId}/enterprise/groups/{groupId}/membersAdd or remove the people named in a group
GET/api/v1/public/workspaces/{workspaceId}/enterprise/groups/{groupId}/peopleList the people in a group
GET/api/v1/public/workspaces/{workspaceId}/enterprise/insightsGet the company's identity insights
GET/api/v1/public/workspaces/{workspaceId}/enterprise/join-requestsList requests to join the company
POST/api/v1/public/workspaces/{workspaceId}/enterprise/join-requests/{requestId}/approveApprove a request to join the company
POST/api/v1/public/workspaces/{workspaceId}/enterprise/join-requests/{requestId}/declineDecline a request to join the company
GET/api/v1/public/workspaces/{workspaceId}/enterprise/keysList the company's API keys
POST/api/v1/public/workspaces/{workspaceId}/enterprise/keysCreate a company API key
DELETE/api/v1/public/workspaces/{workspaceId}/enterprise/keys/{keyId}Revoke a company API key
GET/api/v1/public/workspaces/{workspaceId}/enterprise/log-streamGet the company's WorkOS log stream
GET/api/v1/public/workspaces/{workspaceId}/enterprise/log-streamsList the company's log streams to its SIEM
POST/api/v1/public/workspaces/{workspaceId}/enterprise/log-streamsAdd a log stream for the company
PATCH/api/v1/public/workspaces/{workspaceId}/enterprise/log-streams/{streamId}Update one of the company's log streams
DELETE/api/v1/public/workspaces/{workspaceId}/enterprise/log-streams/{streamId}Remove one of the company's log streams
POST/api/v1/public/workspaces/{workspaceId}/enterprise/log-streams/{streamId}/rotate-secretRotate a log stream's signing secret
POST/api/v1/public/workspaces/{workspaceId}/enterprise/log-streams/{streamId}/testSend a test event to one of the company's log streams
GET/api/v1/public/workspaces/{workspaceId}/enterprise/outsidersList members of the company's workspaces who are outside the company
GET/api/v1/public/workspaces/{workspaceId}/enterprise/peopleList the company's people, newest first
POST/api/v1/public/workspaces/{workspaceId}/enterprise/people/{userId}/passkeys/resetReset a person's passkeys and sign them out
GET/api/v1/public/workspaces/{workspaceId}/enterprise/people/{userId}/sessionsList one of the company's people's live sessions
DELETE/api/v1/public/workspaces/{workspaceId}/enterprise/people/{userId}/sessions/{sessionRef}End one of a person's sessions
GET/api/v1/public/workspaces/{workspaceId}/enterprise/policyGet the company's access policy
PUT/api/v1/public/workspaces/{workspaceId}/enterprise/policyUpdate the company's access policy
GET/api/v1/public/workspaces/{workspaceId}/enterprise/policy/workspacesList the company's per-workspace policy exceptions
GET/api/v1/public/workspaces/{workspaceId}/enterprise/policy/workspaces/{targetId}Get the stricter policy for one of the company's workspaces
PUT/api/v1/public/workspaces/{workspaceId}/enterprise/policy/workspaces/{targetId}Set the stricter policy for one of the company's workspaces
DELETE/api/v1/public/workspaces/{workspaceId}/enterprise/policy/workspaces/{targetId}Remove a workspace's policy exception
GET/api/v1/public/workspaces/{workspaceId}/enterprise/rolesList the roles the company can give, with who holds each
POST/api/v1/public/workspaces/{workspaceId}/enterprise/rolesCreate a company role
PATCH/api/v1/public/workspaces/{workspaceId}/enterprise/roles/{roleId}Rename a company role or change what it allows
DELETE/api/v1/public/workspaces/{workspaceId}/enterprise/roles/{roleId}Delete a company role
GET/api/v1/public/workspaces/{workspaceId}/enterprise/service-accountsList the company's service accounts
POST/api/v1/public/workspaces/{workspaceId}/enterprise/service-accountsCreate a service account for the company
PATCH/api/v1/public/workspaces/{workspaceId}/enterprise/service-accounts/{serviceAccountId}Update one of the company's service accounts
DELETE/api/v1/public/workspaces/{workspaceId}/enterprise/service-accounts/{serviceAccountId}Delete a service account and revoke its keys
POST/api/v1/public/workspaces/{workspaceId}/enterprise/setup-linkCreate a short-lived setup link for the company's IT admin
POST/api/v1/public/workspaces/{workspaceId}/enterprise/sign-outSign out one or all of the company's people
PUT/api/v1/public/workspaces/{workspaceId}/enterprise/sso/routingReplace which identity provider signs in each verified domain
GET/api/v1/public/workspaces/{workspaceId}/enterprise/unclaimedList accounts on the company's domains that are not its people yet
GET/api/v1/public/workspaces/{workspaceId}/enterprise/workload-identityList the company's workload credentials and exchange details
POST/api/v1/public/workspaces/{workspaceId}/enterprise/workload-identity/checkDry-run an issuer's discovery and keys for a workload credential
POST/api/v1/public/workspaces/{workspaceId}/enterprise/workload-identity/credentialsTrust a CI job or cloud workload for a company service account
PATCH/api/v1/public/workspaces/{workspaceId}/enterprise/workload-identity/credentials/{credentialId}Update a workload credential
DELETE/api/v1/public/workspaces/{workspaceId}/enterprise/workload-identity/credentials/{credentialId}Delete a workload credential and end its live tokens
GET/api/v1/public/workspaces/{workspaceId}/enterprise/workos-rolesGet the company's WorkOS roles sync status
POST/api/v1/public/workspaces/{workspaceId}/enterprise/workos-roles/refreshRefresh the company's roles from WorkOS
GET/api/v1/public/workspaces/{workspaceId}/featuresGet the workspace's feature flags
PATCH/api/v1/public/workspaces/{workspaceId}/featuresToggle the workspace's user-managed features
GET/api/v1/public/workspaces/{workspaceId}/filesList the workspace's files for buyers
POST/api/v1/public/workspaces/{workspaceId}/files/uploadsStart an upload of a file for buyers
POST/api/v1/public/workspaces/{workspaceId}/files/uploads/{uploadId}/completeFinish a file upload and return the stored file
GET/api/v1/public/workspaces/{workspaceId}/files/{fileId}Get one of the workspace's files for buyers
DELETE/api/v1/public/workspaces/{workspaceId}/files/{fileId}Delete a file that no release holds
GET/api/v1/public/workspaces/{workspaceId}/grantsList what the workspace holds beyond its plan
GET/api/v1/public/workspaces/{workspaceId}/invitationsList the workspace's invitations
POST/api/v1/public/workspaces/{workspaceId}/invitationsInvite someone to the workspace by email
DELETE/api/v1/public/workspaces/{workspaceId}/invitations/{id}Revoke a pending invitation
POST/api/v1/public/workspaces/{workspaceId}/invitations/{id}/resendSend an invitation email again
GET/api/v1/public/workspaces/{workspaceId}/itemsList the workspace's items
POST/api/v1/public/workspaces/{workspaceId}/itemsCreate a draft item sold by the workspace
GET/api/v1/public/workspaces/{workspaceId}/items/{id}Get one of the workspace's items
PUT/api/v1/public/workspaces/{workspaceId}/items/{id}Replace the content of one of the workspace's items
DELETE/api/v1/public/workspaces/{workspaceId}/items/{id}Delete an item that was never listed or sold
POST/api/v1/public/workspaces/{workspaceId}/items/{id}/archiveArchive one of the workspace's items
POST/api/v1/public/workspaces/{workspaceId}/items/{id}/booking/calendar-moveMove an item's upcoming bookings onto one of the workspace's calendars
POST/api/v1/public/workspaces/{workspaceId}/items/{id}/booking/calendar-move/previewPreview moving an item's bookings onto one of the workspace's calendars
POST/api/v1/public/workspaces/{workspaceId}/items/{id}/publishPublish one of the workspace's items, or submit it for review
POST/api/v1/public/workspaces/{workspaceId}/items/{id}/unlistUnlist one of the workspace's items
GET/api/v1/public/workspaces/{workspaceId}/limits/{slug}Get one of the workspace's limits and its claims standing
POST/api/v1/public/workspaces/{workspaceId}/limits/{slug}/claimClaim one unit of a workspace limit for a resource
GET/api/v1/public/workspaces/{workspaceId}/limits/{slug}/claimsList the active claims on a workspace limit
POST/api/v1/public/workspaces/{workspaceId}/limits/{slug}/releaseRelease a claim on a workspace limit
GET/api/v1/public/workspaces/{workspaceId}/notification-eventsList the notification events members can manage
GET/api/v1/public/workspaces/{workspaceId}/notification-preferencesGet the workspace's default notification preferences
PATCH/api/v1/public/workspaces/{workspaceId}/notification-preferencesUpdate the workspace's default notification preferences
GET/api/v1/public/workspaces/{workspaceId}/notification-preferences/meGet the caller's own notification preferences in the workspace
PATCH/api/v1/public/workspaces/{workspaceId}/notification-preferences/meUpdate the caller's own notification preferences in the workspace
DELETE/api/v1/public/workspaces/{workspaceId}/notifications/scheduled/{scheduledId}Cancel a scheduled notification send
POST/api/v1/public/workspaces/{workspaceId}/notifications/sendSend a notification event to one member or the whole workspace
GET/api/v1/public/workspaces/{workspaceId}/permissionsGet the workspace's permission overrides by role
PATCH/api/v1/public/workspaces/{workspaceId}/permissionsSet the workspace's permission overrides by role
GET/api/v1/public/workspaces/{workspaceId}/permissions/meGet the permissions the caller holds in the workspace
GET/api/v1/public/workspaces/{workspaceId}/quotas/{slug}Get the workspace's standing on one quota
PATCH/api/v1/public/workspaces/{workspaceId}/quotas/{slug}Set the workspace's spend cap and partition caps on a quota
GET/api/v1/public/workspaces/{workspaceId}/releasesList the workspace's file releases
POST/api/v1/public/workspaces/{workspaceId}/releasesCreate a draft file release for the workspace
GET/api/v1/public/workspaces/{workspaceId}/releases/{id}Get one of the workspace's file releases
PATCH/api/v1/public/workspaces/{workspaceId}/releases/{id}Update a file release
DELETE/api/v1/public/workspaces/{workspaceId}/releases/{id}Delete a draft file release
POST/api/v1/public/workspaces/{workspaceId}/releases/{id}/publishPublish a draft file release
GET/api/v1/public/workspaces/{workspaceId}/salesList the workspace's sales as a seller
GET/api/v1/public/workspaces/{workspaceId}/sales/bookingsList the bookings made on the workspace's items
GET/api/v1/public/workspaces/{workspaceId}/sales/bookings/{id}Get a booking made on one of the workspace's items
PUT/api/v1/public/workspaces/{workspaceId}/sales/bookings/{id}/attendanceMark whether the buyer attended a booking, or clear it
POST/api/v1/public/workspaces/{workspaceId}/sales/bookings/{id}/cancelCancel a booking made on one of the workspace's items
POST/api/v1/public/workspaces/{workspaceId}/sales/bookings/{id}/rescheduleMove a booking to another slot of its item
GET/api/v1/public/workspaces/{workspaceId}/sales/exportExport the workspace's sales as a CSV file
GET/api/v1/public/workspaces/{workspaceId}/sales/subscriptionsList the subscriptions the workspace has sold
GET/api/v1/public/workspaces/{workspaceId}/sales/subscriptions/{id}Get a subscription the workspace has sold
POST/api/v1/public/workspaces/{workspaceId}/sales/subscriptions/{id}/cancelCancel a subscription the workspace has sold
GET/api/v1/public/workspaces/{workspaceId}/sales/{id}Get one of the workspace's sales
POST/api/v1/public/workspaces/{workspaceId}/sales/{id}/lines/{lineKey}/fulfilMark a sale's line fulfilled or in progress
POST/api/v1/public/workspaces/{workspaceId}/sales/{id}/parts/{index}/chargeCharge the balance of a sale paid by deposit
POST/api/v1/public/workspaces/{workspaceId}/sales/{id}/refundRefund one of the workspace's sales
GET/api/v1/public/workspaces/{workspaceId}/sales/{id}/returnsList the returns requested on one of the workspace's sales
POST/api/v1/public/workspaces/{workspaceId}/sales/{id}/returns/{returnId}/approveApprove a requested return on one of the workspace's sales
POST/api/v1/public/workspaces/{workspaceId}/sales/{id}/returns/{returnId}/refundRefund a return on one of the workspace's sales
POST/api/v1/public/workspaces/{workspaceId}/sales/{id}/returns/{returnId}/rejectReject a requested return on one of the workspace's sales
GET/api/v1/public/workspaces/{workspaceId}/sales/{id}/shipmentsList the shipments of one of the workspace's sales
POST/api/v1/public/workspaces/{workspaceId}/sales/{id}/shipmentsCreate a shipment for one of the workspace's sales
GET/api/v1/public/workspaces/{workspaceId}/sales/{id}/shipments/{shipmentId}/labelDownload a shipment's label
POST/api/v1/public/workspaces/{workspaceId}/sales/{id}/shipments/{shipmentId}/statusSet a shipment's status by hand
GET/api/v1/public/workspaces/{workspaceId}/sellingGet the workspace's seller account and the app's selling settings
POST/api/v1/public/workspaces/{workspaceId}/sellingStart selling as the workspace
GET/api/v1/public/workspaces/{workspaceId}/selling/co-sellersList the workspace's co-seller invitations
POST/api/v1/public/workspaces/{workspaceId}/selling/co-sellersInvite another seller to share an item's sales
POST/api/v1/public/workspaces/{workspaceId}/selling/co-sellers/{invitationId}/acceptAccept a co-seller invitation sent to the workspace
POST/api/v1/public/workspaces/{workspaceId}/selling/co-sellers/{invitationId}/declineDecline a co-seller invitation sent to the workspace
POST/api/v1/public/workspaces/{workspaceId}/selling/co-sellers/{invitationId}/withdrawWithdraw a co-seller invitation the workspace sent
POST/api/v1/public/workspaces/{workspaceId}/selling/debit-terms/acceptAccept the app owner's account debit terms for the workspace
POST/api/v1/public/workspaces/{workspaceId}/selling/sessionCreate a Stripe embedded components session for the seller
GET/api/v1/public/workspaces/{workspaceId}/selling/shippingGet the workspace's seller shipping settings
PUT/api/v1/public/workspaces/{workspaceId}/selling/shippingSave the workspace's seller shipping settings
POST/api/v1/public/workspaces/{workspaceId}/selling/syncRefresh the workspace's seller account from Stripe
GET/api/v1/public/workspaces/{workspaceId}/selling/taxGet the workspace's own tax choice as a seller
PUT/api/v1/public/workspaces/{workspaceId}/selling/taxChoose whether Stripe Tax works out the tax on the workspace's sales
GET/api/v1/public/workspaces/{workspaceId}/shipping-ratesList the workspace's shipping rates
POST/api/v1/public/workspaces/{workspaceId}/shipping-ratesCreate a shipping rate for the workspace
GET/api/v1/public/workspaces/{workspaceId}/shipping-rates/{id}Get one of the workspace's shipping rates
PUT/api/v1/public/workspaces/{workspaceId}/shipping-rates/{id}Replace one of the workspace's shipping rates
DELETE/api/v1/public/workspaces/{workspaceId}/shipping-rates/{id}Delete one of the workspace's shipping rates
GET/api/v1/public/workspaces/{workspaceId}/subscriptionGet the workspace's current subscription, plan and capabilities
PATCH/api/v1/public/workspaces/{workspaceId}/subscriptionChange the workspace's plan
GET/api/v1/public/workspaces/{workspaceId}/subscription/billing-contactsList the workspace's billing contacts
PUT/api/v1/public/workspaces/{workspaceId}/subscription/billing-contactsReplace the workspace's billing contacts
POST/api/v1/public/workspaces/{workspaceId}/subscription/billing-portalCreate a Stripe Customer Portal session for the workspace
POST/api/v1/public/workspaces/{workspaceId}/subscription/cancel-at-period-endCancel the workspace's subscription at the end of the billing period
POST/api/v1/public/workspaces/{workspaceId}/subscription/cancel-nowCancel the workspace's subscription immediately
POST/api/v1/public/workspaces/{workspaceId}/subscription/checkoutCreate a Stripe checkout session for the workspace
POST/api/v1/public/workspaces/{workspaceId}/subscription/convert-to-paidEnd the workspace's trial now and pay for the plan
GET/api/v1/public/workspaces/{workspaceId}/subscription/invoicesList the workspace's invoices
GET/api/v1/public/workspaces/{workspaceId}/subscription/invoices/{invoiceId}Get one of the workspace's invoices
POST/api/v1/public/workspaces/{workspaceId}/subscription/invoices/{invoiceId}/payPay an open invoice of the workspace's subscription
POST/api/v1/public/workspaces/{workspaceId}/subscription/move-to-userMove the workspace's plan onto the signed-in user
POST/api/v1/public/workspaces/{workspaceId}/subscription/pausePause the workspace's subscription after the paid period ends
GET/api/v1/public/workspaces/{workspaceId}/subscription/plan-groupGet the plan group shown in the workspace's plan picker
GET/api/v1/public/workspaces/{workspaceId}/subscription/plan-group/versionsList the workspace's plan group version and any newer versions
POST/api/v1/public/workspaces/{workspaceId}/subscription/previewPreview what a plan change or ending the trial now will cost
POST/api/v1/public/workspaces/{workspaceId}/subscription/resumeResume the workspace's subscription
GET/api/v1/public/workspaces/{workspaceId}/subscription/retention-offerGet what the cancel dialog shows before cancelling
POST/api/v1/public/workspaces/{workspaceId}/subscription/retention-offer/acceptAccept the retention offer instead of cancelling
POST/api/v1/public/workspaces/{workspaceId}/subscription/select-free-planPut the workspace on a free plan without checkout
POST/api/v1/public/workspaces/{workspaceId}/subscription/transfer-payerMove the workspace's subscription to another payer
GET/api/v1/public/workspaces/{workspaceId}/subscription/trial-eligibilityCheck whether the signed-in user would get a trial in this workspace
GET/api/v1/public/workspaces/{workspaceId}/subscription/upcoming-invoiceGet the workspace's next invoice
POST/api/v1/public/workspaces/{workspaceId}/subscription/usageRecord quota usage for the workspace
GET/api/v1/public/workspaces/{workspaceId}/subscription/usage/allGet usage status for every quota of the workspace
POST/api/v1/public/workspaces/{workspaceId}/subscription/usage/batchRecord several quota usage entries in one request
GET/api/v1/public/workspaces/{workspaceId}/subscription/usage/logsList the workspace's usage log entries
GET/api/v1/public/workspaces/{workspaceId}/subscription/usage/statusGet the usage status of one quota
GET/api/v1/public/workspaces/{workspaceId}/usersList the members of a workspace
POST/api/v1/public/workspaces/{workspaceId}/users/addAdd a user to the workspace by email, or invite them
PATCH/api/v1/public/workspaces/{workspaceId}/users/{userId}Change a member's role
DELETE/api/v1/public/workspaces/{workspaceId}/users/{userId}Remove a member from the workspace, or leave it