# 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](/workspaces/overview).

| Method | Path                                                                                                                                                                                           | What it does                                                            |
| ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
| GET    | [`/api/v1/public/workspaces`](/http-api/reference/workspaces/workspaces-list)                                                                                                                  | List the workspaces the signed-in user belongs to                       |
| POST   | [`/api/v1/public/workspaces`](/http-api/reference/workspaces/workspaces-create)                                                                                                                | Create a workspace owned by the signed-in user                          |
| GET    | [`/api/v1/public/workspaces/features`](/http-api/reference/workspaces/workspaces-features-list)                                                                                                | List the workspace features members can toggle                          |
| PATCH  | [`/api/v1/public/workspaces/settings`](/http-api/reference/workspaces/workspaces-settings-update)                                                                                              | Refuses a change to the organization's workspace settings               |
| GET    | [`/api/v1/public/workspaces/{workspaceId}`](/http-api/reference/workspaces/workspaces-get)                                                                                                     | Get one workspace the signed-in user belongs to                         |
| PUT    | [`/api/v1/public/workspaces/{workspaceId}`](/http-api/reference/workspaces/workspaces-update)                                                                                                  | Update a workspace's name or image                                      |
| DELETE | [`/api/v1/public/workspaces/{workspaceId}`](/http-api/reference/workspaces/workspaces-delete)                                                                                                  | Delete a workspace                                                      |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/affiliate-programs`](/http-api/reference/workspaces/workspaces-affiliate-programs-list)                                                              | List the workspace's affiliate programs                                 |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/affiliate-programs`](/http-api/reference/workspaces/workspaces-affiliate-programs-create)                                                            | Create an affiliate program for the workspace's items                   |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/affiliate-programs/affiliates/{id}/approve`](/http-api/reference/workspaces/workspaces-affiliate-programs-affiliates-approve-create)                 | Approve a pending affiliate of one of the workspace's programs          |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/affiliate-programs/affiliates/{id}/ban`](/http-api/reference/workspaces/workspaces-affiliate-programs-affiliates-ban-create)                         | Ban an affiliate of one of the workspace's programs                     |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/affiliate-programs/affiliates/{id}/pause`](/http-api/reference/workspaces/workspaces-affiliate-programs-affiliates-pause-create)                     | Pause an active affiliate of one of the workspace's programs            |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/affiliate-programs/affiliates/{id}/resume`](/http-api/reference/workspaces/workspaces-affiliate-programs-affiliates-resume-create)                   | Resume a paused affiliate of one of the workspace's programs            |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/affiliate-programs/payouts/wise.csv`](/http-api/reference/workspaces/workspaces-by-workspace-id-affiliate-programs-payouts-wise-csv-list)            | Download the Wise batch file of the workspace's pending Wise payouts    |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/affiliate-programs/payouts/{id}/mark-paid`](/http-api/reference/workspaces/workspaces-affiliate-programs-payouts-mark-paid-create)                   | Mark a manual or Wise payout as paid                                    |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/affiliate-programs/payouts/{id}/wise.csv`](/http-api/reference/workspaces/workspaces-by-workspace-id-affiliate-programs-payouts-by-id-wise-csv-list) | Download the Wise batch file of one pending Wise payout                 |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/affiliate-programs/{id}`](/http-api/reference/workspaces/workspaces-affiliate-programs-get)                                                          | Get one of the workspace's affiliate programs                           |
| PATCH  | [`/api/v1/public/workspaces/{workspaceId}/affiliate-programs/{id}`](/http-api/reference/workspaces/workspaces-affiliate-programs-update)                                                       | Update one of the workspace's affiliate programs                        |
| DELETE | [`/api/v1/public/workspaces/{workspaceId}/affiliate-programs/{id}`](/http-api/reference/workspaces/workspaces-affiliate-programs-delete)                                                       | Delete one of the workspace's affiliate programs                        |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/affiliate-programs/{id}/affiliates`](/http-api/reference/workspaces/workspaces-affiliate-programs-affiliates-list)                                   | List the affiliates of one of the workspace's programs                  |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/affiliate-programs/{id}/affiliates`](/http-api/reference/workspaces/workspaces-affiliate-programs-affiliates-create)                                 | Add a person to an affiliate program directly (refused for workspaces)  |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/affiliate-programs/{id}/commissions`](/http-api/reference/workspaces/workspaces-affiliate-programs-commissions-list)                                 | List the commissions of one of the workspace's programs                 |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/affiliate-programs/{id}/invitations`](/http-api/reference/workspaces/workspaces-affiliate-programs-invitations-create)                               | Invite a person to one of the workspace's affiliate programs            |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/affiliate-programs/{id}/payouts`](/http-api/reference/workspaces/workspaces-affiliate-programs-payouts-list)                                         | List the payouts of one of the workspace's programs                     |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/billing/add-ons/{grantId}/cancel`](/http-api/reference/workspaces/workspaces-billing-add-ons-cancel-create)                                          | Remove a recurring add-on from the workspace subscription               |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/billing/add-ons/{grantId}/cancel/preview`](/http-api/reference/workspaces/workspaces-billing-add-ons-cancel-preview-create)                          | Preview removing a recurring add-on                                     |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/billing/add-ons/{grantId}/decrease`](/http-api/reference/workspaces/workspaces-billing-add-ons-decrease-create)                                      | Lower the quantity of a recurring add-on                                |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/billing/add-ons/{grantId}/decrease/preview`](/http-api/reference/workspaces/workspaces-billing-add-ons-decrease-preview-create)                      | Preview lowering the quantity of a recurring add-on                     |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/billing/add-ons/{grantId}/future-versions`](/http-api/reference/workspaces/workspaces-billing-add-ons-future-versions-create)                        | Opt a lifetime add-on out of or back into future versions               |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/billing/add-ons/{grantId}/upgrade`](/http-api/reference/workspaces/workspaces-billing-add-ons-upgrade-list)                                          | Quote upgrading a one-time or lifetime add-on to its current version    |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/billing/add-ons/{grantId}/upgrade`](/http-api/reference/workspaces/workspaces-billing-add-ons-upgrade-create)                                        | Upgrade a one-time or lifetime add-on to its current version            |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/billing/checkout`](/http-api/reference/workspaces/workspaces-billing-checkout-create)                                                                | Buy an add-on for the workspace                                         |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/billing/checkout/preview`](/http-api/reference/workspaces/workspaces-billing-checkout-preview-create)                                                | Preview the cost of buying a recurring add-on                           |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/billing/offers`](/http-api/reference/workspaces/workspaces-billing-offers-list)                                                                      | List the add-ons on sale to the workspace                               |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/billing/payment-method/default`](/http-api/reference/workspaces/workspaces-billing-payment-method-default-create)                                    | Make a saved card the workspace's default payment method                |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/billing/payment-method/setup`](/http-api/reference/workspaces/workspaces-billing-payment-method-setup-create)                                        | Start a card setup for the workspace                                    |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/calendars`](/http-api/reference/workspaces/workspaces-calendars-list)                                                                                | List the workspace's shared booking calendars                           |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/calendars`](/http-api/reference/workspaces/workspaces-calendars-create)                                                                              | Create a shared booking calendar for the workspace                      |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/calendars/{id}`](/http-api/reference/workspaces/workspaces-calendars-get)                                                                            | Get one of the workspace's calendars with the items booked on it        |
| PUT    | [`/api/v1/public/workspaces/{workspaceId}/calendars/{id}`](/http-api/reference/workspaces/workspaces-calendars-update)                                                                         | Replace a calendar's name, grid and settings                            |
| DELETE | [`/api/v1/public/workspaces/{workspaceId}/calendars/{id}`](/http-api/reference/workspaces/workspaces-calendars-delete)                                                                         | Delete a calendar that no item is booked on                             |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/coupons`](/http-api/reference/workspaces/workspaces-coupons-list)                                                                                    | List the workspace's coupons                                            |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/coupons`](/http-api/reference/workspaces/workspaces-coupons-create)                                                                                  | Create a coupon for the workspace's items                               |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/coupons/{id}`](/http-api/reference/workspaces/workspaces-coupons-get)                                                                                | Get one of the workspace's coupons                                      |
| PATCH  | [`/api/v1/public/workspaces/{workspaceId}/coupons/{id}`](/http-api/reference/workspaces/workspaces-coupons-update)                                                                             | Update the terms of one of the workspace's coupons                      |
| DELETE | [`/api/v1/public/workspaces/{workspaceId}/coupons/{id}`](/http-api/reference/workspaces/workspaces-coupons-delete)                                                                             | Delete one of the workspace's coupons                                   |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/credits`](/http-api/reference/workspaces/workspaces-credits-list)                                                                                    | Get the workspace's credit balance                                      |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/credits/auto-top-up`](/http-api/reference/workspaces/workspaces-credits-auto-top-up-list)                                                            | Get the workspace's automatic credit top-up setting                     |
| PATCH  | [`/api/v1/public/workspaces/{workspaceId}/credits/auto-top-up`](/http-api/reference/workspaces/workspaces-credits-auto-top-up-update)                                                          | Update the workspace's automatic credit top-up setting                  |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/credits/buckets`](/http-api/reference/workspaces/workspaces-credits-buckets-list)                                                                    | List the workspace's credit buckets                                     |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/credits/consume`](/http-api/reference/workspaces/workspaces-credits-consume-create)                                                                  | Consume credits from the workspace balance                              |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/credits/expiring`](/http-api/reference/workspaces/workspaces-credits-expiring-list)                                                                  | List credits expiring soon                                              |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/credits/holds`](/http-api/reference/workspaces/workspaces-credits-holds-list)                                                                        | List the workspace's credit holds                                       |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/credits/holds/{holdId}/release`](/http-api/reference/workspaces/workspaces-credits-holds-release-create)                                             | Release a credit hold in full                                           |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/credits/holds/{holdId}/settle`](/http-api/reference/workspaces/workspaces-credits-holds-settle-create)                                               | Settle a credit hold at its final cost                                  |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/credits/packages`](/http-api/reference/workspaces/workspaces-credits-packages-list)                                                                  | List the credit packages on sale                                        |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/credits/payment-method-setup`](/http-api/reference/workspaces/workspaces-credits-payment-method-setup-create)                                        | Start a Stripe page that saves a card for credit top-ups                |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/credits/purchase`](/http-api/reference/workspaces/workspaces-credits-purchase-create)                                                                | Start a Stripe Checkout session for a credit package                    |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/credits/reserve`](/http-api/reference/workspaces/workspaces-credits-reserve-create)                                                                  | Put workspace credits on hold                                           |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/credits/transactions`](/http-api/reference/workspaces/workspaces-credits-transactions-list)                                                          | List the workspace's credit transactions                                |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/enterprise`](/http-api/reference/workspaces/workspaces-enterprise-list)                                                                              | Get the enterprise SSO status of a workspace                            |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/enterprise/admins`](/http-api/reference/workspaces/workspaces-enterprise-admins-list)                                                                | List the company admins and their company roles                         |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/enterprise/admins`](/http-api/reference/workspaces/workspaces-enterprise-admins-create)                                                              | Name a company admin                                                    |
| PATCH  | [`/api/v1/public/workspaces/{workspaceId}/enterprise/admins/{userId}`](/http-api/reference/workspaces/workspaces-enterprise-admins-update)                                                     | Change a company admin's company role                                   |
| DELETE | [`/api/v1/public/workspaces/{workspaceId}/enterprise/admins/{userId}`](/http-api/reference/workspaces/workspaces-enterprise-admins-delete)                                                     | Remove a company admin                                                  |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/enterprise/agent-access`](/http-api/reference/workspaces/workspaces-enterprise-agent-access-list)                                                    | Get the company's agent access settings                                 |
| PATCH  | [`/api/v1/public/workspaces/{workspaceId}/enterprise/agent-access`](/http-api/reference/workspaces/workspaces-enterprise-agent-access-update)                                                  | Turn agent access on or off, or change its token lifetime               |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/enterprise/agent-access/check`](/http-api/reference/workspaces/workspaces-enterprise-agent-access-check-create)                                      | Re-read the agent issuer's discovery document and keys                  |
| PUT    | [`/api/v1/public/workspaces/{workspaceId}/enterprise/agent-access/issuer`](/http-api/reference/workspaces/workspaces-enterprise-agent-access-issuer-update)                                    | Set the identity provider trusted to approve agents                     |
| DELETE | [`/api/v1/public/workspaces/{workspaceId}/enterprise/agent-access/issuer`](/http-api/reference/workspaces/workspaces-enterprise-agent-access-issuer-delete)                                    | Stop trusting the company's agent issuer                                |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/enterprise/audit`](/http-api/reference/workspaces/workspaces-enterprise-audit-list)                                                                  | List the company's sign-in audit trail                                  |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/enterprise/audit/export`](/http-api/reference/workspaces/workspaces-enterprise-audit-export-list)                                                    | Export the company's audit trail as CSV                                 |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/enterprise/audit/exports`](/http-api/reference/workspaces/workspaces-enterprise-audit-exports-create)                                                | Request an export of the company's WorkOS audit log                     |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/enterprise/audit/exports/{exportId}`](/http-api/reference/workspaces/workspaces-enterprise-audit-exports-get)                                        | Get a WorkOS audit log export and its download link                     |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/enterprise/claim`](/http-api/reference/workspaces/workspaces-enterprise-claim-create)                                                                | Bring accounts on the company's domains into the company                |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/enterprise/connected-apps`](/http-api/reference/workspaces/workspaces-enterprise-connected-apps-list)                                                | List the apps and agents the company's people have connected            |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/enterprise/connected-apps/revoke`](/http-api/reference/workspaces/workspaces-enterprise-connected-apps-revoke-create)                                | Disconnect an app or agent for one person or the whole company          |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/enterprise/connected-apps/{clientId}`](/http-api/reference/workspaces/workspaces-enterprise-connected-apps-get)                                      | List one app's grants among the company's people                        |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/enterprise/domains/sync`](/http-api/reference/workspaces/workspaces-enterprise-domains-sync-create)                                                  | Re-read the company's verified domains from WorkOS                      |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/enterprise/groups`](/http-api/reference/workspaces/workspaces-enterprise-groups-list)                                                                | List the company's groups                                               |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/enterprise/groups`](/http-api/reference/workspaces/workspaces-enterprise-groups-create)                                                              | Create a company group                                                  |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/enterprise/groups/{groupId}`](/http-api/reference/workspaces/workspaces-enterprise-groups-get)                                                       | Get a company group                                                     |
| PATCH  | [`/api/v1/public/workspaces/{workspaceId}/enterprise/groups/{groupId}`](/http-api/reference/workspaces/workspaces-enterprise-groups-update)                                                    | Update a company group's name, people, workspaces or role               |
| DELETE | [`/api/v1/public/workspaces/{workspaceId}/enterprise/groups/{groupId}`](/http-api/reference/workspaces/workspaces-enterprise-groups-delete)                                                    | Delete a company group                                                  |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/enterprise/groups/{groupId}/candidates`](/http-api/reference/workspaces/workspaces-enterprise-groups-candidates-list)                                | Search the company's people who can be added to a group                 |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/enterprise/groups/{groupId}/managers`](/http-api/reference/workspaces/workspaces-enterprise-groups-managers-create)                                  | Name a group manager                                                    |
| DELETE | [`/api/v1/public/workspaces/{workspaceId}/enterprise/groups/{groupId}/managers/{userId}`](/http-api/reference/workspaces/workspaces-enterprise-groups-managers-delete)                         | Remove a group manager                                                  |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/enterprise/groups/{groupId}/members`](/http-api/reference/workspaces/workspaces-enterprise-groups-members-create)                                    | Add or remove the people named in a group                               |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/enterprise/groups/{groupId}/people`](/http-api/reference/workspaces/workspaces-enterprise-groups-people-list)                                        | List the people in a group                                              |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/enterprise/insights`](/http-api/reference/workspaces/workspaces-enterprise-insights-list)                                                            | Get the company's identity insights                                     |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/enterprise/join-requests`](/http-api/reference/workspaces/workspaces-enterprise-join-requests-list)                                                  | List requests to join the company                                       |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/enterprise/join-requests/{requestId}/approve`](/http-api/reference/workspaces/workspaces-enterprise-join-requests-approve-create)                    | Approve a request to join the company                                   |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/enterprise/join-requests/{requestId}/decline`](/http-api/reference/workspaces/workspaces-enterprise-join-requests-decline-create)                    | Decline a request to join the company                                   |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/enterprise/keys`](/http-api/reference/workspaces/workspaces-enterprise-keys-list)                                                                    | List the company's API keys                                             |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/enterprise/keys`](/http-api/reference/workspaces/workspaces-enterprise-keys-create)                                                                  | Create a company API key                                                |
| DELETE | [`/api/v1/public/workspaces/{workspaceId}/enterprise/keys/{keyId}`](/http-api/reference/workspaces/workspaces-enterprise-keys-delete)                                                          | Revoke a company API key                                                |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/enterprise/log-stream`](/http-api/reference/workspaces/workspaces-enterprise-log-stream-list)                                                        | Get the company's WorkOS log stream                                     |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/enterprise/log-streams`](/http-api/reference/workspaces/workspaces-enterprise-log-streams-list)                                                      | List the company's log streams to its SIEM                              |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/enterprise/log-streams`](/http-api/reference/workspaces/workspaces-enterprise-log-streams-create)                                                    | Add a log stream for the company                                        |
| PATCH  | [`/api/v1/public/workspaces/{workspaceId}/enterprise/log-streams/{streamId}`](/http-api/reference/workspaces/workspaces-enterprise-log-streams-update)                                         | Update one of the company's log streams                                 |
| DELETE | [`/api/v1/public/workspaces/{workspaceId}/enterprise/log-streams/{streamId}`](/http-api/reference/workspaces/workspaces-enterprise-log-streams-delete)                                         | Remove one of the company's log streams                                 |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/enterprise/log-streams/{streamId}/rotate-secret`](/http-api/reference/workspaces/workspaces-enterprise-log-streams-rotate-secret-create)             | Rotate a log stream's signing secret                                    |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/enterprise/log-streams/{streamId}/test`](/http-api/reference/workspaces/workspaces-enterprise-log-streams-test-create)                               | Send a test event to one of the company's log streams                   |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/enterprise/outsiders`](/http-api/reference/workspaces/workspaces-enterprise-outsiders-list)                                                          | List members of the company's workspaces who are outside the company    |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/enterprise/people`](/http-api/reference/workspaces/workspaces-enterprise-people-list)                                                                | List the company's people, newest first                                 |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/enterprise/people/{userId}/passkeys/reset`](/http-api/reference/workspaces/workspaces-enterprise-people-passkeys-reset-create)                       | Reset a person's passkeys and sign them out                             |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/enterprise/people/{userId}/sessions`](/http-api/reference/workspaces/workspaces-enterprise-people-sessions-list)                                     | List one of the company's people's live sessions                        |
| DELETE | [`/api/v1/public/workspaces/{workspaceId}/enterprise/people/{userId}/sessions/{sessionRef}`](/http-api/reference/workspaces/workspaces-enterprise-people-sessions-delete)                      | End one of a person's sessions                                          |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/enterprise/policy`](/http-api/reference/workspaces/workspaces-enterprise-policy-list)                                                                | Get the company's access policy                                         |
| PUT    | [`/api/v1/public/workspaces/{workspaceId}/enterprise/policy`](/http-api/reference/workspaces/workspaces-enterprise-policy-update)                                                              | Update the company's access policy                                      |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/enterprise/policy/workspaces`](/http-api/reference/workspaces/workspaces-enterprise-policy-workspaces-list)                                          | List the company's per-workspace policy exceptions                      |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/enterprise/policy/workspaces/{targetId}`](/http-api/reference/workspaces/workspaces-enterprise-policy-workspaces-get)                                | Get the stricter policy for one of the company's workspaces             |
| PUT    | [`/api/v1/public/workspaces/{workspaceId}/enterprise/policy/workspaces/{targetId}`](/http-api/reference/workspaces/workspaces-enterprise-policy-workspaces-update)                             | Set the stricter policy for one of the company's workspaces             |
| DELETE | [`/api/v1/public/workspaces/{workspaceId}/enterprise/policy/workspaces/{targetId}`](/http-api/reference/workspaces/workspaces-enterprise-policy-workspaces-delete)                             | Remove a workspace's policy exception                                   |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/enterprise/roles`](/http-api/reference/workspaces/workspaces-enterprise-roles-list)                                                                  | List the roles the company can give, with who holds each                |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/enterprise/roles`](/http-api/reference/workspaces/workspaces-enterprise-roles-create)                                                                | Create a company role                                                   |
| PATCH  | [`/api/v1/public/workspaces/{workspaceId}/enterprise/roles/{roleId}`](/http-api/reference/workspaces/workspaces-enterprise-roles-update)                                                       | Rename a company role or change what it allows                          |
| DELETE | [`/api/v1/public/workspaces/{workspaceId}/enterprise/roles/{roleId}`](/http-api/reference/workspaces/workspaces-enterprise-roles-delete)                                                       | Delete a company role                                                   |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/enterprise/service-accounts`](/http-api/reference/workspaces/workspaces-enterprise-service-accounts-list)                                            | List the company's service accounts                                     |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/enterprise/service-accounts`](/http-api/reference/workspaces/workspaces-enterprise-service-accounts-create)                                          | Create a service account for the company                                |
| PATCH  | [`/api/v1/public/workspaces/{workspaceId}/enterprise/service-accounts/{serviceAccountId}`](/http-api/reference/workspaces/workspaces-enterprise-service-accounts-update)                       | Update one of the company's service accounts                            |
| DELETE | [`/api/v1/public/workspaces/{workspaceId}/enterprise/service-accounts/{serviceAccountId}`](/http-api/reference/workspaces/workspaces-enterprise-service-accounts-delete)                       | Delete a service account and revoke its keys                            |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/enterprise/setup-link`](/http-api/reference/workspaces/workspaces-enterprise-setup-link-create)                                                      | Create a short-lived setup link for the company's IT admin              |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/enterprise/sign-out`](/http-api/reference/workspaces/workspaces-enterprise-sign-out-create)                                                          | Sign out one or all of the company's people                             |
| PUT    | [`/api/v1/public/workspaces/{workspaceId}/enterprise/sso/routing`](/http-api/reference/workspaces/workspaces-enterprise-sso-routing-update)                                                    | Replace which identity provider signs in each verified domain           |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/enterprise/unclaimed`](/http-api/reference/workspaces/workspaces-enterprise-unclaimed-list)                                                          | List accounts on the company's domains that are not its people yet      |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/enterprise/workload-identity`](/http-api/reference/workspaces/workspaces-enterprise-workload-identity-list)                                          | List the company's workload credentials and exchange details            |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/enterprise/workload-identity/check`](/http-api/reference/workspaces/workspaces-enterprise-workload-identity-check-create)                            | Dry-run an issuer's discovery and keys for a workload credential        |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/enterprise/workload-identity/credentials`](/http-api/reference/workspaces/workspaces-enterprise-workload-identity-credentials-create)                | Trust a CI job or cloud workload for a company service account          |
| PATCH  | [`/api/v1/public/workspaces/{workspaceId}/enterprise/workload-identity/credentials/{credentialId}`](/http-api/reference/workspaces/workspaces-enterprise-workload-identity-credentials-update) | Update a workload credential                                            |
| DELETE | [`/api/v1/public/workspaces/{workspaceId}/enterprise/workload-identity/credentials/{credentialId}`](/http-api/reference/workspaces/workspaces-enterprise-workload-identity-credentials-delete) | Delete a workload credential and end its live tokens                    |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/enterprise/workos-roles`](/http-api/reference/workspaces/workspaces-enterprise-workos-roles-list)                                                    | Get the company's WorkOS roles sync status                              |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/enterprise/workos-roles/refresh`](/http-api/reference/workspaces/workspaces-enterprise-workos-roles-refresh-create)                                  | Refresh the company's roles from WorkOS                                 |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/features`](/http-api/reference/workspaces/workspaces-by-workspace-id-features-list)                                                                  | Get the workspace's feature flags                                       |
| PATCH  | [`/api/v1/public/workspaces/{workspaceId}/features`](/http-api/reference/workspaces/workspaces-features-update)                                                                                | Toggle the workspace's user-managed features                            |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/files`](/http-api/reference/workspaces/workspaces-files-list)                                                                                        | List the workspace's files for buyers                                   |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/files/uploads`](/http-api/reference/workspaces/workspaces-files-uploads-create)                                                                      | Start an upload of a file for buyers                                    |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/files/uploads/{uploadId}/complete`](/http-api/reference/workspaces/workspaces-files-uploads-complete-create)                                         | Finish a file upload and return the stored file                         |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/files/{fileId}`](/http-api/reference/workspaces/workspaces-files-get)                                                                                | Get one of the workspace's files for buyers                             |
| DELETE | [`/api/v1/public/workspaces/{workspaceId}/files/{fileId}`](/http-api/reference/workspaces/workspaces-files-delete)                                                                             | Delete a file that no release holds                                     |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/grants`](/http-api/reference/workspaces/workspaces-grants-list)                                                                                      | List what the workspace holds beyond its plan                           |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/invitations`](/http-api/reference/workspaces/workspaces-invitations-list)                                                                            | List the workspace's invitations                                        |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/invitations`](/http-api/reference/workspaces/workspaces-invitations-create)                                                                          | Invite someone to the workspace by email                                |
| DELETE | [`/api/v1/public/workspaces/{workspaceId}/invitations/{id}`](/http-api/reference/workspaces/workspaces-invitations-delete)                                                                     | Revoke a pending invitation                                             |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/invitations/{id}/resend`](/http-api/reference/workspaces/workspaces-invitations-resend-create)                                                       | Send an invitation email again                                          |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/items`](/http-api/reference/workspaces/workspaces-items-list)                                                                                        | List the workspace's items                                              |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/items`](/http-api/reference/workspaces/workspaces-items-create)                                                                                      | Create a draft item sold by the workspace                               |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/items/{id}`](/http-api/reference/workspaces/workspaces-items-get)                                                                                    | Get one of the workspace's items                                        |
| PUT    | [`/api/v1/public/workspaces/{workspaceId}/items/{id}`](/http-api/reference/workspaces/workspaces-items-update)                                                                                 | Replace the content of one of the workspace's items                     |
| DELETE | [`/api/v1/public/workspaces/{workspaceId}/items/{id}`](/http-api/reference/workspaces/workspaces-items-delete)                                                                                 | Delete an item that was never listed or sold                            |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/items/{id}/archive`](/http-api/reference/workspaces/workspaces-items-archive-create)                                                                 | Archive one of the workspace's items                                    |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/items/{id}/booking/calendar-move`](/http-api/reference/workspaces/workspaces-items-booking-calendar-move-create)                                     | Move an item's upcoming bookings onto one of the workspace's calendars  |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/items/{id}/booking/calendar-move/preview`](/http-api/reference/workspaces/workspaces-items-booking-calendar-move-preview-create)                     | Preview moving an item's bookings onto one of the workspace's calendars |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/items/{id}/publish`](/http-api/reference/workspaces/workspaces-items-publish-create)                                                                 | Publish one of the workspace's items, or submit it for review           |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/items/{id}/unlist`](/http-api/reference/workspaces/workspaces-items-unlist-create)                                                                   | Unlist one of the workspace's items                                     |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/limits/{slug}`](/http-api/reference/workspaces/workspaces-limits-get)                                                                                | Get one of the workspace's limits and its claims standing               |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/limits/{slug}/claim`](/http-api/reference/workspaces/workspaces-limits-claim-create)                                                                 | Claim one unit of a workspace limit for a resource                      |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/limits/{slug}/claims`](/http-api/reference/workspaces/workspaces-limits-claims-list)                                                                 | List the active claims on a workspace limit                             |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/limits/{slug}/release`](/http-api/reference/workspaces/workspaces-limits-release-create)                                                             | Release a claim on a workspace limit                                    |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/notification-events`](/http-api/reference/workspaces/workspaces-notification-events-list)                                                            | List the notification events members can manage                         |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/notification-preferences`](/http-api/reference/workspaces/workspaces-notification-preferences-list)                                                  | Get the workspace's default notification preferences                    |
| PATCH  | [`/api/v1/public/workspaces/{workspaceId}/notification-preferences`](/http-api/reference/workspaces/workspaces-notification-preferences-update)                                                | Update the workspace's default notification preferences                 |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/notification-preferences/me`](/http-api/reference/workspaces/workspaces-notification-preferences-me-list)                                            | Get the caller's own notification preferences in the workspace          |
| PATCH  | [`/api/v1/public/workspaces/{workspaceId}/notification-preferences/me`](/http-api/reference/workspaces/workspaces-notification-preferences-me-update)                                          | Update the caller's own notification preferences in the workspace       |
| DELETE | [`/api/v1/public/workspaces/{workspaceId}/notifications/scheduled/{scheduledId}`](/http-api/reference/workspaces/workspaces-notifications-scheduled-delete)                                    | Cancel a scheduled notification send                                    |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/notifications/send`](/http-api/reference/workspaces/workspaces-notifications-send-create)                                                            | Send a notification event to one member or the whole workspace          |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/permissions`](/http-api/reference/workspaces/workspaces-permissions-list)                                                                            | Get the workspace's permission overrides by role                        |
| PATCH  | [`/api/v1/public/workspaces/{workspaceId}/permissions`](/http-api/reference/workspaces/workspaces-permissions-update)                                                                          | Set the workspace's permission overrides by role                        |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/permissions/me`](/http-api/reference/workspaces/workspaces-permissions-me-list)                                                                      | Get the permissions the caller holds in the workspace                   |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/quotas/{slug}`](/http-api/reference/workspaces/workspaces-quotas-get)                                                                                | Get the workspace's standing on one quota                               |
| PATCH  | [`/api/v1/public/workspaces/{workspaceId}/quotas/{slug}`](/http-api/reference/workspaces/workspaces-quotas-update)                                                                             | Set the workspace's spend cap and partition caps on a quota             |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/releases`](/http-api/reference/workspaces/workspaces-releases-list)                                                                                  | List the workspace's file releases                                      |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/releases`](/http-api/reference/workspaces/workspaces-releases-create)                                                                                | Create a draft file release for the workspace                           |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/releases/{id}`](/http-api/reference/workspaces/workspaces-releases-get)                                                                              | Get one of the workspace's file releases                                |
| PATCH  | [`/api/v1/public/workspaces/{workspaceId}/releases/{id}`](/http-api/reference/workspaces/workspaces-releases-update)                                                                           | Update a file release                                                   |
| DELETE | [`/api/v1/public/workspaces/{workspaceId}/releases/{id}`](/http-api/reference/workspaces/workspaces-releases-delete)                                                                           | Delete a draft file release                                             |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/releases/{id}/publish`](/http-api/reference/workspaces/workspaces-releases-publish-create)                                                           | Publish a draft file release                                            |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/sales`](/http-api/reference/workspaces/workspaces-sales-list)                                                                                        | List the workspace's sales as a seller                                  |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/sales/bookings`](/http-api/reference/workspaces/workspaces-sales-bookings-list)                                                                      | List the bookings made on the workspace's items                         |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/sales/bookings/{id}`](/http-api/reference/workspaces/workspaces-sales-bookings-get)                                                                  | Get a booking made on one of the workspace's items                      |
| PUT    | [`/api/v1/public/workspaces/{workspaceId}/sales/bookings/{id}/attendance`](/http-api/reference/workspaces/workspaces-sales-bookings-attendance-update)                                         | Mark whether the buyer attended a booking, or clear it                  |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/sales/bookings/{id}/cancel`](/http-api/reference/workspaces/workspaces-sales-bookings-cancel-create)                                                 | Cancel a booking made on one of the workspace's items                   |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/sales/bookings/{id}/reschedule`](/http-api/reference/workspaces/workspaces-sales-bookings-reschedule-create)                                         | Move a booking to another slot of its item                              |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/sales/export`](/http-api/reference/workspaces/workspaces-sales-export-list)                                                                          | Export the workspace's sales as a CSV file                              |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/sales/subscriptions`](/http-api/reference/workspaces/workspaces-sales-subscriptions-list)                                                            | List the subscriptions the workspace has sold                           |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/sales/subscriptions/{id}`](/http-api/reference/workspaces/workspaces-sales-subscriptions-get)                                                        | Get a subscription the workspace has sold                               |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/sales/subscriptions/{id}/cancel`](/http-api/reference/workspaces/workspaces-sales-subscriptions-cancel-create)                                       | Cancel a subscription the workspace has sold                            |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/sales/{id}`](/http-api/reference/workspaces/workspaces-sales-get)                                                                                    | Get one of the workspace's sales                                        |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/sales/{id}/lines/{lineKey}/fulfil`](/http-api/reference/workspaces/workspaces-sales-lines-fulfil-create)                                             | Mark a sale's line fulfilled or in progress                             |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/sales/{id}/parts/{index}/charge`](/http-api/reference/workspaces/workspaces-sales-parts-charge-create)                                               | Charge the balance of a sale paid by deposit                            |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/sales/{id}/refund`](/http-api/reference/workspaces/workspaces-sales-refund-create)                                                                   | Refund one of the workspace's sales                                     |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/sales/{id}/returns`](/http-api/reference/workspaces/workspaces-sales-returns-list)                                                                   | List the returns requested on one of the workspace's sales              |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/sales/{id}/returns/{returnId}/approve`](/http-api/reference/workspaces/workspaces-sales-returns-approve-create)                                      | Approve a requested return on one of the workspace's sales              |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/sales/{id}/returns/{returnId}/refund`](/http-api/reference/workspaces/workspaces-sales-returns-refund-create)                                        | Refund a return on one of the workspace's sales                         |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/sales/{id}/returns/{returnId}/reject`](/http-api/reference/workspaces/workspaces-sales-returns-reject-create)                                        | Reject a requested return on one of the workspace's sales               |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/sales/{id}/shipments`](/http-api/reference/workspaces/workspaces-sales-shipments-list)                                                               | List the shipments of one of the workspace's sales                      |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/sales/{id}/shipments`](/http-api/reference/workspaces/workspaces-sales-shipments-create)                                                             | Create a shipment for one of the workspace's sales                      |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/sales/{id}/shipments/{shipmentId}/label`](/http-api/reference/workspaces/workspaces-sales-shipments-label-list)                                      | Download a shipment's label                                             |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/sales/{id}/shipments/{shipmentId}/status`](/http-api/reference/workspaces/workspaces-sales-shipments-status-create)                                  | Set a shipment's status by hand                                         |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/selling`](/http-api/reference/workspaces/workspaces-selling-list)                                                                                    | Get the workspace's seller account and the app's selling settings       |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/selling`](/http-api/reference/workspaces/workspaces-selling-create)                                                                                  | Start selling as the workspace                                          |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/selling/co-sellers`](/http-api/reference/workspaces/workspaces-selling-co-sellers-list)                                                              | List the workspace's co-seller invitations                              |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/selling/co-sellers`](/http-api/reference/workspaces/workspaces-selling-co-sellers-create)                                                            | Invite another seller to share an item's sales                          |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/selling/co-sellers/{invitationId}/accept`](/http-api/reference/workspaces/workspaces-selling-co-sellers-accept-create)                               | Accept a co-seller invitation sent to the workspace                     |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/selling/co-sellers/{invitationId}/decline`](/http-api/reference/workspaces/workspaces-selling-co-sellers-decline-create)                             | Decline a co-seller invitation sent to the workspace                    |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/selling/co-sellers/{invitationId}/withdraw`](/http-api/reference/workspaces/workspaces-selling-co-sellers-withdraw-create)                           | Withdraw a co-seller invitation the workspace sent                      |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/selling/debit-terms/accept`](/http-api/reference/workspaces/workspaces-selling-debit-terms-accept-create)                                            | Accept the app owner's account debit terms for the workspace            |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/selling/session`](/http-api/reference/workspaces/workspaces-selling-session-create)                                                                  | Create a Stripe embedded components session for the seller              |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/selling/shipping`](/http-api/reference/workspaces/workspaces-selling-shipping-list)                                                                  | Get the workspace's seller shipping settings                            |
| PUT    | [`/api/v1/public/workspaces/{workspaceId}/selling/shipping`](/http-api/reference/workspaces/workspaces-selling-shipping-update)                                                                | Save the workspace's seller shipping settings                           |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/selling/sync`](/http-api/reference/workspaces/workspaces-selling-sync-create)                                                                        | Refresh the workspace's seller account from Stripe                      |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/selling/tax`](/http-api/reference/workspaces/workspaces-selling-tax-list)                                                                            | Get the workspace's own tax choice as a seller                          |
| PUT    | [`/api/v1/public/workspaces/{workspaceId}/selling/tax`](/http-api/reference/workspaces/workspaces-selling-tax-update)                                                                          | Choose whether Stripe Tax works out the tax on the workspace's sales    |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/shipping-rates`](/http-api/reference/workspaces/workspaces-shipping-rates-list)                                                                      | List the workspace's shipping rates                                     |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/shipping-rates`](/http-api/reference/workspaces/workspaces-shipping-rates-create)                                                                    | Create a shipping rate for the workspace                                |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/shipping-rates/{id}`](/http-api/reference/workspaces/workspaces-shipping-rates-get)                                                                  | Get one of the workspace's shipping rates                               |
| PUT    | [`/api/v1/public/workspaces/{workspaceId}/shipping-rates/{id}`](/http-api/reference/workspaces/workspaces-shipping-rates-update)                                                               | Replace one of the workspace's shipping rates                           |
| DELETE | [`/api/v1/public/workspaces/{workspaceId}/shipping-rates/{id}`](/http-api/reference/workspaces/workspaces-shipping-rates-delete)                                                               | Delete one of the workspace's shipping rates                            |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/subscription`](/http-api/reference/workspaces/workspaces-subscription-list)                                                                          | Get the workspace's current subscription, plan and capabilities         |
| PATCH  | [`/api/v1/public/workspaces/{workspaceId}/subscription`](/http-api/reference/workspaces/workspaces-subscription-update)                                                                        | Change the workspace's plan                                             |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/subscription/billing-contacts`](/http-api/reference/workspaces/workspaces-subscription-billing-contacts-list)                                        | List the workspace's billing contacts                                   |
| PUT    | [`/api/v1/public/workspaces/{workspaceId}/subscription/billing-contacts`](/http-api/reference/workspaces/workspaces-subscription-billing-contacts-update)                                      | Replace the workspace's billing contacts                                |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/subscription/billing-portal`](/http-api/reference/workspaces/workspaces-subscription-billing-portal-create)                                          | Create a Stripe Customer Portal session for the workspace               |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/subscription/cancel-at-period-end`](/http-api/reference/workspaces/workspaces-subscription-cancel-at-period-end-create)                              | Cancel the workspace's subscription at the end of the billing period    |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/subscription/cancel-now`](/http-api/reference/workspaces/workspaces-subscription-cancel-now-create)                                                  | Cancel the workspace's subscription immediately                         |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/subscription/checkout`](/http-api/reference/workspaces/workspaces-subscription-checkout-create)                                                      | Create a Stripe checkout session for the workspace                      |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/subscription/convert-to-paid`](/http-api/reference/workspaces/workspaces-subscription-convert-to-paid-create)                                        | End the workspace's trial now and pay for the plan                      |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/subscription/invoices`](/http-api/reference/workspaces/workspaces-subscription-invoices-list)                                                        | List the workspace's invoices                                           |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/subscription/invoices/{invoiceId}`](/http-api/reference/workspaces/workspaces-subscription-invoices-get)                                             | Get one of the workspace's invoices                                     |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/subscription/invoices/{invoiceId}/pay`](/http-api/reference/workspaces/workspaces-subscription-invoices-pay-create)                                  | Pay an open invoice of the workspace's subscription                     |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/subscription/move-to-user`](/http-api/reference/workspaces/workspaces-subscription-move-to-user-create)                                              | Move the workspace's plan onto the signed-in user                       |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/subscription/pause`](/http-api/reference/workspaces/workspaces-subscription-pause-create)                                                            | Pause the workspace's subscription after the paid period ends           |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/subscription/plan-group`](/http-api/reference/workspaces/workspaces-subscription-plan-group-list)                                                    | Get the plan group shown in the workspace's plan picker                 |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/subscription/plan-group/versions`](/http-api/reference/workspaces/workspaces-subscription-plan-group-versions-list)                                  | List the workspace's plan group version and any newer versions          |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/subscription/preview`](/http-api/reference/workspaces/workspaces-subscription-preview-create)                                                        | Preview what a plan change or ending the trial now will cost            |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/subscription/resume`](/http-api/reference/workspaces/workspaces-subscription-resume-create)                                                          | Resume the workspace's subscription                                     |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/subscription/retention-offer`](/http-api/reference/workspaces/workspaces-subscription-retention-offer-list)                                          | Get what the cancel dialog shows before cancelling                      |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/subscription/retention-offer/accept`](/http-api/reference/workspaces/workspaces-subscription-retention-offer-accept-create)                          | Accept the retention offer instead of cancelling                        |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/subscription/select-free-plan`](/http-api/reference/workspaces/workspaces-subscription-select-free-plan-create)                                      | Put the workspace on a free plan without checkout                       |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/subscription/transfer-payer`](/http-api/reference/workspaces/workspaces-subscription-transfer-payer-create)                                          | Move the workspace's subscription to another payer                      |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/subscription/trial-eligibility`](/http-api/reference/workspaces/workspaces-subscription-trial-eligibility-list)                                      | Check whether the signed-in user would get a trial in this workspace    |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/subscription/upcoming-invoice`](/http-api/reference/workspaces/workspaces-subscription-upcoming-invoice-list)                                        | Get the workspace's next invoice                                        |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/subscription/usage`](/http-api/reference/workspaces/workspaces-subscription-usage-create)                                                            | Record quota usage for the workspace                                    |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/subscription/usage/all`](/http-api/reference/workspaces/workspaces-subscription-usage-all-list)                                                      | Get usage status for every quota of the workspace                       |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/subscription/usage/batch`](/http-api/reference/workspaces/workspaces-subscription-usage-batch-create)                                                | Record several quota usage entries in one request                       |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/subscription/usage/logs`](/http-api/reference/workspaces/workspaces-subscription-usage-logs-list)                                                    | List the workspace's usage log entries                                  |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/subscription/usage/status`](/http-api/reference/workspaces/workspaces-subscription-usage-status-list)                                                | Get the usage status of one quota                                       |
| GET    | [`/api/v1/public/workspaces/{workspaceId}/users`](/http-api/reference/workspaces/workspaces-users-list)                                                                                        | List the members of a workspace                                         |
| POST   | [`/api/v1/public/workspaces/{workspaceId}/users/add`](/http-api/reference/workspaces/workspaces-users-add-create)                                                                              | Add a user to the workspace by email, or invite them                    |
| PATCH  | [`/api/v1/public/workspaces/{workspaceId}/users/{userId}`](/http-api/reference/workspaces/workspaces-users-update)                                                                             | Change a member's role                                                  |
| DELETE | [`/api/v1/public/workspaces/{workspaceId}/users/{userId}`](/http-api/reference/workspaces/workspaces-users-delete)                                                                             | Remove a member from the workspace, or leave it                         |

## Related

- [API reference](/http-api/reference): every tag
- [Workspaces guide](/workspaces/overview)
