Skip to content
Navigation

Counts a product's customers by status.

GET
https://api.sherpo.io/merchant/v1/stores/{store}/products/{product}/customers/stats

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

  • product
    string
    required

    An id, or slug:<slug>.

    minLength: 1

Returns

200

Counts a product's customers by status.

JSON
  • total
    number
    required
  • by_status
    object
    required
    • scheduled
      number
      required
    • unpaid
      number
      required
    • active
      number
      required
    • expired
      number
      required
    • past_due
      number
      required
    • paused
      number
      required
    • cancelled
      number
      required
    • ended
      number
      required
    • revoked
      number
      required
    • cancelling
      number
      required
    • refunded
      number
      required
  • by_kind
    object
    required
    • subscription
      number
      required
    • grant
      number
      required
  • active_granted
    number
    required
  • active_subscribed
    number
    required
JSON
  • type
    string
    required
    format: uri
  • title
    string
    required
  • status
    integer
    required
  • detail
    string
    required
  • code
    optional
    string
  • context
    optional
    object
  • reached_core
    optional
    boolean
  • core_answer
    optional
    string

Type to search…

↑↓ navigate↵ selectEsc close