BETA: Please note that the current endpoints are considered beta. It is possible there may be changes before these endpoints are finalised.

Organizations

Get an Organization

Get organization token is authorized for

get /organizations/{organizationId}

Parameters

Name	Type	In	Description
`organizationId`	string	path	Organization ID

Responses

200: OK response.Organization

{
  "createdAt": "2012-08-08T02:35:21Z",
  "currency": "NZD",
  "id": "01H0S97D8RX4RBFHHTB1HE7SFR",
  "name": "My Awesome Business",
  "timezone": "Australia/Melbourne"
}

404: not_found: Not Found response.

List Organizations

List all organizations based on a token

get /organizations

Parameters

Name	Type	In	Description
`after`	string	query	The cursor to use for pagination. Do not use this field manually it will be automatically provided in the response headers (see Paging guide).
`query`	string	query

Responses

200: OK response.Organization[]

[
  {
    "createdAt": "2012-08-08T02:35:21Z",
    "currency": "AUD",
    "id": "01H0S97D8RX4RBFHHTB1HE7SFR",
    "name": "My Awesome Business",
    "timezone": "Australia/Melbourne"
  },
  {
    "createdAt": "2012-08-08T02:35:21Z",
    "currency": "AUD",
    "id": "01H0S97D8RX4RBFHHTB1HE7SFR",
    "name": "My Awesome Business",
    "timezone": "Australia/Melbourne"
  },
  {
    "createdAt": "2012-08-08T02:35:21Z",
    "currency": "AUD",
    "id": "01H0S97D8RX4RBFHHTB1HE7SFR",
    "name": "My Awesome Business",
    "timezone": "Australia/Melbourne"
  },
  {
    "createdAt": "2012-08-08T02:35:21Z",
    "currency": "AUD",
    "id": "01H0S97D8RX4RBFHHTB1HE7SFR",
    "name": "My Awesome Business",
    "timezone": "Australia/Melbourne"
  }
]

Models

Organization

Name	Type	Description
id	string	Unique organization ID
name	string	Display name of the organization
createdAt	string	Timestamp this org was created
currency	string(enum)	(optional) The currency used for purchases for this organization "AUD", "SGD", "GBP", "NZD", "USD"
timezone	string	(optional) Timezone this organization is in

OrganizationTiny

Name	Type	Description
id	string	Unique organization ID
name	string	Display name of the organization

In this article