Accounts API

account

/accounts/{account}

Information and actions related to an account.

get

Get information about an account.

response

content-typestatuses

application/json

200

schema

type

object

additionalProperties

false

required

address, name, email

properties
address
description

The address for this account.

type

string

name
description

The name for this account. Suitable for use within HX contexts.

type

string

email
description

The email for this account.

type

string

format

email

put

request

content-type

application/json

schema

type

object

additionalProperties

false

required

address, name, email

properties
address
description

The address for this account.

type

string

name
description

The name for this account. Suitable for use within HX contexts.

type

string

email
description

The email for this account.

type

string

format

email

response

content-typestatuses

application/json

200

schema

type

object

additionalProperties

false

required

address, name, email

properties
address
description

The address for this account.

type

string

name
description

The name for this account. Suitable for use within HX contexts.

type

string

email
description

The email for this account.

type

string

format

email

delete

response

content-typestatuses

application/json

200

schema

type

object

additionalProperties

false

required

address, name, email

properties
address
description

The address for this account.

type

string

name
description

The name for this account. Suitable for use within HX contexts.

type

string

email
description

The email for this account.

type

string

format

email

account-query

/accounts-query?{email}

get

response

content-typestatuses

application/json

200, 404

schema

type

object

additionalProperties

false

required

address, name, email

properties
address
description

The address for this account.

type

string

name
description

The name for this account. Suitable for use within HX contexts.

type

string

email
description

The email for this account.

type

string

format

email

accounts

/accounts

post

request

content-type

application/json

schema

type

object

additionalProperties

false

required

name, email

properties
name
description

The name for this account. Suitable for use within HX contexts.

type

string

email
description

The email for this account.

type

string

format

email

response

content-typestatuses

application/json

201

schema

type

object

additionalProperties

false

required

address, name, email

properties
address
description

The address for this account.

type

string

name
description

The name for this account. Suitable for use within HX contexts.

type

string

email
description

The email for this account.

type

string

format

email

billing

/pages/{workspace}/billing

post

response

content-typestatuses

text/plain

200

checkout

/pages/{workspace}/checkout

post

request

content-type

application/json

schema

type

object

additionalProperties

false

required

prices

properties
prices
description

The Stripe price ids for this checkout session.

type

array

items
type

string

trial_period_days
description

An optional trial period for the checkout session.

type

integer

trial_require_card
description

An optional flag that sets whether a credit card is required for trials.

type

boolean

success_url
description

An optional url to redirect to when a checkout session is successful.

type

string

format

uri

cancel_url
description

An optional url to redirect to when a checkout session is cancelled.

type

string

format

uri

response

content-typestatuses

text/plain

200

plan

/plans/{plan}

get

response

content-typestatuses

application/json

200

schema

type

object

additionalProperties

false

required

stripe_price_id, price, interval, name, description, stripe_product_id, address

properties
stripe_price_id
description

The Stripe price id for this plan.

type

string

price
description

The formatted price for this plan. Suitable for use within HX contexts.

type

string

interval
description

The subscription interval for this plan. Suitable for use within HX contexts.

type

string

name
description

The name of this plan. Suitable for use within HX contexts.

type

string

description
description

The description of this plan. Suitable for use within HX contexts.

type

string

stripe_product_id
description

The Stripe product id for this plan.

type

string

address
description

The address for this plan.

type

string

feature_list
description

An optional list of features for this plan. Suitable for use within HX contexts.

type

array

items
type

string

product

/products/{product}

get

response

content-typestatuses

application/json

200

schema

type

object

additionalProperties

false

required

stripe_price_id, price, interval, name, description, stripe_product_id, address

properties
plans
description

A list of plan addresses for this product.

type

array

items
type

string

byname
description

The byname of this product.

type

string

products

/products

get

response

content-typestatuses

application/json

200

schema

description

A list of all the product bynames.

type

array

items
type

string

subscription

/workspaces/{workspace}/subscriptions/{product}

get

response

content-typestatuses

application/json

200, 404

schema

type

object

additionalProperties

false

required

product, plan, status, workspace, stripe_id, metadata, address, cancel_at_period_end, current_period_end

properties
product
description

The byname of the product for this subscription.

type

string

plan
description

The address of the plan for this subscription.

type

string

status
description

The status of this subscription.

type

string

workspace
description

The address of the workspace this subscription belongs to.

type

string

stripe_id
description

The Stripe id for this subscription.

type

string

metadata
description

The metadata of this subscription.

type

object

address
description

The address of this subscription.

cancel_at_period_end
description

A flag that indicates whether this subscription is set to cancel at the end of the billing period.

type

boolean

current_period_end
description

The end of the current billing period, given as a UNIX timestamp.

type

integer

subscriptions

/workspaces/{workspace}/subscriptions

get

response

content-typestatuses

application/json

200

schema

type

array

items
type

object

additionalProperties

false

required

product, plan, status, workspace, stripe_id, metadata, address, cancel_at_period_end, current_period_end

properties
product
description

The byname of the product for this subscription.

type

string

plan
description

The address of the plan for this subscription.

type

string

status
description

The status of this subscription.

type

string

workspace
description

The address of the workspace this subscription belongs to.

type

string

stripe_id
description

The Stripe id for this subscription.

type

string

metadata
description

The metadata of this subscription.

type

object

address
description

The address of this subscription.

cancel_at_period_end
description

A flag that indicates whether this subscription is set to cancel at the end of the billing period.

type

boolean

current_period_end
description

The end of the current billing period, given as a UNIX timestamp.

type

integer

subscription-metadata

/workspaces/{workspace}/subscriptions/{product}/metadata

get

response

content-typestatuses

application/json

200

schema

type

object

put

request

content-type

application/json

schema

type

object

response

content-typestatuses

application/json

200

schema

type

object

delete

response

statuses

204

webhook-stripe

/webhooks/stripe

post

request

content-type

application/json

response

statuses

200

workspace

/workspaces/{workspace}

get

response

content-typestatuses

application/json

200

schema

type

object

additionalProperties

false

required

address, name, shared

properties
address
description

The address for this workspace.

type

string

name
description

The name for this workspace. Suitable for use withing HX contexts.

type

string

shared
description

A flag that indicates whether this workspace has more than 1 member.

type

boolean

stripe_customer_id
description

An optional Stripe customer id for this workspace.

type

string

put

request

content-type

application/json

schema

type

object

additionalProperties

false

required

address, name, shared

properties
address
description

The address for this workspace.

type

string

name
description

The name for this workspace. Suitable for use withing HX contexts.

type

string

shared
description

A flag that indicates whether this workspace has more than 1 member.

type

boolean

stripe_customer_id
description

An optional Stripe customer id for this workspace.

type

string

response

content-typestatuses

application/json

200

schema

type

object

additionalProperties

false

required

address, name, shared

properties
address
description

The address for this workspace.

type

string

name
description

The name for this workspace. Suitable for use withing HX contexts.

type

string

shared
description

A flag that indicates whether this workspace has more than 1 member.

type

boolean

stripe_customer_id
description

An optional Stripe customer id for this workspace.

type

string

delete

response

statuses

204

workspace-accounts

/workspaces/{workspace}/accounts

get

response

content-typestatuses

application/json

200

schema

type

array

items
type

object

additionalProperties

false

required

role, address

properties
role
description

The role of this account in this workspace.

type

string

address
description

The address of this account.

type

string

workspace-invites

/workspaces/{workspace}/invites

get

response

content-typestatuses

application/json

200

schema

type

array

items
type

object

additionalProperties

false

required

email, role, sender

properties
email
description

The email of the person invited to this workspace.

type

string

format

email

role
description

The role of the invite to this workspace.

type

string

sender
description

The email of the account that sent this invite.

type

string

format

email

post

request

content-type

application/json

schema

type

array

items
type

object

additionalProperties

false

required

email, role, sender

properties
email
description

The email of the person invited to this workspace.

type

string

format

email

role
description

The role of the invite to this workspace.

type

string

sender
description

The email of the account that sent this invite.

type

string

format

email

response

content-typestatuses

application/json

201

schema

type

array

items
type

object

additionalProperties

false

required

email, role, sender

properties
email
description

The email of the person invited to this workspace.

type

string

format

email

role
description

The role of the invite to this workspace.

type

string

sender
description

The email of the account that sent this invite.

type

string

format

email

workspace-invite-accept

/workspaces/{workspace}/invites/{account}/accept

post

response

content-typestatuses

application/json

201

schema

type

object

additionalProperties

false

required

role, address

properties
role
description

The role of this account in this workspace.

type

string

address
description

The address of this account.

type

string

workspace-account

/workspaces/{workspace}/accounts/{account}

get

response

content-typestatuses

application/json

200

schema

type

object

additionalProperties

false

required

role, address

properties
role
description

The role of this account in this workspace.

type

string

address
description

The address of this account.

type

string

put

request

content-type

application/json

schema

type

object

additionalProperties

false

required

role, address

properties
role
description

The role of this account in this workspace.

type

string

address
description

The address of this account.

type

string

response

content-typestatuses

application/json

200

schema

type

object

additionalProperties

false

required

role, address

properties
role
description

The role of this account in this workspace.

type

string

address
description

The address of this account.

type

string

delete

response

statuses

204

workspace-invite

/workspaces/{workspace}/invites/{email}

get

response

content-typestatuses

application/json

200

schema

type

object

additionalProperties

false

required

email, role, sender

properties
email
description

The email of the person invited to this workspace.

type

string

format

email

role
description

The role of the invite to this workspace.

type

string

sender
description

The email of the account that sent this invite.

type

string

format

email

put

request

content-type

application/json

schema

type

object

additionalProperties

false

required

email, role, sender

properties
email
description

The email of the person invited to this workspace.

type

string

format

email

role
description

The role of the invite to this workspace.

type

string

sender
description

The email of the account that sent this invite.

type

string

format

email

response

content-typestatuses

application/json

200

schema

type

object

additionalProperties

false

required

email, role, sender

properties
email
description

The email of the person invited to this workspace.

type

string

format

email

role
description

The role of the invite to this workspace.

type

string

sender
description

The email of the account that sent this invite.

type

string

format

email

delete

response

statuses

204

account-workspaces

/accounts/{account}/workspaces?{role?}

get

response

content-typestatuses

application/json

200

schema

description

A list of workspace addresses.

type

array

items
type

string

post

request

content-type

application/json

schema

type

object

additionalProperties

false

required

name

properties
name
description

The name for this workspace.

type

string

response

content-typestatuses

application/json

201

schema

type

object

additionalProperties

false

required

address, name, shared

properties
address
description

The address for this workspace.

type

string

name
description

The name for this workspace. Suitable for use withing HX contexts.

type

string

shared
description

A flag that indicates whether this workspace has more than 1 member.

type

boolean

stripe_customer_id
description

An optional Stripe customer id for this workspace.

type

string

account-workspace-leave

/accounts/{account}/workspaces/{workspace}/leave

post

response

statuses

204

account-workspace-invites

/accounts/{account}/workspaces/invites

get

response

content-typestatuses

application/json

200

schema

description

A list of workspace addresses this account is invited to.

type

array

items
type

string