user

list

The identifier of the organization.

When not set the user's flows are returned.

Otherwise if the user is an admin of the provided organization then
the flows associated with that organization are returned.

organizationId

Filter the results by the specified flow type.

type

Whether to filter out flows not in the `START_PENDING` or `STARTED`
state.

active

Whether to only return flows created by the authenticated user.

creator

The maximum number of flows to return. The API may return fewer than
this value.

If unspecified, at most 20 flows will be returned.
The maximum value is 100; values above 100 will be coerced to 100.

pageSize

A page token, received from a previous list flows call.
Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to list flows must match
the call that provided the page token.

pageToken

A comma-separated list of fields to order by.

Supports:
- `createTime desc`

orderBy

Creates a join organization flow.

This invites a person to join an organization.

create-join-organization

The identifier of the user.

This is required if email is not specified.

userId

The email address of the person to invite.

This is required if user is not specified or the user
does not have an email address.

email

The display name of the person to invite.

displayName

Creates a signup flow.

This invites a person to join the app.

create-signup

The email address of the person to invite.

Whether to create an organization as part of the signup flow.

createOrganization

The identifier of the flow or the flow secret.

flowId

Approve a flow.

This will approve the specified flow and start the next step
in the flow (e.g. for a join organization flow it will send the
invitee an email with a link to join the organization).

approve

Consume the flow.

This accepts the flow (e.g. for a join organization flow it will
accept the invitation and add the member to the organization).

consume

Cancels specified flow.

This cancels the flow and hides it from the user.

cancel

flows

Show results for specified organization.

If this is not provided the user's individual subscription(s)
will be returned.

The maximum number of invoices to return. The API may return fewer than
this value.

If unspecified, at most 20 invoices will be returned.
The maximum value is 100; values above 100 will be coerced to 100.

A page token, received from a previous list invoices call.
Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to list invoices must match
the call that provided the page token.

A comma-separated list of fields to order by.

Supports:
- `createTime asc`
- `createTime desc`

invoiceId

invoices

The maximum number of organizations to return. The API may return fewer than
this value.

If unspecified, at most 20 organizations will be returned.
The maximum value is 100; values above 100 will be coerced to 100.

A page token, received from a previous list organizations call.
Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to list organizations must match
the call that provided the page token.

A comma-separated list of fields to order by.

Supports:
- `displayName asc`
- `email asc`

create

The client defined unique identifier of the organization account.

It is restricted to letters, numbers, underscores, and hyphens,
with the first character a letter or a number, and a 255
character maximum.

ID's starting with `org_` are reserved.

uniqueId

The human-readable display name of the organization.

The maximum length is 200 characters.

The email address of the organization.

The maximum length is 320 characters.

The flow identifier associated with the creation of the organization.

The flow type must be `SIGNUP` and associated with the user creating the organization.

update

delete

Leave organization.

This allows a user to remove themselves from an organization
without have permission to manage the organization.

leave

organizations

Exchange an ID token from your IdP for an access token.

exchange-token

The IdP ID token which is used to authenticated the user.

token

create-portal

The identifier of the organization.

When specified the `{accountId}` in the `portalUrl` will be
replaced with the organization ID, otherwise the user ID
will be used.

The Portal URL, this is the target URL on the portal site.

If not defined the root URL for the portal will be used.

This does not need to be the full URL, you have the option
of passing in a path instead (e.g. `/`).

You also have the option of including the `{accountId}`
string in the path/URL which will be replaced with either the
UserHub user ID (if `organizationId` is not specified)
or the UserHub organization ID (if specified).

Examples:
* `/{accountId}` - the billing dashboard
* `/{accountId}/checkout` - start a checkout
* `/{accountId}/checkout/<some-plan-id>` - start a checkout with a specified plan
* `/{accountId}/cancel` - cancel current plan
* `/{accountId}/members` - manage organization members
* `/{accountId}/invite` - invite a user to an organization

portalUrl

The URL the user should be sent to when they want to return to
the app (e.g. cancel checkout).

If not defined the app URL will be used.

returnUrl

The URL the user should be sent after they successfully complete
an action (e.g. checkout).

If not defined the return URL will be used.

Create an organization

body parameters

Returns

Create an organization

.css-10iahqc{text-transform:capitalize;}body parameters

Returns

body parameters