Update an Instance's subscription

Authorizations

Authorization

string

headerrequired

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

instance_id

string

required

The instance ID

Query Parameters

expand

enum<string>[] | null

Comma-separated list of Instance expand paths.

Available options:

parent,

children

Body

application/json

subscription

enum<string>

required

The Instance's subscription tier.

Available options:

tier0,

tier1,

tier2,

tier3,

tier4,

tier5

Response

201 - application/json

string

required

The unique ID of the object.

entries_start

string

required

The datetime in UTC time from which the API will sync an Instance's accounting data. Transactions or journal entries cannot be entered before this date.

name

string

required

The name of the business.

subscription

enum<string>

required

The Instance's subscription tier.

Available options:

tier0,

tier1,

tier2,

tier3,

tier4,

tier5

accounting_package

enum<string>

required

The type of accounting package the Instance uses as the source of truth for their books.

Available options:

platformgl,

quickbooks

parent_id

string | null

The ID of the Instance's parent.

child_ids

string[] | null

The IDs of the Instance's children.

parent

any | null

The Instance's parent. Included in expanded responses.

children

object[] | null

The Instance's children. Included in expanded responses.

children.id

string

required

The unique ID of the object.

children.entries_start

string

required

The datetime in UTC time from which the API will sync an Instance's accounting data. Transactions or journal entries cannot be entered before this date.

children.name

string

required

The name of the business.

children.subscription

enum<string>

required

The Instance's subscription tier.

Available options:

tier0,

tier1,

tier2,

tier3,

tier4,

tier5

children.accounting_package

enum<string>

required

The type of accounting package the Instance uses as the source of truth for their books.

Available options:

platformgl,

quickbooks

children.parent_id

string | null

The ID of the Instance's parent.

children.child_ids

string[] | null

The IDs of the Instance's children.

children.parent

any | null

The Instance's parent. Included in expanded responses.

children.children

object[] | null

The Instance's children. Included in expanded responses.

children.children.id

string

required

The unique ID of the object.

children.children.entries_start

string

required

The datetime in UTC time from which the API will sync an Instance's accounting data. Transactions or journal entries cannot be entered before this date.

children.children.name

string

required

The name of the business.

children.children.subscription

enum<string>

required

The Instance's subscription tier.

Available options:

tier0,

tier1,

tier2,

tier3,

tier4,

tier5

children.children.accounting_package

enum<string>

required

The type of accounting package the Instance uses as the source of truth for their books.

Available options:

platformgl,

quickbooks

children.children.parent_id

string | null

The ID of the Instance's parent.

children.children.child_ids

string[] | null

The IDs of the Instance's children.

children.children.parent

any | null

The Instance's parent. Included in expanded responses.

children.children.children

object[] | null

The Instance's children. Included in expanded responses.

children.children.children.id

string

required

The unique ID of the object.

children.children.children.entries_start

string

required

The datetime in UTC time from which the API will sync an Instance's accounting data. Transactions or journal entries cannot be entered before this date.

children.children.children.name

string

required

The name of the business.

children.children.children.subscription

enum<string>

required

The Instance's subscription tier.

Available options:

tier0,

tier1,

tier2,

tier3,

tier4,

tier5

children.children.children.accounting_package

enum<string>

required

The type of accounting package the Instance uses as the source of truth for their books.

Available options:

platformgl,

quickbooks

children.children.children.parent_id

string | null

The ID of the Instance's parent.

children.children.children.child_ids

string[] | null

The IDs of the Instance's children.

children.children.children.parent

any | null

The Instance's parent. Included in expanded responses.

children.children.children.children

object[] | null

The Instance's children. Included in expanded responses.

children.children.children.children.id

string

required

The unique ID of the object.

children.children.children.children.entries_start

string

required

The datetime in UTC time from which the API will sync an Instance's accounting data. Transactions or journal entries cannot be entered before this date.

children.children.children.children.name

string

required

The name of the business.

children.children.children.children.subscription

enum<string>

required

The Instance's subscription tier.

Available options:

tier0,

tier1,

tier2,

tier3,

tier4,

tier5

children.children.children.children.accounting_package

enum<string>

required

The type of accounting package the Instance uses as the source of truth for their books.

Available options:

platformgl,

quickbooks

children.children.children.children.parent_id

string | null

The ID of the Instance's parent.

children.children.children.children.child_ids

string[] | null

The IDs of the Instance's children.

children.children.children.children.parent

any | null

The Instance's parent. Included in expanded responses.

children.children.children.children.children

object[] | null

The Instance's children. Included in expanded responses.

API overview

Teal API Endpoints

API Migration

Update an Instance's subscription

Authorizations

Path Parameters

Query Parameters

Body

Response