Sandbox

The sandbox object

An isolated test account owned by a production account.

A sandbox is a full account with its own data, so anything created or changed inside it leaves your production data untouched.

idstring

Sandbox ID.

objectstringenumValues:sandbox

Resource type identifier.

namestring

Display name of the sandbox.

owner_accountaccountnullable

The production account that owns this sandbox.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

The account's display name.

default_billing_addressaddressnullable

The address billed by default on orders for this account.

Always returned as null in this endpoint.
default_shipping_addressaddressnullable

The address shipped to by default on orders for this account.

Always returned as null in this endpoint.
brandingaccount_brandingnullable

Customer-facing branding for the account, such as the logo, support contacts, and social links.

Always returned as null in this endpoint.
portalaccount_portalnullable

The account's customer portal settings, including the portal URL slug.

Always returned as null in this endpoint.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

When this sandbox was created.

updated_atstring (date-time)

When this sandbox was last updated.

Used by

POSTCreate SandboxSandboxGETList SandboxesSandboxGETRetrieve SandboxSandboxDELETEDelete SandboxSandbox