Stock notifications

Ask Subbly to email a customer when an item is back in stock.

Asks Subbly to email the customer when a product or a survey answer is back in stock. Watch for stockCount: 0 on a variant, a plan or an answer, and offer the alert there.

The shop must turn alerts on: shop.settings.outOfStockEnabled and shop.limits.outOfStock must both be true.

Method parameters

payloadRequiredStockSubscriptionPayload

What to watch, and where to send the alert.

ReturnsPromise<StockSubscriptionResponse>

The alert record.


Watch a variant
await subbly.stock.subscribe({
  email: 'me@example.com',
  productId: 456,
  quantity: 1
})


Watch a survey answer
await subbly.stock.subscribe({
  email: 'me@example.com',
  answerId: 789
})

Last modified on September 15, 2026

Stock notifications

Ask Subbly to email a customer when an item is back in stock.

Asks Subbly to email the customer when a product or a survey answer is back in stock. Watch for stockCount: 0 on a variant, a plan or an answer, and offer the alert there.

The shop must turn alerts on: shop.settings.outOfStockEnabled and shop.limits.outOfStock must both be true.

Method parameters

payloadRequiredStockSubscriptionPayload

What to watch, and where to send the alert.

emailRequiredstring

Address the alert goes to.

productIdConditionally requirednumber

The variant or plan that ran out. Send this or answerId, not both.

answerIdConditionally requirednumber

The survey answer that ran out. Send this or productId, not both.

quantityoptionalnumber

How many units the customer wants.

ReturnsPromise<StockSubscriptionResponse>

The alert record.

idnumber

ID of the record.

shopIdnumber

The shop the record belongs to.

productIdnumber

The product being watched.

emailstring

Address the alert goes to.

quantitynumber

How many units the customer wants.

entityIdnumber

ID of the watched product or survey answer.

entityType'product' | 'survey_answer'

What is being watched.

inStockAtstring

When the item came back in stock. Empty until it does.

createdAtstring

When the record was created.

updatedAtstring

When the record last changed.


Watch a variant
await subbly.stock.subscribe({
  email: 'me@example.com',
  productId: 456,
  quantity: 1
})


Watch a survey answer
await subbly.stock.subscribe({
  email: 'me@example.com',
  answerId: 789
})

Last modified on September 15, 2026

Stock notifications

subbly.stock.subscribe(payload)

Method parameters

ReturnsPromise<StockSubscriptionResponse>

Stock notifications

subbly.stock.subscribe(payload)

Method parameters

ReturnsPromise<StockSubscriptionResponse>