GraphQL Account API reference

Queries

`account`

Description

An account.

Response

Returns an Account!

Example

Query

query account {
  account {
    accountInfo {
      ...AccountInfoFragment
    }
    apps {
      ...AppsConnectionFragment
    }
    checkout {
      ...CheckoutFragment
    }
    id
    stores {
      ...StoreConnectionFragment
    }
    subscriptions {
      ...SubscriptionConnectionFragment
    }
    users {
      ...UserConnectionFragment
    }
  }
}

Response

{
  "data": {
    "account": {
      "accountInfo": AccountInfo,
      "apps": AppsConnection,
      "checkout": Checkout,
      "id": "4",
      "stores": StoreConnection,
      "subscriptions": SubscriptionConnection,
      "users": UserConnection
    }
  }
}

Queries

`node`

Description

Fetches an object given its ID.

Response

Returns a Node

Arguments

Name	Description
`id` - `ID!`	The ID of the object.

Example

Query

query node($id: ID!) {
  node(id: $id) {
    id
  }
}

Variables

{"id": 4}

Response

{"data": {"node": {"id": "4"}}}

Queries

`nodes`

Description

Fetches objects given their IDs.

Response

Returns [Node]!

Arguments

Name	Description
`ids` - `[ID!]!`	The IDs of the objects.

Example

Query

query nodes($ids: [ID!]!) {
  nodes(ids: $ids) {
    id
  }
}

Variables

{"ids": ["4"]}

Response

{"data": {"nodes": [{"id": 4}]}}

Queries

`system`

Description

System settings.

Response

Returns a System!

Example

Query

query system {
  system {
    time
  }
}

Response

{"data": {"system": {"time": {}}}}

Mutations

`account`

Description

Account mutations.

Response

Returns an AccountMutations!

Example

Query

mutation account {
  account {
    addUserToAccount {
      ...AddUserToAccountResultFragment
    }
    removeUserFromAccount {
      ...RemoveUserFromAccountResultFragment
    }
  }
}

Response

{
  "data": {
    "account": {
      "addUserToAccount": AddUserToAccountResult,
      "removeUserFromAccount": RemoveUserFromAccountResult
    }
  }
}

Mutations

`app`

Description

App mutations.

Response

Returns an AppMutations!

Example

Query

mutation app {
  app {
    createEventSource {
      ...CreateEventSourceResultFragment
    }
    deleteEventSource {
      ...DeleteEventSourceResultFragment
    }
  }
}

Response

{
  "data": {
    "app": {
      "createEventSource": CreateEventSourceResult,
      "deleteEventSource": DeleteEventSourceResult
    }
  }
}

Mutations

`checkout`

Description

Checkout mutations.

Response

Returns a CheckoutMutations!

Example

Query

mutation checkout {
  checkout {
    createCheckout {
      ...CreateCheckoutResultFragment
    }
  }
}

Response

{
  "data": {
    "checkout": {"createCheckout": CreateCheckoutResult}
  }
}

Mutations

`subscription`

Description

Subscription mutations.

Response

Returns a SubscriptionMutations!

Example

Query

mutation subscription {
  subscription {
    cancelSubscription {
      ...CancelSubscriptionResultFragment
    }
  }
}

Response

{
  "data": {
    "subscription": {
      "cancelSubscription": CancelSubscriptionResult
    }
  }
}

Mutations

`user`

Description

User mutations.

Response

Returns a UserMutations!

Example

Query

mutation user {
  user {
    addUserToStore {
      ...AddUserToStoreResultFragment
    }
    createUserWithPassword {
      ...CreateUserWithPasswordResultFragment
    }
    removeUserFromStore {
      ...RemoveUserFromStoreResultFragment
    }
  }
}

Response

{
  "data": {
    "user": {
      "addUserToStore": AddUserToStoreResult,
      "createUserWithPassword": CreateUserWithPasswordResult,
      "removeUserFromStore": RemoveUserFromStoreResult
    }
  }
}

Types

Account

Description

An account.

Fields

Field Name	Description
`accountInfo` - `AccountInfo!`	Provides account details.
`apps` - `AppsConnection!`	Apps owned by the account.
Arguments `before` - `String` `after` - `String` `first` - `Int` `last` - `Int`
`checkout` - `Checkout`	Allows for billing a Merchant for Products on a one-time or recurring basis.
Arguments `id` - `ID!` The ID of the object.
`id` - `ID!`	The ID of the object.
`stores` - `StoreConnection!`	The stores related to an account.
Arguments `filter` - `StoreFilterInput` Filter stores by IDs or store hashes. `before` - `String` `after` - `String` `first` - `Int` `last` - `Int`
`subscriptions` - `SubscriptionConnection!`	Subscriptions belonging to the account.
Arguments `filters` - `SubscriptionFiltersInput` `first` - `Int` `after` - `String` `last` - `Int` `before` - `String`
`users` - `UserConnection!`	Users belonging to the account.
Arguments `before` - `String` `after` - `String` `first` - `Int` `last` - `Int`

Example

{
  "accountInfo": AccountInfo,
  "apps": AppsConnection,
  "checkout": Checkout,
  "id": 4,
  "stores": StoreConnection,
  "subscriptions": SubscriptionConnection,
  "users": UserConnection
}

Types

AccountInfo

Description

Account details.

Fields

Field Name	Description
`name` - `String!`	The name of an account.

Example

{"name": "abc123"}

Types

AccountMutations

Description

Account mutations.

Fields

Field Name	Description
`addUserToAccount` - `AddUserToAccountResult`	Adds a user to an account.
Arguments `input` - `AddUserToAccountInput!`
`removeUserFromAccount` - `RemoveUserFromAccountResult`	Removes a user from an account.
Arguments `input` - `RemoveUserFromAccountInput!`

Example

{
  "addUserToAccount": AddUserToAccountResult,
  "removeUserFromAccount": RemoveUserFromAccountResult
}

Types

AddUserToAccountInput

Fields

Input Field	Description
`email` - `String!`	The email of the user to be added to the account.

Example

{"email": "abc123"}

Types

AddUserToAccountResult

Fields

Field Name	Description
`account` - `Account`	An account the user was added to.

Example

{"account": Account}

Types

AddUserToStoreInput

Fields

Input Field	Description
`storeId` - `ID!`	The store the user is to be added.
`user` - `UserIdentifierInput!`	The user to be added to the store.

Example

{
  "storeId": "4",
  "user": UserIdentifierInput
}

Types

AddUserToStoreResult

Fields

Field Name	Description
`storeId` - `ID!`	The ID of the object.

Example

{"storeId": 4}

Types

App

Description

An application.

Fields

Field Name	Description
`id` - `ID!`	The ID of the object.
`name` - `String!`	The app name.
`eventSources` - `AwsEventSourcesConnection!`	Amazon EventSources.
Arguments `before` - `String` `after` - `String` `first` - `Int` `last` - `Int`

Example

{
  "id": 4,
  "name": "xyz789",
  "eventSources": AwsEventSourcesConnection
}

Types

AppMutations

Description

App mutations.

Fields

Field Name	Description
`createEventSource` - `CreateEventSourceResult`	Creates an Amazon EventSource.
Arguments `input` - `CreateEventSourceInput!`
`deleteEventSource` - `DeleteEventSourceResult`	Deletes an Amazon EventSource.
Arguments `input` - `DeleteEventSourceInput!`

Example

{
  "createEventSource": CreateEventSourceResult,
  "deleteEventSource": DeleteEventSourceResult
}

Types

AppsConnection

Description

A connection to a list of items.

Fields

Field Name	Description
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`edges` - `[AppsEdge]`	A list of edges.

Example

{
  "pageInfo": PageInfo,
  "edges": [AppsEdge]
}

Types

AppsEdge

Description

An edge in a connection.

Fields

Field Name	Description
`node` - `App!`	The item at the end of the edge.
`cursor` - `String!`	A cursor for use in pagination.

Example

{
  "node": App,
  "cursor": "abc123"
}

Types

AwsEventSource

Description

An Amazon EventSource.

Fields

Field Name	Description
`id` - `ID!`	The ID of an object.
`awsAccount` - `String!`	An Amazon EventSource account ID.
`eventSourceName` - `String!`	An event source name.
`eventSourceRegion` - `AwsRegion!`	The region of an event source.
`arn` - `String!`	An Amazon EventSource resource name.
`webhooksCount` - `Long!`	Number of webhooks attached to an Amazon EventSource.

Example

{
  "id": 4,
  "awsAccount": "xyz789",
  "eventSourceName": "xyz789",
  "eventSourceRegion": "AF_SOUTH_1",
  "arn": "xyz789",
  "webhooksCount": {}
}

Types

AwsEventSourcesConnection

Description

A connection to a list of items.

Fields

Field Name	Description
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`edges` - `[AwsEventSourcesEdge]`	A list of edges.

Example

{
  "pageInfo": PageInfo,
  "edges": [AwsEventSourcesEdge]
}

Types

AwsEventSourcesEdge

Description

An edge in a connection.

Fields

Field Name	Description
`node` - `AwsEventSource!`	The item at the end of the edge.
`cursor` - `String!`	A cursor for use in pagination.

Example

{
  "node": AwsEventSource,
  "cursor": "xyz789"
}

Types

AwsRegion

Description

The Amazon EventSource region.

Values

Enum Value	Description
`AF_SOUTH_1`	af-south-1
`AP_EAST_1`	ap-east-1
`AP_NORTHEAST_1`	ap-northeast-1
`AP_NORTHEAST_2`	ap-northeast-2
`AP_NORTHEAST_3`	ap-northeast-3
`AP_SOUTHEAST_1`	ap-southeast-1
`AP_SOUTHEAST_2`	ap-southeast-2
`AP_SOUTHEAST_3`	ap-southeast-3
`AP_SOUTHEAST_4`	ap-southeast-4
`AP_SOUTH_1`	ap-south-1
`AP_SOUTH_2`	ap-south-2
`CA_CENTRAL_1`	ca-central-1
`EU_CENTRAL_1`	eu-central-1
`EU_CENTRAL_2`	eu-central-2
`EU_NORTH_1`	eu-north-1
`EU_SOUTH_1`	eu-south-1
`EU_SOUTH_2`	eu-south-2
`EU_WEST_1`	eu-west-1
`EU_WEST_2`	eu-west-2
`EU_WEST_3`	eu-west-3
`IL_CENTRAL_1`	il-central-1
`ME_CENTRAL_1`	me-central-1
`SA_EAST_1`	sa-east-1
`US_EAST_1`	us-east-1
`US_EAST_2`	us-east-2
`US_WEST_1`	us-west-1
`US_WEST_2`	us-west-2

Example

"AF_SOUTH_1"

Types

BigDecimal

Description

The BigDecimal scalar type represents signed fractional values with arbitrary precision.

Example

BigDecimal

Types

Boolean

Description

The Boolean scalar type represents true or false.

Example

true

Types

CancelSubscriptionInput

Fields

Input Field	Description
`id` - `ID!`	The ID of the Subscription.

Example

{"id": "4"}

Types

CancelSubscriptionResult

Fields

Field Name	Description
`subscriptionId` - `ID`	The ID of the Subscription.
`cancelledAt` - `DateTime`	The date the subscription will be cancelled.

Example

{
  "subscriptionId": 4,
  "cancelledAt": "2007-12-03T10:15:30Z"
}

Types

Checkout

Description

A container for all information needed to charge a Merchant for products on a one-time or recurring basis.

Fields

Field Name	Description
`id` - `ID!`	The ID of the object.
`accountId` - `ID!`	The merchant's account UUID.
`checkoutUrl` - `String!`	The URL for redirecting the merchant to the BigCommerce hosted checkout page.
`items` - `CheckoutItemConnection!`	The item(s) associated with the checkout.
Arguments `before` - `String` `after` - `String` `first` - `Int` `last` - `Int`
`status` - `CheckoutStatus`	The current status of the checkout.

Example

{
  "id": "4",
  "accountId": 4,
  "checkoutUrl": "abc123",
  "items": CheckoutItemConnection,
  "status": "COMPLETE"
}

Types

CheckoutItem

Description

Individual line items describing one-time or recurring charges to be billed to the Merchant upon completing the Checkout.

Fields

Field Name	Description
`description` - `String`	A description of this line item.
`pricingPlan` - `CheckoutItemPricingPlan!`	The pricing plan denoting how to bill the Merchant for this Product.
`product` - `CheckoutItemProduct!`	The product the Merchant will be entitled to after the Checkout is complete.
`redirectUrl` - `String`	The URL used to redirect the Merchant after completing the Checkout.
`scope` - `CheckoutItemScope!`	The scope for this Line Item (e.g. store, account).
`status` - `CheckoutItemStatus`	The status of this line item.
`subscriptionId` - `ID`	If available, the ID of the Subscription associated with this Line Item.

Example

{
  "description": "abc123",
  "pricingPlan": CheckoutItemPricingPlan,
  "product": CheckoutItemProduct,
  "redirectUrl": "abc123",
  "scope": CheckoutItemScope,
  "status": "COMPLETE",
  "subscriptionId": 4
}

Types

CheckoutItemConnection

Description

A connection to a list of items.

Fields

Field Name	Description
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`edges` - `[CheckoutItemEdge]`	A list of edges.

Example

{
  "pageInfo": PageInfo,
  "edges": [CheckoutItemEdge]
}

Types

CheckoutItemEdge

Description

An edge in a connection.

Fields

Field Name	Description
`node` - `CheckoutItem!`	The item at the end of the edge.
`cursor` - `String!`	A cursor for use in pagination.

Example

{
  "node": CheckoutItem,
  "cursor": "abc123"
}

Types

CheckoutItemInput

Description

Input needed to create a CheckoutItem.

Fields

Input Field	Description
`description` - `String!`	A description the line item.
`pricingPlan` - `PricingPlanInput!`	How to bill the Merchant for this Product.
`product` - `CheckoutItemProductInput`	The product the Merchant will be entitled to after the Checkout is complete.
`redirectUrl` - `String!`	URL used to redirect the Merchant after successfully completing the Checkout.
`scope` - `CheckoutItemScopeInput`	The scope for this line item (e.g. store, account).
`subscriptionId` - `ID`	When left blank, a new subscription will be created upon successful completion of the Checkout. To create a Checkout for updating an existing subscription, include the subscription ID of the existing subscription, which will be updated upon successful completion of the Checkout.

Example

{
  "description": "abc123",
  "pricingPlan": PricingPlanInput,
  "product": CheckoutItemProductInput,
  "redirectUrl": "xyz789",
  "scope": CheckoutItemScopeInput,
  "subscriptionId": "4"
}

Types

CheckoutItemPricingInterval

Description

The billing interval representing how often to charge the Merchant for this product.

Values

Enum Value	Description
`ANNUAL`	Charge the Merchant on a recurring basis each year on their Account's billing day.
`MONTH`	Charge the Merchant on a recurring basis each month on their Account's billing day.
`ONCE`	Charge the Merchant only one time, immediately.
`QUARTER`	Charge the Merchant on a recurring basis each quarter on their Account's billing day.
`SEMIANNUAL`	Charge the Merchant on a recurring basis every six months on their Account's billing day.

Example

"ANNUAL"

Types

CheckoutItemPricingPlan

Description

The container for all pricing information.

Fields

Field Name	Description
`interval` - `CheckoutItemPricingInterval`	The billing interval for the subscription.
`price` - `Money`	The amount to charge for each interval.
`trialDays` - `Int`	Number of days to delay billing to offer a free trial period.

Example

{"interval": "ANNUAL", "price": Money, "trialDays": 987}

Types

CheckoutItemProduct

Description

The product the Merchant is purchasing.

Fields

Field Name	Description
`id` - `ID`	The unique ID of the product.
`productLevel` - `String`	A description of the product level, if applicable (e.g. app tier for an application).
`type` - `CheckoutItemProductType`	The type of product (e.g. APPLICATION).

Example

{
  "id": 4,
  "productLevel": "xyz789",
  "type": "APPLICATION"
}

Types

CheckoutItemProductInput

Description

The input information needed to set the CheckoutItemProduct on a CheckoutItem.

Fields

Input Field	Description
`id` - `ID`	Product's unique identifier.
`productLevel` - `String`	A description of the product level, if applicable. (e.g. app tier for an application).
`type` - `CheckoutItemProductType`	The type of this product (e.g. APPLICATION).

Example

{
  "id": 4,
  "productLevel": "abc123",
  "type": "APPLICATION"
}

Types

CheckoutItemProductType

Description

The type of product.

Values

Enum Value	Description
`APPLICATION`	Type for applications available in the BigCommerce App Marketplace.

Example

"APPLICATION"

Types

CheckoutItemScope

Description

The scope to which the purchase should be limited.

Fields

Field Name	Description
`id` - `ID`	The unique ID of the scope.
`type` - `CheckoutItemScopeType`	Where to scope access for this item (e.g. STORE).

Example

{"id": "4", "type": "STORE"}

Types

CheckoutItemScopeInput

Description

The input information needed to set the CheckoutItemScope on a CheckoutItem.

Fields

Input Field	Description
`id` - `ID`	Scope's unique identifier.
`type` - `CheckoutItemScopeType`	Scope of access for the associated product (e.g. STORE).

Example

{"id": 4, "type": "STORE"}

Types

CheckoutItemScopeType

Description

The scope of access to be granted upon successful completion of the Checkout.

Values

Enum Value	Description
`STORE`	Limits access for the purchased product to a particular Store.

Example

"STORE"

Types

CheckoutItemStatus

Description

The current status of the Checkout Item.

Values

Enum Value	Description
`COMPLETE`	The Merchant has been invoiced and any necessary provisioning or Subscription updates have been completed.
`PENDING`	This CheckoutItem has been created, but has not yet been accepted by the Merchant.
`PROCESSING`	This CheckoutItem has been approved by the Merchant and BigCommerce is in the process of handling any provisioning or Subscription updates (if necessary).

Example

"COMPLETE"

Types

CheckoutMutations

Description

Checkout mutations.

Fields

Field Name	Description
`createCheckout` - `CreateCheckoutResult`	Creates a Checkout for a Merchant.
Arguments `input` - `CreateCheckoutInput!`

Example

{"createCheckout": CreateCheckoutResult}

Types

CheckoutStatus

Description

The current status of the Checkout.

Values

Enum Value	Description
`COMPLETE`	The Merchant has been invoiced and any necessary provisioning or Subscription updates have been completed.
`PENDING`	This Checkout has been created, but has not yet been accepted by the Merchant.
`PROCESSING`	This Checkout has been approved by the Merchant and BigCommerce is in the process of handling any provisioning or Subscription updates (if necessary).

Example

"COMPLETE"

Types

CollectionInfo

Description

Collection details.

Fields

Field Name	Description
`totalItems` - `Long`	The total number of items in the collection.

Example

{"totalItems": {}}

Types

CreateCheckoutInput

Fields

Input Field	Description
`accountId` - `ID!`	Merchant's account UUID.
`items` - `[CheckoutItemInput!]!`	Product and billing details used to create a Checkout for the Merchant.

Example

{
  "accountId": "4",
  "items": [CheckoutItemInput]
}

Types

CreateCheckoutResult

Fields

Field Name	Description
`checkout` - `Checkout`	The Checkout that is created as a result of mutation.

Example

{"checkout": Checkout}

Types

CreateEventSourceInput

Fields

Input Field	Description
`appId` - `ID!`	The ID of an app.
`awsAccount` - `String!`	An Amazon EventSource account ID.
`eventSourceName` - `String!`	An event source name.
`eventSourceRegion` - `AwsRegion!`	The region of an event source.

Example

{
  "appId": "4",
  "awsAccount": "abc123",
  "eventSourceName": "xyz789",
  "eventSourceRegion": "AF_SOUTH_1"
}

Types

CreateEventSourceResult

Fields

Field Name	Description
`eventSource` - `AwsEventSource`	The Amazon EventSource created as a result of mutation.

Example

{"eventSource": AwsEventSource}

Types

CreateUserWithPasswordInput

Fields

Input Field	Description
`email` - `String!`	The email of the user to be added to the account.
`firstName` - `String!`	The first name of the user to be added to the account.
`lastName` - `String!`	The last name of the user to be added to the account.
`locale` - `String!`	The locale of the user to be added to the account.
`password` - `String!`	The password of the user to be added to the account.
`passwordConfirmation` - `String!`	Enter password again to confirm.

Example

{
  "email": "abc123",
  "firstName": "xyz789",
  "lastName": "xyz789",
  "locale": "xyz789",
  "password": "abc123",
  "passwordConfirmation": "xyz789"
}

Types

CreateUserWithPasswordResult

Fields

Field Name	Description
`user` - `User`	Created user.

Example

{"user": User}

Types

CurrencyCode

Description

Currency Code.

Values

Enum Value	Description
`AED`
`AFN`
`ALL`
`AMD`
`ANG`
`AOA`
`ARS`
`AUD`
`AWG`
`AZN`
`BAM`
`BBD`
`BDT`
`BGN`
`BHD`
`BIF`
`BMD`
`BND`
`BOB`
`BOV`
`BRL`
`BSD`
`BTN`
`BWP`
`BYN`
`BYR`
`BZD`
`CAD`
`CDF`
`CHE`
`CHF`
`CHW`
`CLF`
`CLP`
`CNY`
`COP`
`COU`
`CRC`
`CUC`
`CUP`
`CVE`
`CZK`
`DJF`
`DKK`
`DOP`
`DZD`
`EGP`
`ERN`
`ETB`
`EUR`
`FJD`
`FKP`
`GBP`
`GEL`
`GHS`
`GIP`
`GMD`
`GNF`
`GTQ`
`GYD`
`HKD`
`HNL`
`HRK`
`HTG`
`HUF`
`IDR`
`ILS`
`INR`
`IQD`
`IRR`
`ISK`
`JMD`
`JOD`
`JPY`
`KES`
`KGS`
`KHR`
`KMF`
`KPW`
`KRW`
`KWD`
`KYD`
`KZT`
`LAK`
`LBP`
`LKR`
`LRD`
`LSL`
`LYD`
`MAD`
`MDL`
`MGA`
`MKD`
`MMK`
`MNT`
`MOP`
`MRO`
`MRU`
`MUR`
`MVR`
`MWK`
`MXN`
`MYR`
`MZN`
`NAD`
`NGN`
`NIO`
`NOK`
`NPR`
`NZD`
`OMR`
`PAB`
`PEN`
`PGK`
`PHP`
`PKR`
`PLN`
`PYG`
`QAR`
`RON`
`RSD`
`RUB`
`RWF`
`SAR`
`SBD`
`SCR`
`SDG`
`SEK`
`SGD`
`SHP`
`SLL`
`SOS`
`SRD`
`SSP`
`STD`
`STN`
`SVC`
`SYP`
`SZL`
`THB`
`TJS`
`TMT`
`TND`
`TOP`
`TRY`
`TTD`
`TWD`
`TZS`
`UAH`
`UGX`
`USD`
`USN`
`UYI`
`UYU`
`UZS`
`VEF`
`VES`
`VND`
`VUV`
`WST`
`XAF`
`XAG`
`XAU`
`XBA`
`XBB`
`XBC`
`XBD`
`XCD`
`XDR`
`XOF`
`XPD`
`XPF`
`XPT`
`XSU`
`XTS`
`XUA`
`XXX`
`YER`
`ZAR`
`ZMW`
`ZWL`

Example

"AED"

Types

DateTime

Description

ISO-8601 formatted date in UTC

Example

"2007-12-03T10:15:30Z"

Types

DeleteEventSourceInput

Fields

Input Field	Description
`appId` - `ID!`	The ID of an app.
`id` - `ID!`	The ID of the object.

Example

{"appId": 4, "id": "4"}

Types

DeleteEventSourceResult

Fields

Field Name	Description
`deletedEventSourceId` - `ID!`	The ID of the object.
`affectedWebhooksIds` - `[ID!]!`	The IDs of affected webhooks by event source delete mutation. Their status is automatically changed to disabled.

Example

{
  "deletedEventSourceId": "4",
  "affectedWebhooksIds": ["4"]
}

Types

ID

Description

The ID scalar type represents a unique identifier, often used to re-fetch an object or as key for a cache.

Example

Types

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example

Types

Long

Description

The Long scalar type represents non-fractional signed whole numeric values. Long can represent values between -(2^63) and 2^63 - 1.

Example

{}

Types

Money

Description

A money object - includes currency code and a money amount.

Fields

Field Name	Description
`currencyCode` - `String!`	Currency code of the current money.
`value` - `BigDecimal!`	The amount of money.

Example

{
  "currencyCode": "abc123",
  "value": BigDecimal
}

Types

MoneyInput

Description

Input to create a Money object.

Fields

Input Field	Description
`currencyCode` - `CurrencyCode!`	The ISO 4217 currency code.
`value` - `BigDecimal!`	The monetary amount. Must be a positive decimal number. For example, 10.10 with a currency code of USD represents $10.10.

Example

{"currencyCode": "AED", "value": BigDecimal}

Types

Node

Description

An object with an ID.

Fields

Field Name	Description
`id` - `ID!`	The ID of the object.

Possible Types

Node Types
`Checkout`
`Subscription`

Example

{"id": "4"}

Types

PageInfo

Description

Information about pagination in a connection.

Fields

Field Name	Description
`hasNextPage` - `Boolean!`	When paginating forwards, are there more items?
`hasPreviousPage` - `Boolean!`	When paginating backwards, are there more items?
`startCursor` - `String`	When paginating backwards, the cursor to continue.
`endCursor` - `String`	When paginating forwards, the cursor to continue.

Example

{
  "hasNextPage": false,
  "hasPreviousPage": true,
  "startCursor": "xyz789",
  "endCursor": "xyz789"
}

Types

PricingPlanInput

Description

The inputs needed to set the PricingPlan when creating a CheckoutItem.

Fields

Input Field	Description
`interval` - `CheckoutItemPricingInterval!`	The billing interval for this line item (e.g. ONCE, MONTH, etc).
`price` - `MoneyInput!`	The price to charge the merchant per billing interval.
`trialDays` - `Int`	The number of days to delay billing and allow for a free trial.

Example

{
  "interval": "ANNUAL",
  "price": MoneyInput,
  "trialDays": 987
}

Types

RemoveUserFromAccountInput

Description

Input needed to remove a user from an account.

Fields

Input Field	Description
`email` - `String`	The email of the user to be removed from the account.
`userId` - `ID`	The id of the user to be removed.

Example

{"email": "abc123", "userId": 4}

Types

RemoveUserFromAccountResult

Fields

Field Name	Description
`accountId` - `ID!`	The ID of the object.
`userId` - `ID!`	The ID of the object.

Example

{
  "accountId": "4",
  "userId": "4"
}

Types

RemoveUserFromStoreInput

Fields

Input Field	Description
`storeId` - `ID!`	The store from which user is to be removed.
`userId` - `ID!`	The user to be removed.

Example

{
  "storeId": "4",
  "userId": "4"
}

Types

RemoveUserFromStoreResult

Fields

Field Name	Description
`storeId` - `ID!`	The store from which the user is removed from.
`user` - `User`	Removed user.

Example

{
  "storeId": "4",
  "user": User
}

Types

Store

Description

A store related to an account.

Fields

Field Name	Description
`id` - `ID!`	The ID of the object.
`apps` - `AppsConnection!`	The list of store apps.
Arguments `before` - `String` `after` - `String` `first` - `Int` `last` - `Int`
`name` - `String!`	The store name for the store.
`storeHash` - `String!`	The store hash for the store.
`users` - `StoreUserConnection!`	Users belonging to the store.
Arguments `before` - `String` `after` - `String` `first` - `Int` `last` - `Int`

Example

{
  "id": 4,
  "apps": AppsConnection,
  "name": "xyz789",
  "storeHash": "abc123",
  "users": StoreUserConnection
}

Types

StoreConnection

Description

A connection to a list of items.

Fields

Field Name	Description
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`edges` - `[StoreEdge]`	A list of edges.

Example

{
  "pageInfo": PageInfo,
  "edges": [StoreEdge]
}

Types

StoreEdge

Description

An edge in a connection.

Fields

Field Name	Description
`node` - `Store!`	The item at the end of the edge.
`cursor` - `String!`	A cursor for use in pagination.

Example

{
  "node": Store,
  "cursor": "xyz789"
}

Types

StoreFilterInput

Description

The input needed to filter stores.

Fields

Input Field	Description
`ids` - `[ID!]`	The ID of the stores.
`storeHashes` - `[String!]`	The store hashes.

Example

{
  "ids": ["4"],
  "storeHashes": ["xyz789"]
}

Types

StoreUser

Description

A user belonging to a store.

Fields

Field Name	Description
`id` - `ID!`	The ID of the object.
`apps` - `AppsConnection!`	Apps accessible by the user on the store.
Arguments `before` - `String` `after` - `String` `first` - `Int` `last` - `Int`
`email` - `String!`	The email for the user.
`firstName` - `String!`	First name.
`lastLoginAt` - `DateTime`	When the user last logged in.
`lastName` - `String!`	Last name.
`locale` - `String!`	User preferred locale.
`permissions` - `[String!]!`	The permissions for the user on the store.
`status` - `StoreUserStatus`	Current status of the user for the store.
`updatedAt` - `DateTime`	When was the user last updated.

Example

{
  "id": "4",
  "apps": AppsConnection,
  "email": "xyz789",
  "firstName": "xyz789",
  "lastLoginAt": "2007-12-03T10:15:30Z",
  "lastName": "xyz789",
  "locale": "abc123",
  "permissions": ["abc123"],
  "status": "ACTIVE",
  "updatedAt": "2007-12-03T10:15:30Z"
}

Types

StoreUserConnection

Description

A connection to a list of items.

Fields

Field Name	Description
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`edges` - `[StoreUserEdge]`	A list of edges.
`collectionInfo` - `CollectionInfo`	Collection details.

Example

{
  "pageInfo": PageInfo,
  "edges": [StoreUserEdge],
  "collectionInfo": CollectionInfo
}

Types

StoreUserEdge

Description

An edge in a connection.

Fields

Field Name	Description
`node` - `StoreUser!`	The item at the end of the edge.
`cursor` - `String!`	A cursor for use in pagination.

Example

{
  "node": StoreUser,
  "cursor": "xyz789"
}

Types

StoreUserStatus

Description

The status of the user on the store.

Values

Enum Value	Description
`ACTIVE`	The user is active.
`INACTIVE`	The user is inactive.

Example

"ACTIVE"

Types

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example

"xyz789"

Types

Subscription

Description

A one-time or recurring charge for a Product created as a result of a Merchant completing a Checkout.

Fields

Field Name	Description
`id` - `ID!`	The ID of the object.
`accountId` - `ID!`	ID of the account associated with the subscription.
`activationDate` - `DateTime!`	The date when the Subscription becomes active, ending any trial period, and billing the Merchant for the first time.
`billingInterval` - `SubscriptionBillingInterval!`	The frequency of charges for the Merchant.
`createdAt` - `DateTime!`	The date the subscription was created.
`currentPeriodEnd` - `DateTime`	The end of the current billing interval for the Merchant.
`pricePerInterval` - `Money`	The price the Merchant pays each billing interval.
`product` - `SubscriptionProduct!`	The product the Merchant is entitled to with this Subscription.
`status` - `SubscriptionStatus`	The status of this subscription.
`scope` - `SubscriptionScope!`	The scope of the subscription.
`updatedAt` - `DateTime!`	The date the subscription was last updated.

Example

{
  "id": "4",
  "accountId": "4",
  "activationDate": "2007-12-03T10:15:30Z",
  "billingInterval": "ANNUAL",
  "createdAt": "2007-12-03T10:15:30Z",
  "currentPeriodEnd": "2007-12-03T10:15:30Z",
  "pricePerInterval": Money,
  "product": SubscriptionProduct,
  "status": "ACTIVE",
  "scope": SubscriptionScope,
  "updatedAt": "2007-12-03T10:15:30Z"
}

Types

SubscriptionBillingInterval

Description

The frequency of charges for a Merchant.

Values

Enum Value	Description
`ANNUAL`	The Merchant will be billed on a recurring basis each year on their Account's billing day.
`MONTH`	The Merchant will be billed on a recurring basis each month on their Account's billing day.
`NONE`	The Merchant was billed one time, at creation, and will not charge on a recurring basis.
`ONCE`	The Merchant will be billed only once.
`QUARTER`	The Merchant will be billed on a recurring basis each quarter on their Account's billing day.
`SEMIANNUAL`	The Merchant will be billed on a recurring basis every six months on their Account's billing day.

Example

"ANNUAL"

Types

SubscriptionConnection

Description

A connection to a list of subscriptions.

Fields

Field Name	Description
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`edges` - `[SubscriptionEdge]`	A list of subscription edges.

Example

{
  "pageInfo": PageInfo,
  "edges": [SubscriptionEdge]
}

Types

SubscriptionEdge

Description

An edge in a connection.

Fields

Field Name	Description
`node` - `Subscription!`	The item at the end of the edge.
`cursor` - `String!`	A cursor for use in pagination.

Example

{
  "node": Subscription,
  "cursor": "xyz789"
}

Types

SubscriptionFiltersInput

Fields

Input Field	Description
`ids` - `[ID!]`	A list of subscription IDs for filtering the query.
`productId` - `ID`	A product ID for filtering the query.
`productType` - `SubscriptionProductType`	A product type for filtering the query.
`scopeId` - `ID`	A scope ID for filtering the query.
`scopeType` - `SubscriptionScopeType`	A scope type for filtering the query.
`status` - `SubscriptionStatus`	A status for filtering the query.
`updatedAfter` - `DateTime`	A date for filtering the query.

Example

{
  "ids": ["4"],
  "productId": "4",
  "productType": "APPLICATION",
  "scopeId": "4",
  "scopeType": "STORE",
  "status": "ACTIVE",
  "updatedAfter": "2007-12-03T10:15:30Z"
}

Types

SubscriptionMutations

Description

Subscription mutations.

Fields

Field Name	Description
`cancelSubscription` - `CancelSubscriptionResult`	Cancels a Subscription for a Merchant.
Arguments `input` - `CancelSubscriptionInput!`

Example

{"cancelSubscription": CancelSubscriptionResult}

Types

SubscriptionProduct

Description

The product the Merchant is entitled to with this Subscription.

Fields

Field Name	Description
`id` - `ID!`	The unique ID of the product.
`type` - `SubscriptionProductType`	The type of product (e.g. APP).
`productLevel` - `String!`	A description of the product level, if applicable (e.g. app tier for an application).

Example

{
  "id": 4,
  "type": "APPLICATION",
  "productLevel": "xyz789"
}

Types

SubscriptionProductType

Description

The product the Merchant purchased.

Values

Enum Value	Description
`APPLICATION`	Type for applications available in the BigCommerce App Marketplace.
`NONE`	This product type is not supported

Example

"APPLICATION"

Types

SubscriptionScope

Description

The scope of the subscription.

Fields

Field Name	Description
`id` - `ID!`	The unique ID of the scope.
`type` - `SubscriptionScopeType`	The type of scope (e.g. STORE).

Example

{"id": "4", "type": "STORE"}

Types

SubscriptionScopeType

Description

The type of scope of the subscription.

Values

Enum Value	Description
`STORE`	The subscription is scoped to a store.

Example

"STORE"

Types

SubscriptionStatus

Description

The current status of the Subscription.

Values

Enum Value	Description
`ACTIVE`	The Subscription is active and will continue billing the Merchant according to its pricing plan.
`CANCELLED`	The Subscription has been cancelled and is no longer billing the Merchant.
`SUSPENDED`	The Subscription has been suspended. The Merchant is no longer being billing according to the pricing plan. However, this Subscription may be reactivated.

Example

"ACTIVE"

Types

System

Description

System settings.

Fields

Field Name	Description
`time` - `Long!`	The current time.

Example

{"time": {}}

Types

User

Description

A user belonging to an account.

Fields

Field Name	Description
`id` - `ID!`	The ID of the object.
`email` - `String!`	The email for the user.
`firstName` - `String!`	First name.
`lastName` - `String!`	Last name.
`locale` - `String!`	User preferred locale.

Example

{
  "id": 4,
  "email": "xyz789",
  "firstName": "abc123",
  "lastName": "xyz789",
  "locale": "xyz789"
}

Types

UserConnection

Description

A connection to a list of items.

Fields

Field Name	Description
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`edges` - `[UserEdge]`	A list of edges.

Example

{
  "pageInfo": PageInfo,
  "edges": [UserEdge]
}

Types

UserEdge

Description

An edge in a connection.

Fields

Field Name	Description
`node` - `User!`	The item at the end of the edge.
`cursor` - `String!`	A cursor for use in pagination.

Example

{
  "node": User,
  "cursor": "abc123"
}

Types

UserIdentifierInput

Description

The user to add to the store.

Fields

Input Field	Description
`email` - `String`	The email of the user to be added to the store.
`id` - `ID`	The ID of the user to be added.

Example

{
  "email": "xyz789",
  "id": "4"
}

Types

UserMutations

Description

User mutations.

Fields

Field Name	Description
`addUserToStore` - `AddUserToStoreResult`	Adds a user to a store.
Arguments `input` - `AddUserToStoreInput!`
`createUserWithPassword` - `CreateUserWithPasswordResult`	Creates a user with password.
Arguments `input` - `CreateUserWithPasswordInput!`
`removeUserFromStore` - `RemoveUserFromStoreResult`	Removes user from a store.
Arguments `input` - `RemoveUserFromStoreInput!`

Example

{
  "addUserToStore": AddUserToStoreResult,
  "createUserWithPassword": CreateUserWithPasswordResult,
  "removeUserFromStore": RemoveUserFromStoreResult
}

GraphQL Account API reference

Queries

account

Description

Response

Example

Query

Response

node

Description

Response

Arguments

Example

Query

Variables

Response

nodes

Description

Response

Arguments

Example

Query

Variables

Response

system

Description

Response

Example

Query

Response

Mutations

account

Description

Response

Example

Query

Response

app

Description

Response

Example

Query

Response

checkout

Description

Response

Example

Query

Response

subscription

Description

Response

Example

Query

Response

user

Description

Response

Example

Query

Response

Types

Account

Description

Fields

Arguments

before - String

after - String

first - Int

last - Int

Arguments

id - ID!

Arguments

filter - StoreFilterInput

before - String

after - String

first - Int

last - Int

Arguments

filters - SubscriptionFiltersInput

`account`

`node`

`nodes`

`system`

`account`

`app`

`checkout`

`subscription`

`user`

`before` - `String`

`after` - `String`

`first` - `Int`

`last` - `Int`

`id` - `ID!`

`filter` - `StoreFilterInput`

`before` - `String`

`after` - `String`

`first` - `Int`

`last` - `Int`

`filters` - `SubscriptionFiltersInput`

`first` - `Int`

`after` - `String`

`last` - `Int`

`before` - `String`

`before` - `String`

`after` - `String`

`first` - `Int`

`last` - `Int`

`input` - `AddUserToAccountInput!`

`input` - `RemoveUserFromAccountInput!`

`before` - `String`

`after` - `String`

`first` - `Int`

`last` - `Int`

`input` - `CreateEventSourceInput!`

`input` - `DeleteEventSourceInput!`