Get User

Get user

curl --request GET \
  --url https://api.komerza.com/user \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "message": "<string>",
  "code": "<string>",
  "data": {
    "id": "<string>",
    "dateCreated": "2023-11-07T05:31:56Z",
    "email": "<string>",
    "userName": "<string>",
    "plan": "<string>",
    "twoFactorEnabled": true,
    "riskLocked": true,
    "integrations": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dateCreated": "2023-11-07T05:31:56Z",
        "application": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "dateCreated": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "permissions": [
            "<string>"
          ],
          "userId": "<string>",
          "imageName": "<string>",
          "termsOfServiceLink": "<string>",
          "privacyPolicyLink": "<string>"
        }
      }
    ],
    "apiKeys": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dateCreated": "2023-11-07T05:31:56Z",
        "label": "<string>",
        "ipAddresses": [
          "<string>"
        ],
        "scopes": [
          "<string>"
        ],
        "userId": "<string>"
      }
    ],
    "disabledPaymentMethods": {},
    "stripeEnabled": true,
    "squareEnabled": true,
    "paypalBusinessEnabled": true,
    "isCryptoEnabled": true,
    "isSumUpEnabled": true,
    "isAuthorizeNetEnabled": true,
    "restrictedPaymentMethods": [
      "<string>"
    ],
    "riskLockedPaymentMethods": [
      "<string>"
    ],
    "stores": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dateCreated": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "description": "<string>",
        "url": "\n                store\n            ",
        "currencyCode": "<string>",
        "prependProductNameToReceipt": true,
        "isAutomaticReviewsEnabled": true,
        "rating": 123,
        "domain": "<string>",
        "isCustomerBalanceEnabled": true,
        "branding": {
          "isAutomaticCurrencyConversionEnabled": true,
          "bannerFileName": "<string>",
          "iconFileName": "<string>",
          "accentColor": "<string>"
        },
        "customDomain": "<string>",
        "scopes": [
          "<string>"
        ],
        "maintenanceReason": "<string>",
        "affiliateOptions": {
          "isEnabled": true,
          "defaultReturnPercentage": 50,
          "canConvertAffiliateBalance": true,
          "isPublicRegistrationEnabled": true,
          "isLinkEditingEnabled": true,
          "defaultPercentageOff": 50
        }
      }
    ],
    "integrationErrorReports": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dateCreated": "2023-11-07T05:31:56Z",
        "reason": "<string>",
        "gateway": "<string>",
        "reporter": "<string>",
        "resolved": true,
        "type": "<string>",
        "userId": "<string>"
      }
    ],
    "lastPasswordUpdate": "2023-11-07T05:31:56Z",
    "signals": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dateCreated": "2023-11-07T05:31:56Z",
      "countryCode": "<string>",
      "userId": "<string>",
      "registrationIpAddress": "<string>",
      "registrationFingerprint": "<string>",
      "verificationStatus": "<string>",
      "fullName": "<string>",
      "addressLine1": "<string>",
      "addressLine2": "<string>",
      "city": "<string>",
      "region": "<string>",
      "postalCode": "<string>",
      "legalEntityType": "<string>",
      "taxId": "<string>"
    },
    "discordWebhookUrl": "<string>",
    "subscription": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dateCreated": "2023-11-07T05:31:56Z",
      "expiryDate": "2023-12-25",
      "autoRenew": true,
      "userId": "<string>",
      "lastSyncedAt": "2023-11-07T05:31:56Z",
      "startedDate": "2023-12-25",
      "stripeCustomerId": "<string>",
      "stripeSubscriptionId": "<string>",
      "nextBillingDate": "2023-12-25",
      "status": "<string>",
      "trialEndDate": "2023-12-25",
      "priceId": "<string>",
      "billingCycleAnchor": "2023-11-07T05:31:56Z",
      "cancelAt": "2023-11-07T05:31:56Z",
      "canceledAt": "2023-11-07T05:31:56Z"
    },
    "refreshAt": "2023-11-07T05:31:56Z",
    "cashAppOptions": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "isEnabled": true,
      "isRestricted": true,
      "isRiskLocked": true,
      "userId": "<string>",
      "isAcceptingRequests": true,
      "notesVersion": 0,
      "restrictionReason": "<string>",
      "email": "<string>",
      "tag": "<string>"
    },
    "payPalOptions": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "isEnabled": true,
      "isRestricted": true,
      "isRiskLocked": true,
      "userId": "<string>",
      "isUsingLegacyEmails": true,
      "isFriendsAndFamilyEnabled": true,
      "isAcceptingRequests": true,
      "isAcceptingHeldPayments": true,
      "notesVersion": 0,
      "restrictionReason": "<string>",
      "email": "<string>",
      "payPalEmail": "<string>"
    },
    "payPalBusinessOptions": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "isEnabled": true,
      "isRestricted": true,
      "isRiskLocked": true,
      "userId": "<string>",
      "isUsingLegacyIntegration": true,
      "restrictionReason": "<string>",
      "oAuthClientId": "<string>",
      "emailAddress": "<string>"
    },
    "stripeOptions": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "isEnabled": true,
      "isRestricted": true,
      "isRiskLocked": true,
      "userId": "<string>",
      "requireBillingInformation": true,
      "restrictionReason": "<string>",
      "paymentMethodConfigurationId": "<string>",
      "publishableKey": "<string>"
    },
    "squareOptions": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "isEnabled": true,
      "isRestricted": true,
      "isRiskLocked": true,
      "userId": "<string>",
      "applicationId": "<string>",
      "locationId": "<string>",
      "restrictionReason": "<string>"
    },
    "cryptocurrencyOptions": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "isEnabled": true,
      "isRestricted": true,
      "isRiskLocked": true,
      "userId": "<string>",
      "enabledCryptocurrencies": [
        "<string>"
      ],
      "payoutCryptocurrency": "<string>",
      "automaticPayoutThreshold": 123,
      "isPayoutsLocked": true,
      "restrictionReason": "<string>",
      "nowPaymentsId": "<string>",
      "payoutAddress": "<string>",
      "payoutSchedule": "<string>"
    },
    "ownedReferralLink": "<string>",
    "referralLink": "<string>"
  }
}

GET

user

Get user

curl --request GET \
  --url https://api.komerza.com/user \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "message": "<string>",
  "code": "<string>",
  "data": {
    "id": "<string>",
    "dateCreated": "2023-11-07T05:31:56Z",
    "email": "<string>",
    "userName": "<string>",
    "plan": "<string>",
    "twoFactorEnabled": true,
    "riskLocked": true,
    "integrations": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dateCreated": "2023-11-07T05:31:56Z",
        "application": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "dateCreated": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "permissions": [
            "<string>"
          ],
          "userId": "<string>",
          "imageName": "<string>",
          "termsOfServiceLink": "<string>",
          "privacyPolicyLink": "<string>"
        }
      }
    ],
    "apiKeys": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dateCreated": "2023-11-07T05:31:56Z",
        "label": "<string>",
        "ipAddresses": [
          "<string>"
        ],
        "scopes": [
          "<string>"
        ],
        "userId": "<string>"
      }
    ],
    "disabledPaymentMethods": {},
    "stripeEnabled": true,
    "squareEnabled": true,
    "paypalBusinessEnabled": true,
    "isCryptoEnabled": true,
    "isSumUpEnabled": true,
    "isAuthorizeNetEnabled": true,
    "restrictedPaymentMethods": [
      "<string>"
    ],
    "riskLockedPaymentMethods": [
      "<string>"
    ],
    "stores": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dateCreated": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "description": "<string>",
        "url": "\n                store\n            ",
        "currencyCode": "<string>",
        "prependProductNameToReceipt": true,
        "isAutomaticReviewsEnabled": true,
        "rating": 123,
        "domain": "<string>",
        "isCustomerBalanceEnabled": true,
        "branding": {
          "isAutomaticCurrencyConversionEnabled": true,
          "bannerFileName": "<string>",
          "iconFileName": "<string>",
          "accentColor": "<string>"
        },
        "customDomain": "<string>",
        "scopes": [
          "<string>"
        ],
        "maintenanceReason": "<string>",
        "affiliateOptions": {
          "isEnabled": true,
          "defaultReturnPercentage": 50,
          "canConvertAffiliateBalance": true,
          "isPublicRegistrationEnabled": true,
          "isLinkEditingEnabled": true,
          "defaultPercentageOff": 50
        }
      }
    ],
    "integrationErrorReports": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dateCreated": "2023-11-07T05:31:56Z",
        "reason": "<string>",
        "gateway": "<string>",
        "reporter": "<string>",
        "resolved": true,
        "type": "<string>",
        "userId": "<string>"
      }
    ],
    "lastPasswordUpdate": "2023-11-07T05:31:56Z",
    "signals": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dateCreated": "2023-11-07T05:31:56Z",
      "countryCode": "<string>",
      "userId": "<string>",
      "registrationIpAddress": "<string>",
      "registrationFingerprint": "<string>",
      "verificationStatus": "<string>",
      "fullName": "<string>",
      "addressLine1": "<string>",
      "addressLine2": "<string>",
      "city": "<string>",
      "region": "<string>",
      "postalCode": "<string>",
      "legalEntityType": "<string>",
      "taxId": "<string>"
    },
    "discordWebhookUrl": "<string>",
    "subscription": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dateCreated": "2023-11-07T05:31:56Z",
      "expiryDate": "2023-12-25",
      "autoRenew": true,
      "userId": "<string>",
      "lastSyncedAt": "2023-11-07T05:31:56Z",
      "startedDate": "2023-12-25",
      "stripeCustomerId": "<string>",
      "stripeSubscriptionId": "<string>",
      "nextBillingDate": "2023-12-25",
      "status": "<string>",
      "trialEndDate": "2023-12-25",
      "priceId": "<string>",
      "billingCycleAnchor": "2023-11-07T05:31:56Z",
      "cancelAt": "2023-11-07T05:31:56Z",
      "canceledAt": "2023-11-07T05:31:56Z"
    },
    "refreshAt": "2023-11-07T05:31:56Z",
    "cashAppOptions": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "isEnabled": true,
      "isRestricted": true,
      "isRiskLocked": true,
      "userId": "<string>",
      "isAcceptingRequests": true,
      "notesVersion": 0,
      "restrictionReason": "<string>",
      "email": "<string>",
      "tag": "<string>"
    },
    "payPalOptions": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "isEnabled": true,
      "isRestricted": true,
      "isRiskLocked": true,
      "userId": "<string>",
      "isUsingLegacyEmails": true,
      "isFriendsAndFamilyEnabled": true,
      "isAcceptingRequests": true,
      "isAcceptingHeldPayments": true,
      "notesVersion": 0,
      "restrictionReason": "<string>",
      "email": "<string>",
      "payPalEmail": "<string>"
    },
    "payPalBusinessOptions": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "isEnabled": true,
      "isRestricted": true,
      "isRiskLocked": true,
      "userId": "<string>",
      "isUsingLegacyIntegration": true,
      "restrictionReason": "<string>",
      "oAuthClientId": "<string>",
      "emailAddress": "<string>"
    },
    "stripeOptions": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "isEnabled": true,
      "isRestricted": true,
      "isRiskLocked": true,
      "userId": "<string>",
      "requireBillingInformation": true,
      "restrictionReason": "<string>",
      "paymentMethodConfigurationId": "<string>",
      "publishableKey": "<string>"
    },
    "squareOptions": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "isEnabled": true,
      "isRestricted": true,
      "isRiskLocked": true,
      "userId": "<string>",
      "applicationId": "<string>",
      "locationId": "<string>",
      "restrictionReason": "<string>"
    },
    "cryptocurrencyOptions": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "isEnabled": true,
      "isRestricted": true,
      "isRiskLocked": true,
      "userId": "<string>",
      "enabledCryptocurrencies": [
        "<string>"
      ],
      "payoutCryptocurrency": "<string>",
      "automaticPayoutThreshold": 123,
      "isPayoutsLocked": true,
      "restrictionReason": "<string>",
      "nowPaymentsId": "<string>",
      "payoutAddress": "<string>",
      "payoutSchedule": "<string>"
    },
    "ownedReferralLink": "<string>",
    "referralLink": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Your API key goes here

Response

The object was successfully returned.

Represents a default generic response for API endpoints.

success

boolean

required

Indicates whether the operation or response was successful.

message

string | null

A descriptive message providing additional context or information about the response.

code

string | null

The error code (if there was an error) to use when referencing the error

data

object

Represents a user with detailed merchant-related information.

Show child attributes

data.id

string

required

The unique identifier for the user.

data.dateCreated

string<date-time>

required

The date the entity was created

data.email

string

required

The user's email address.

data.userName

string

required

The username of the user.

data.plan

string

required

The user's subscription plan.

data.twoFactorEnabled

boolean

required

Indicates whether two-factor authentication is enabled for the user.

data.riskLocked

boolean

required

Whether their account is locked due to being too high risk

data.integrations

object[]

required

A list of connected OAuth integrations for the user.

Show child attributes

data.integrations.id

string<uuid>

required

The unique identifier of the entity

data.integrations.dateCreated

string<date-time>

required

The date the entity was created

data.integrations.application

object

required

An application to use for OAuth2

Show child attributes

data.integrations.application.id

string<uuid>

required

The unique identifier of the entity

data.integrations.application.dateCreated

string<date-time>

required

The date the entity was created

data.integrations.application.name

string

required

The name of the application

Required string length: 2 - 100

data.integrations.application.permissions

string[]

required

The list of permissions the application requires

data.integrations.application.userId

string

required

The ID of the user who owns the application

data.integrations.application.imageName

string | null

The name of the image to show for the application

data.integrations.application.termsOfServiceLink

string | null

The link to the application's terms of service

Maximum string length: 2000

data.integrations.application.privacyPolicyLink

string | null

The link to the application's privacy policy

Maximum string length: 2000

data.apiKeys

object[]

required

The API keys associated with the user.

Show child attributes

data.apiKeys.id

string<uuid>

required

The unique identifier of the entity

data.apiKeys.dateCreated

string<date-time>

required

The date the entity was created in the database

data.apiKeys.label

string

required

Represents a descriptive or identifiable name assigned to the API key

Required string length: 1 - 64

data.apiKeys.ipAddresses

string[]

required

The list of IP addresses which are allowed to access the API

data.apiKeys.scopes

string[]

required

The list of scopes the API key is allowed to access

data.apiKeys.userId

string

required

The identifier of the user associated with the API key

Required string length: 1 - 36

data.disabledPaymentMethods

object

required

A collection of payment methods that are disabled for the user.

Show child attributes

data.disabledPaymentMethods.{key}

string

data.stripeEnabled

boolean

required

Indicates whether Stripe integration is enabled for the user.

data.squareEnabled

boolean

required

Indicates whether Square integration is enabled for the user.

data.paypalBusinessEnabled

boolean

required

Indicates whether PayPal Business integration is enabled for the user.

data.isCryptoEnabled

boolean

required

Indicates whether cryptocurrency integration is enabled for the user.

data.isSumUpEnabled

boolean

required

Indicates whether the SumUp integration is enabled for the user.

data.isAuthorizeNetEnabled

boolean

required

Indicates whether Authorize.Net payment integration is enabled for the user.

data.restrictedPaymentMethods

string[]

required

The list of payment methods which are restricted for the user.

data.riskLockedPaymentMethods

string[]

required

The list of payment methods which are risk locked for the user.

data.stores

object[]

required

Represents the collection of store references associated with a user.

Show child attributes

data.stores.id

string<uuid>

required

The unique identifier of the entity

data.stores.dateCreated

string<date-time>

required

The date the entity was created

data.stores.name

string

required

The name of the store

data.stores.description

string

required

The description of the store, shown on their about page and on the home of their store page

data.stores.url

string

required

The subdomain for the store, ONLY the subdomain, not the fully qualified domain

Example:

"\n store\n "

data.stores.currencyCode

string

required

The stores preferred currency

data.stores.prependProductNameToReceipt

boolean

required

Whether the name of the product should be prepended to the start of delivery receipts to customers

data.stores.isAutomaticReviewsEnabled

boolean

required

Whether automatic review leaving is enabled

data.stores.rating

number<double>

required

The combined average rating for all their products

data.stores.domain

string

required

The domain the store is associated with

data.stores.isCustomerBalanceEnabled

boolean

required

Whether the customer balance system is enabled on the stores

data.stores.branding

object

required

Represents the configurable branding options for a store.

Show child attributes

data.stores.branding.isAutomaticCurrencyConversionEnabled

boolean

required

Indicates whether automatic currency conversion is enabled, this is strictly for displaying on the checkout which improves conversion

data.stores.branding.bannerFileName

string | null

Represents the file name of the banner associated with the checkout options.

Maximum string length: 64

data.stores.branding.iconFileName

string | null

The icon file name, used for favicon

Maximum string length: 64

data.stores.branding.accentColor

string | null

Represents the accent color used in the checkout options.

Maximum string length: 9

data.stores.customDomain

string | null

The custom domain set for the store, will be null if not set

data.stores.scopes

string[] | null

The permission scopes that the current user can use for the store, only returned on the /user endpoint for stores visible due to team permissions, will also be null on /user if the store is owned by the user and therefore has every (permissions)

data.stores.maintenanceReason

string | null

The reason the store is in maintenance, if this is null then the store is not in maintenance mode

data.stores.affiliateOptions

object

Represents the configuration options for affiliate settings in a store.

Show child attributes

data.stores.affiliateOptions.isEnabled

boolean

required

Determines if the affiliate settings are active for the store.

data.stores.affiliateOptions.defaultReturnPercentage

integer<int32>

required

Specifies the default return percentage for affiliates within a store, ranging from 0 to 100.

Required range: 0 <= x <= 100

data.stores.affiliateOptions.canConvertAffiliateBalance

boolean

required

Whether the store allows affiliate balance to be converted into customer balance to be used on the store, when enabled any affiliate can convert their affiliate balance into customer balance automatically

data.stores.affiliateOptions.isPublicRegistrationEnabled

boolean

required

Determines whether public registration is enabled for affiliates within the store.

data.stores.affiliateOptions.isLinkEditingEnabled

boolean

required

Indicates whether link editing capabilities are enabled within the affiliate options for a store.

data.stores.affiliateOptions.defaultPercentageOff

integer<int32> | null

Represents the default percentage off value used in affiliate settings, where the value must be between 0 and 100.

Required range: 0 <= x <= 100

data.integrationErrorReports

object[]

required

A collection of error reports related to integrations.

Show child attributes

data.integrationErrorReports.id

string<uuid>

required

The unique identifier of the entity

data.integrationErrorReports.dateCreated

string<date-time>

required

The date the entity was created in the database

data.integrationErrorReports.reason

string

required

The reason for the report

Required string length: 3 - 1024

data.integrationErrorReports.gateway

string

required

The ID of the payment gateway that has the error

Required string length: 1 - 64

data.integrationErrorReports.reporter

string

required

The hostname of the server which reported the issue

Required string length: 1 - 128

data.integrationErrorReports.resolved

boolean

required

Whether the report has been acknowledged and resolved - therefore should not be shown

data.integrationErrorReports.type

string

required

The ID/type of report that specifically identifies the detected issue

Required string length: 3 - 256

data.integrationErrorReports.userId

string

required

The user who the report is for (automatically done by EF core)

Maximum string length: 36

data.lastPasswordUpdate

string<date-time>

required

The timestamp of the user's last password update.

data.signals

object

Represents the risk signal information on a merchant

Show child attributes

data.signals.id

string<uuid>

required

The unique identifier of the entity

data.signals.dateCreated

string<date-time>

required

The date the entity was created in the database

data.signals.countryCode

string

required

The ISO 3166-1 alpha-2 country code associated with the address. Examples: "US" for the United States, "CA" for Canada.

Required string length: 1 - 2

data.signals.userId

string

required

The ID of the user the KYC info belongs to

Required string length: 1 - 36

data.signals.registrationIpAddress

string

required

Gets or sets the IP address that was used to create the merchant

Maximum string length: 45

data.signals.registrationFingerprint

string

required

The browser/device-specific fingerprint captured during user registration for identity verification.

Maximum string length: 256

data.signals.verificationStatus

string

required

The current verification status of the merchant's KYC process.

Required string length: 1 - 30

data.signals.fullName

string | null

The full name of the individual or entity associated with merchant account.

Maximum string length: 100

data.signals.addressLine1

string | null

The primary address line. Typically, includes house number, street name, or building name.

Maximum string length: 200

data.signals.addressLine2

string | null

The secondary address line, if applicable. May include apartment, suite, unit, or floor details. Optional field.

Maximum string length: 200

data.signals.city

string | null

The city or locality associated with the address.

Maximum string length: 100

data.signals.region

string | null

The region associated with the address. Represents state, province, or other administrative division.

Maximum string length: 100

data.signals.postalCode

string | null

The postal or ZIP code for the address.

Maximum string length: 20

data.signals.legalEntityType

string | null

The legal entity type the merchant is, use the common model LegalEntityType to specify

Required string length: 1 - 1000

data.signals.taxId

string | null

Tax Identification Number or VAT number.

Maximum string length: 50

data.discordWebhookUrl

string | null

The URL for a Discord webhook associated with the user.

data.subscription

object

Represents the subscription configuration and details for a user.

Show child attributes

data.subscription.id

string<uuid>

required

The unique identifier of the entity

data.subscription.dateCreated

string<date-time>

required

The date the entity was created in the database

data.subscription.expiryDate

string<date>

required

Gets or sets the expiry date of the subscription plan. Defaults to DateOnly.MaxValue if the plan does not have an expiration date.

data.subscription.autoRenew

boolean

required

Gets or sets a value indicating whether the subscription will automatically renew. Default is true unless explicitly disabled by the user or system configuration.

data.subscription.userId

string

required

Gets or sets the unique identifier for the user associated with the subscription options. Required and must be a string between 3 and 36 characters.

Required string length: 3 - 36

data.subscription.lastSyncedAt

string<date-time>

required

Gets or sets the timestamp of the last synchronization event. Default is the current UTC time at instantiation.

data.subscription.startedDate

string<date> | null

Gets or sets the start date of the user's subscription. This represents when the subscription started or was activated.

data.subscription.stripeCustomerId

string | null

Gets or sets the Stripe Customer ID associated with the user's subscription. This ID is used to link the user to their Stripe account data.

Required string length: 3 - 128

data.subscription.stripeSubscriptionId

string | null

Gets or sets the Stripe subscription ID associated with the user. Represents the unique subscription ID from the Stripe platform.

Required string length: 3 - 128

data.subscription.nextBillingDate

string<date> | null

Gets or sets the next billing date of the user's subscription plan. Null indicates that the next billing date is not yet determined.

data.subscription.status

string | null

Gets or sets the current subscription status for a user. Examples include "active" or "canceled".

Maximum string length: 50

data.subscription.trialEndDate

string<date> | null

Gets or sets the trial end date for the user's subscription. Null if no trial is assigned.

data.subscription.priceId

string | null

Gets or sets the identifier for the price associated with the subscription, typically used for billing purposes.

Maximum string length: 128

data.subscription.billingCycleAnchor

string<date-time> | null

Gets or sets the date and time at which the billing cycle is anchored. Default is null if no anchor date is specified.

data.subscription.cancelAt

string<date-time> | null

Gets or sets the date and time when the subscription is set to be canceled. Null indicates no cancellation is scheduled by default.

data.subscription.canceledAt

string<date-time> | null

Gets or sets the date and time when the subscription was canceled. This property is null if the subscription has not been canceled.

data.refreshAt

string<date-time> | null

The timestamp indicating when the user information should be refreshed.

data.cashAppOptions

object

Represents configuration and options related to Cash App integration within the application.

Show child attributes

data.cashAppOptions.id

string<uuid>

required

The unique identifier of the entity

data.cashAppOptions.isEnabled

boolean

required

Whether the integration is enabled or not

data.cashAppOptions.isRestricted

boolean

required

Whether the payment method is restricted from being used by the PSP

data.cashAppOptions.isRiskLocked

boolean

required

Whether the payment method is restricted for setup by the user due to risk concerns

data.cashAppOptions.userId

string

required

The user ID the integration options are for

Maximum string length: 36

data.cashAppOptions.isAcceptingRequests

boolean

required

Whether to accept Cash App requests as a delivery receipt, this can be dangerous as users can charge back easily at this stage

data.cashAppOptions.notesVersion

enum<integer>

required

Represents versions used in the notes system within the application.

Available options:

0,

1

data.cashAppOptions.restrictionReason

string | null

The reason the restriction is in place, if there is one

Maximum string length: 2048

data.cashAppOptions.email

string | null

The automatically generated email address to forward Cash App emails to

Maximum string length: 256

data.cashAppOptions.tag

string | null

The users Cash Tag to show the user where to send the funds

Maximum string length: 32

data.payPalOptions

object

The options to configure PayPal with

Show child attributes

data.payPalOptions.id

string<uuid>

required

The unique identifier of the entity

data.payPalOptions.isEnabled

boolean

required

Whether the integration is enabled or not

data.payPalOptions.isRestricted

boolean

required

Whether the payment method is restricted from being used by the PSP

data.payPalOptions.isRiskLocked

boolean

required

Whether the payment method is restricted for setup by the user due to risk concerns

data.payPalOptions.userId

string

required

The user ID the integration options are for

Maximum string length: 36

data.payPalOptions.isUsingLegacyEmails

boolean

required

Whether the Friends and Family integration is using legacy email forwarding not IPN

data.payPalOptions.isFriendsAndFamilyEnabled

boolean

required

Whether the PayPal friends and family integration is enabled

data.payPalOptions.isAcceptingRequests

boolean

required

Whether to accept PayPal friends and family requests as a delivery receipt, this can be dangerous as users can charge back easily at this stage

data.payPalOptions.isAcceptingHeldPayments

boolean

required

Whether to accept payments that are on-hold automatically, this is potentially dangerous as the payment can fail at this stage and cause lost funds

data.payPalOptions.notesVersion

enum<integer>

required

Represents versions used in the notes system within the application.

Available options:

0,

1

data.payPalOptions.restrictionReason

string | null

The reason the restriction is in place, if there is one

Maximum string length: 2048

data.payPalOptions.email

string | null

The automatically generated email address to forward PayPal emails to

Maximum string length: 512

data.payPalOptions.payPalEmail

string | null

The actual email address associated with their PayPal account

Maximum string length: 512

data.payPalBusinessOptions

object

Represents the configuration options specific to a PayPal Business integration.

Show child attributes

data.payPalBusinessOptions.id

string<uuid>

required

The unique identifier of the entity

data.payPalBusinessOptions.isEnabled

boolean

required

Whether the integration is enabled or not

data.payPalBusinessOptions.isRestricted

boolean

required

Whether the payment method is restricted from being used by the PSP

data.payPalBusinessOptions.isRiskLocked

boolean

required

Whether the payment method is restricted for setup by the user due to risk concerns

data.payPalBusinessOptions.userId

string

required

The user ID the integration options are for

Maximum string length: 36

data.payPalBusinessOptions.isUsingLegacyIntegration

boolean

required

Whether the system is using the legacy PayPal Business integration method, which uses links and "not smart" buttons

data.payPalBusinessOptions.restrictionReason

string | null

The reason the restriction is in place, if there is one

Maximum string length: 2048

data.payPalBusinessOptions.oAuthClientId

string | null

The OAuth client identifier used for authentication with PayPal.

Maximum string length: 512

data.payPalBusinessOptions.emailAddress

string | null

The email address associated with the PayPal account, used for the old system

Maximum string length: 256

data.stripeOptions

object

The Stripe options for a merchants Stripe setup

Show child attributes

data.stripeOptions.id

string<uuid>

required

The unique identifier of the entity

data.stripeOptions.isEnabled

boolean

required

Whether the integration is enabled or not

data.stripeOptions.isRestricted

boolean

required

Whether the payment method is restricted from being used by the PSP

data.stripeOptions.isRiskLocked

boolean

required

Whether the payment method is restricted for setup by the user due to risk concerns

data.stripeOptions.userId

string

required

The user ID the integration options are for

Maximum string length: 36

data.stripeOptions.requireBillingInformation

boolean

required

Whether to prompt and ask the customer for billing information, reduces conversion and increases anti-fraud effectiveness

data.stripeOptions.restrictionReason

string | null

The reason the restriction is in place, if there is one

Maximum string length: 2048

data.stripeOptions.paymentMethodConfigurationId

string | null

The payment method configuration ID to use for the account integration

Maximum string length: 64

data.stripeOptions.publishableKey

string | null

The publishable key for the Stripe integration, not encrypted

Maximum string length: 512

data.squareOptions

object

Represents configuration options specific to Square integrations.

Show child attributes

data.squareOptions.id

string<uuid>

required

The unique identifier of the entity

data.squareOptions.isEnabled

boolean

required

Whether the integration is enabled or not

data.squareOptions.isRestricted

boolean

required

Whether the payment method is restricted from being used by the PSP

data.squareOptions.isRiskLocked

boolean

required

Whether the payment method is restricted for setup by the user due to risk concerns

data.squareOptions.userId

string

required

The user ID the integration options are for

Maximum string length: 36

data.squareOptions.applicationId

string

required

Represents the application ID required for Square payment integration.

Required string length: 1 - 256

data.squareOptions.locationId

string

required

Represents the location ID associated with the Square integration.

Required string length: 1 - 256

data.squareOptions.restrictionReason

string | null

The reason the restriction is in place, if there is one

Maximum string length: 2048

data.cryptocurrencyOptions

object

The cryptocurrency options for a merchant

Show child attributes

data.cryptocurrencyOptions.id

string<uuid>

required

The unique identifier of the entity

data.cryptocurrencyOptions.isEnabled

boolean

required

Whether the integration is enabled or not

data.cryptocurrencyOptions.isRestricted

boolean

required

Whether the payment method is restricted from being used by the PSP

data.cryptocurrencyOptions.isRiskLocked

boolean

required

Whether the payment method is restricted for setup by the user due to risk concerns

data.cryptocurrencyOptions.userId

string

required

The user ID the integration options are for

Maximum string length: 36

data.cryptocurrencyOptions.enabledCryptocurrencies

string[]

required

The list of enabled cryptocurrencies

data.cryptocurrencyOptions.payoutCryptocurrency

string

required

The default cryptocurrency to use for crypto payouts, defaults to Litecoin

Maximum string length: 10

data.cryptocurrencyOptions.automaticPayoutThreshold

number<double>

required

The minimum amount of funds required to trigger an automatic payout

data.cryptocurrencyOptions.isPayoutsLocked

boolean

required

Whether payouts are locked for this user

data.cryptocurrencyOptions.restrictionReason

string | null

The reason the restriction is in place, if there is one

Maximum string length: 2048

data.cryptocurrencyOptions.nowPaymentsId

string | null

The ID of the user on NOWPayments

Maximum string length: 64

data.cryptocurrencyOptions.payoutAddress

string | null

The payout address to send crypto payouts to by default

Maximum string length: 90

data.cryptocurrencyOptions.payoutSchedule

string<date-span> | null

The schedule for payouts, if null then automatic payouts will be made when the threshold is reached

data.ownedReferralLink

string | null

The referral link owned by the user.

data.referralLink

string | null

Gets or sets the referral link associated with the user.

Enums & Constants

Get Store

⌘I

API Documentation

Reference

User

Stores

Products

Categories

Variants

Coupons

Tickets

Customers

Orders

Reviews

Authorizations

Response