user

The identifier of the organization.

If not specified the billing account for the user is returned.

organizationId

update

The identifier of the organization.

If not specified the billing account for the user is used.

The human-readable display name of the billing account.

The maximum length is 200 characters.

This might be further restricted by the billing provider.

displayName

The email address of the billing account.

The maximum length is 320 characters.

This might be further restricted by the billing provider.

email

The E164 phone number of the billing account (e.g. `+12125550123`).

phoneNumber

address

billing-account

create

Attempt to submit checkout if ready and due amount is zero.

submit

The identifier of the organization.

This must be provided for organization checkouts.

type

The identifier of the plan.

This allows you to specify the currently selected plan.

planId

checkoutId

set-plan

The identifier of the plan.

This is required if completed isn't set to true.

Mark the step completed if it is optional.

completed

Set terms for a checkout.

This is generally used to select a billing cycle for
the plan.

set-terms

set-items

items

set-payment-method

The identifier of the payment method.

This is required if external ID isn't specified or completed
isn't set to true.

paymentMethodId

The external identifier of the payment method to connect.

This is required if payment method ID isn't specified or
completed isn't set to true.

externalId

set-billing-details

The company or individual's full name.

The maximum length is 200 characters.

fullName

add-discount

code

remove-discount

checkoutDiscountId

complete-payment

cancel

checkouts

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.

Filter the results by the specified flow 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.

orderBy

Create a new 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.

The display name of the person to invite.

roleId

update-join-organization

flowId

Create a new 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.

Consume a 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

Cancel a flow.

This cancels the flow and hides it from the user.

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.

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.

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.

list-members

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

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

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

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

get-member

update-member

Assign a seat to an organization member.

This will automatically purchase additional seats if none
are available and the plan has just-in-time seat provisioning
enabled.

assign-member-seat

Unassign a seat from an organization member.

unassign-member-seat

remove-member

delete

Leave an organization.

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

leave

organizations

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

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

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

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

The external identifier of the payment method to connect.

Create a new payment method intent.

This can be used with a third-party billing provider to
store a payment method.

create-intent

The full name of the owner of the payment method (e.g. `Jane Doe`).

expYear

expMonth

Set a default payment method for an account.

set-default

payment-methods

Whether to get pricing for users or organizations.

This is not required if organization ID is specified
and will default to user if no options are specified.

accountType

Show pricing for specified organization.

If this and account type are not specified, it will default to
the requesting user for authenticated requests.

Always get the current public pricing.

For unauthenticated requests, this is always true.

public

pricing

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

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

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

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

roles

Exchange an ID token from an 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 a payment method intent

body parameters

Returns

Create a payment method intent

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

Returns

body parameters