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
}
}
}
node
Description
Fetches an object given its ID.
nodes
Description
Fetches objects given their IDs.
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
}
}
}
app
Description
App mutations.
Response
Returns an AppMutations!
Example
Query
mutation app {
app {
createEventSource {
...CreateEventSourceResultFragment
}
deleteEventSource {
...DeleteEventSourceResultFragment
}
}
}
Response
{
"data": {
"app": {
"createEventSource": CreateEventSourceResult,
"deleteEventSource": DeleteEventSourceResult
}
}
}
checkout
Description
Checkout mutations.
Response
Returns a CheckoutMutations!
Example
Query
mutation checkout {
checkout {
createCheckout {
...CreateCheckoutResultFragment
}
}
}
Response
{
"data": {
"checkout": {"createCheckout": CreateCheckoutResult}
}
}
subscription
Description
Subscription mutations.
Response
Returns a SubscriptionMutations!
Example
Query
mutation subscription {
subscription {
cancelSubscription {
...CancelSubscriptionResultFragment
}
}
}
Response
{
"data": {
"subscription": {
"cancelSubscription": CancelSubscriptionResult
}
}
}
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. |
checkout - Checkout
|
Allows for billing a Merchant for Products on a one-time or recurring basis. |
Arguments
|
|
id - ID!
|
The ID of the object. |
stores - StoreConnection!
|
The stores related to an account. |
Arguments
|
|
subscriptions - SubscriptionConnection!
|
Subscriptions belonging to the account. |
Arguments |
|
users - UserConnection!
|
Users belonging to the account. |
Example
{
"accountInfo": AccountInfo,
"apps": AppsConnection,
"checkout": Checkout,
"id": "4",
"stores": StoreConnection,
"subscriptions": SubscriptionConnection,
"users": UserConnection
}
AccountInfo
Description
Account details.
Fields
Field Name | Description |
---|---|
name - String!
|
The name of an account. |
Example
{"name": "xyz789"}
AccountMutations
Description
Account mutations.
Fields
Field Name | Description |
---|---|
addUserToAccount - AddUserToAccountResult
|
Adds a user to an account. |
Arguments
|
|
removeUserFromAccount - RemoveUserFromAccountResult
|
Removes a user from an account. |
Arguments
|
Example
{
"addUserToAccount": AddUserToAccountResult,
"removeUserFromAccount": RemoveUserFromAccountResult
}
AddUserToAccountInput
Fields
Input Field | Description |
---|---|
email - String!
|
The email of the user to be added to the account. |
Example
{"email": "xyz789"}
AddUserToAccountResult
Fields
Field Name | Description |
---|---|
account - Account
|
An account the user was added to. |
Example
{"account": Account}
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
}
AddUserToStoreResult
Fields
Field Name | Description |
---|---|
storeId - ID!
|
The ID of the object. |
Example
{"storeId": "4"}
App
Description
An application.
Example
{
"id": "4",
"name": "abc123",
"eventSources": AwsEventSourcesConnection
}
AppMutations
Description
App mutations.
Fields
Field Name | Description |
---|---|
createEventSource - CreateEventSourceResult
|
Creates an Amazon EventSource. |
Arguments
|
|
deleteEventSource - DeleteEventSourceResult
|
Deletes an Amazon EventSource. |
Arguments
|
Example
{
"createEventSource": CreateEventSourceResult,
"deleteEventSource": DeleteEventSourceResult
}
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]
}
AppsEdge
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": "abc123",
"eventSourceRegion": "AF_SOUTH_1",
"arn": "abc123",
"webhooksCount": {}
}
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]
}
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": "abc123"
}
AwsRegion
Description
The Amazon EventSource region.
Values
Enum Value | Description |
---|---|
|
af-south-1 |
|
ap-east-1 |
|
ap-northeast-1 |
|
ap-northeast-2 |
|
ap-northeast-3 |
|
ap-southeast-1 |
|
ap-southeast-2 |
|
ap-southeast-3 |
|
ap-southeast-4 |
|
ap-south-1 |
|
ap-south-2 |
|
ca-central-1 |
|
eu-central-1 |
|
eu-central-2 |
|
eu-north-1 |
|
eu-south-1 |
|
eu-south-2 |
|
eu-west-1 |
|
eu-west-2 |
|
eu-west-3 |
|
il-central-1 |
|
me-central-1 |
|
sa-east-1 |
|
us-east-1 |
|
us-east-2 |
|
us-west-1 |
|
us-west-2 |
Example
"AF_SOUTH_1"
BigDecimal
Description
The BigDecimal
scalar type represents signed fractional values with arbitrary precision.
Example
BigDecimal
Boolean
Description
The Boolean
scalar type represents true
or false
.
Example
true
CancelSubscriptionInput
Fields
Input Field | Description |
---|---|
id - ID!
|
The ID of the Subscription. |
Example
{"id": 4}
CancelSubscriptionResult
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. |
status - CheckoutStatus
|
The current status of the checkout. |
Example
{
"id": 4,
"accountId": "4",
"checkoutUrl": "xyz789",
"items": CheckoutItemConnection,
"status": "COMPLETE"
}
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
}
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]
}
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": "xyz789"
}
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": "xyz789",
"pricingPlan": PricingPlanInput,
"product": CheckoutItemProductInput,
"redirectUrl": "xyz789",
"scope": CheckoutItemScopeInput,
"subscriptionId": 4
}
CheckoutItemPricingInterval
Description
The billing interval representing how often to charge the Merchant for this product.
Values
Enum Value | Description |
---|---|
|
Charge the Merchant on a recurring basis each year on their Account's billing day. |
|
Charge the Merchant on a recurring basis each month on their Account's billing day. |
|
Charge the Merchant only one time, immediately. |
|
Charge the Merchant on a recurring basis each quarter on their Account's billing day. |
|
Charge the Merchant on a recurring basis every six months on their Account's billing day. |
Example
"ANNUAL"
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}
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"
}
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"
}
CheckoutItemProductType
Description
The type of product.
Values
Enum Value | Description |
---|---|
|
Type for applications available in the BigCommerce App Marketplace. |
Example
"APPLICATION"
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"}
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"}
CheckoutItemScopeType
Description
The scope of access to be granted upon successful completion of the Checkout.
Values
Enum Value | Description |
---|---|
|
Limits access for the purchased product to a particular Store. |
Example
"STORE"
CheckoutItemStatus
Description
The current status of the Checkout Item.
Values
Enum Value | Description |
---|---|
|
The Merchant has been invoiced and any necessary provisioning or Subscription updates have been completed. |
|
This CheckoutItem has been created, but has not yet been accepted by the Merchant. |
|
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"
CheckoutMutations
Description
Checkout mutations.
Fields
Field Name | Description |
---|---|
createCheckout - CreateCheckoutResult
|
Creates a Checkout for a Merchant. |
Arguments
|
Example
{"createCheckout": CreateCheckoutResult}
CheckoutStatus
Description
The current status of the Checkout.
Values
Enum Value | Description |
---|---|
|
The Merchant has been invoiced and any necessary provisioning or Subscription updates have been completed. |
|
This Checkout has been created, but has not yet been accepted by the Merchant. |
|
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"
CollectionInfo
Description
Collection details.
Fields
Field Name | Description |
---|---|
totalItems - Long
|
The total number of items in the collection. |
Example
{"totalItems": {}}
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]
}
CreateCheckoutResult
Fields
Field Name | Description |
---|---|
checkout - Checkout
|
The Checkout that is created as a result of mutation. |
Example
{"checkout": Checkout}
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": "abc123",
"eventSourceRegion": "AF_SOUTH_1"
}
CreateEventSourceResult
Fields
Field Name | Description |
---|---|
eventSource - AwsEventSource
|
The Amazon EventSource created as a result of mutation. |
Example
{"eventSource": AwsEventSource}
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": "xyz789",
"firstName": "abc123",
"lastName": "abc123",
"locale": "xyz789",
"password": "xyz789",
"passwordConfirmation": "xyz789"
}
CreateUserWithPasswordResult
Fields
Field Name | Description |
---|---|
user - User
|
Created user. |
Example
{"user": User}
CurrencyCode
Description
Currency Code.
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AED"
DateTime
Description
ISO-8601 formatted date in UTC
Example
"2007-12-03T10:15:30Z"
DeleteEventSourceInput
DeleteEventSourceResult
ID
Description
The ID
scalar type represents a unique identifier, often used to re-fetch an object or as key for a cache.
Example
4
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
123
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
{}
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
}
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}
Node
Description
An object with an ID.
Fields
Field Name | Description |
---|---|
id - ID!
|
The ID of the object. |
Possible Types
Node Types |
---|
Example
{"id": 4}
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": true,
"hasPreviousPage": false,
"startCursor": "xyz789",
"endCursor": "xyz789"
}
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
}
RemoveUserFromAccountInput
RemoveUserFromAccountResult
RemoveUserFromStoreInput
RemoveUserFromStoreResult
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. |
name - String!
|
The store name for the store. |
storeHash - String!
|
The store hash for the store. |
users - StoreUserConnection!
|
Users belonging to the store. |
Example
{
"id": "4",
"apps": AppsConnection,
"name": "abc123",
"storeHash": "xyz789",
"users": StoreUserConnection
}
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]
}
StoreEdge
StoreFilterInput
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. |
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": "abc123",
"firstName": "xyz789",
"lastLoginAt": "2007-12-03T10:15:30Z",
"lastName": "abc123",
"locale": "abc123",
"permissions": ["xyz789"],
"status": "ACTIVE",
"updatedAt": "2007-12-03T10:15:30Z"
}
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
}
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"
}
StoreUserStatus
Description
The status of the user on the store.
Values
Enum Value | Description |
---|---|
|
The user is active. |
|
The user is inactive. |
Example
"ACTIVE"
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
"abc123"
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"
}
SubscriptionBillingInterval
Description
The frequency of charges for a Merchant.
Values
Enum Value | Description |
---|---|
|
The Merchant will be billed on a recurring basis each year on their Account's billing day. |
|
The Merchant will be billed on a recurring basis each month on their Account's billing day. |
|
The Merchant was billed one time, at creation, and will not charge on a recurring basis. |
|
The Merchant will be billed only once. |
|
The Merchant will be billed on a recurring basis each quarter on their Account's billing day. |
|
The Merchant will be billed on a recurring basis every six months on their Account's billing day. |
Example
"ANNUAL"
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]
}
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"
}
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. |
status - SubscriptionStatus
|
A status for filtering the query. |
updatedAfter - DateTime
|
A date for filtering the query. |
Example
{
"ids": ["4"],
"productId": 4,
"productType": "APPLICATION",
"status": "ACTIVE",
"updatedAfter": "2007-12-03T10:15:30Z"
}
SubscriptionMutations
Description
Subscription mutations.
Fields
Field Name | Description |
---|---|
cancelSubscription - CancelSubscriptionResult
|
Cancels a Subscription for a Merchant. |
Arguments
|
Example
{"cancelSubscription": CancelSubscriptionResult}
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": "abc123"
}
SubscriptionProductType
Description
The product the Merchant purchased.
Values
Enum Value | Description |
---|---|
|
Type for applications available in the BigCommerce App Marketplace. |
|
This product type is not supported |
Example
"APPLICATION"
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"}
SubscriptionScopeType
Description
The type of scope of the subscription.
Values
Enum Value | Description |
---|---|
|
The subscription is scoped to a store. |
Example
"STORE"
SubscriptionStatus
Description
The current status of the Subscription.
Values
Enum Value | Description |
---|---|
|
The Subscription is active and will continue billing the Merchant according to its pricing plan. |
|
The Subscription has been cancelled and is no longer billing the Merchant. |
|
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"
System
Description
System settings.
Fields
Field Name | Description |
---|---|
time - Long!
|
The current time. |
Example
{"time": {}}
User
Description
A user belonging to an account.
Example
{
"id": "4",
"email": "abc123",
"firstName": "xyz789",
"lastName": "xyz789",
"locale": "xyz789"
}
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]
}
UserEdge
UserIdentifierInput
UserMutations
Description
User mutations.
Fields
Field Name | Description |
---|---|
addUserToStore - AddUserToStoreResult
|
Adds a user to a store. |
Arguments
|
|
createUserWithPassword - CreateUserWithPasswordResult
|
Creates a user with password. |
Arguments
|
|
removeUserFromStore - RemoveUserFromStoreResult
|
Removes user from a store. |
Arguments
|
Example
{
"addUserToStore": AddUserToStoreResult,
"createUserWithPassword": CreateUserWithPasswordResult,
"removeUserFromStore": RemoveUserFromStoreResult
}