Customers

Read and change the profile of the signed-in customer.

Every method here needs a signed-in customer. Sign one in with the authentication methods first.

subbly.customers.me()

Gets the profile of the signed-in customer. subbly.auth.checkAuthenticated calls it behind the scenes, so a failure here means the token no longer works.

ReturnsPromise<SubblyCustomer>

The customer profile.


Get the customer profile
const customer = await subbly.customers.me()

subbly.customers.update(payload)

Changes the profile of the signed-in customer. Send only the fields you change.

Method parameters

payloadRequiredCustomerUpdatePayload

The fields to change. Every one is optional.

ReturnsPromise<SubblyCustomer>

The updated profile.


Update the customer
const customer = await subbly.customers.update({
  firstName: 'Ada',
  marketingConsent: true,
})

subbly.customers.referral()

Gets the referral link of the signed-in customer, to show on a "refer a friend" page. Referrals must be switched on for the shop; check subbly.shop.referralSettings.enabled first.

ReturnsPromise<CustomersReferralResponse>

The referral link.

referralLinkstring

The URL the customer shares.


Get the referral link
const { referralLink } = await subbly.customers.referral()

Last modified on September 15, 2026

Customers

Read and change the profile of the signed-in customer.

Every method here needs a signed-in customer. Sign one in with the authentication methods first.

subbly.customers.me()

Gets the profile of the signed-in customer. subbly.auth.checkAuthenticated calls it behind the scenes, so a failure here means the token no longer works.

ReturnsPromise<SubblyCustomer>

The customer profile.

idnumber

ID of the customer.

userIdnumber

ID of the user account behind the customer.

emailstring

Email address.

firstNamestring

Given name.

lastNamestring

Family name.

externalIdstring | null

Your own ID for this customer.

marketingConsentboolean

true when the customer agreed to marketing email.

tosConsentAtstring

When the customer accepted the terms.

activeSubscriptionsCountnumber

How many subscriptions are active.

createdAtstring

When the customer record was created.


Get the customer profile
const customer = await subbly.customers.me()

subbly.customers.update(payload)

Changes the profile of the signed-in customer. Send only the fields you change.

Method parameters

payloadRequiredCustomerUpdatePayload

The fields to change. Every one is optional.

firstNameoptionalstring

Given name.

lastNameoptionalstring

Family name.

marketingConsentoptionalboolean

Whether the customer agreed to marketing email.

tosConsentoptionalboolean

Whether the customer accepted the terms. Sending true stamps tosConsentAt with the current time.

externalIdoptionalstring | null

Your own ID for this customer.

ReturnsPromise<SubblyCustomer>

The updated profile.

idnumber

ID of the customer.

userIdnumber

ID of the user account behind the customer.

emailstring

Email address.

firstNamestring

Given name.

lastNamestring

Family name.

externalIdstring | null

Your own ID for this customer.

marketingConsentboolean

true when the customer agreed to marketing email.

tosConsentAtstring

When the customer accepted the terms.

activeSubscriptionsCountnumber

How many subscriptions are active.

createdAtstring

When the customer record was created.


Update the customer
const customer = await subbly.customers.update({
  firstName: 'Ada',
  marketingConsent: true,
})

subbly.customers.referral()

Gets the referral link of the signed-in customer, to show on a "refer a friend" page. Referrals must be switched on for the shop; check subbly.shop.referralSettings.enabled first.

ReturnsPromise<CustomersReferralResponse>

The referral link.

referralLinkstring

The URL the customer shares.


Get the referral link
const { referralLink } = await subbly.customers.referral()

Last modified on September 15, 2026