Skip to navigation

Get

What the workspace pays for, as Settings → Billing shows it. Requires billing:read; a signed-in session must be a workspace admin’s.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

This endpoint returns an object.
billingIntervalenum
How often the subscription is billed. Every line of one subscription shares it.
Allowed values:
annualAvailableboolean
Whether yearly billing can be chosen here. It needs a yearly price for every app.
billingAvailableboolean

Whether this installation can take a subscription at all. When it cannot, updateSubscription answers 409 billing_unavailable.

autoJoinboolean

Whether any verified email domain has autoJoin on, so people can join without an invitation.

autoGrowSeatsboolean

The workspace’s autoGrowSeats (PATCH /organization): with autoJoin, whether full apps grow for newcomers or they wait.

appslist of objects
paymentIssueenumOptional

Absent (null) while every payment has gone through.

Allowed values:
cardAddedAtdatetimeOptional

When a card was put on file, by a completed Checkout or in the billing portal. Absent with no card, or once it is removed. Set, the workspace has subscribed: its trials carry on into the paid plan, and the app stops showing the trial banner.

Errors

401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error