Skip to content
Navigation

Reads the store's subscription stats over a period.

GET
https://api.sherpo.io/merchant/v1/stores/{store}/subscriptions/stats

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

Query parameters

  • from
    optional
    string
    format: date
  • to
    optional
    string
    format: date
  • bucket
    optional
    day
    or
    week
    or
    month
  • product
    optional
    string

    An id.

    minLength: 1

Returns

200

Reads the store's subscription stats over a period.

JSON
  • total
    number
    required
  • by_status
    object
    required
    • active
      number
      required
    • past_due
      number
      required
    • paused
      number
      required
  • cancelling
    number
    required
  • started
    object
    required
    • current
      number
      required
    • previous
      number
      required
  • mrr
    array of
    object
    required
    • currency
      string
      required
    • exponent
      required

      One of the following:

      • number
      • null
    • active
      required

      One of the following:

      • number
      • null
    • at_risk
      required

      One of the following:

      • number
      • null
    • ending
      required

      One of the following:

      • number
      • null
  • churn
    object
    required
    • current
      object
      required
      • ended
        number
        required
      • base
        number
        required
    • previous
      object
      required
      • ended
        number
        required
      • base
        number
        required
  • series
    array of
    object
    required
    • previous_active
      number
      required
    • previous_past_due
      number
      required
    • previous_paused
      number
      required
    • start
      string
      required
    • end
      string
      required
    • active
      number
      required
    • past_due
      number
      required
    • paused
      number
      required
  • bucket
    string
    required
  • time_zone
    string
    required
  • from
    string
    required
  • to
    string
    required
  • previous_range
    object
    required
    • from
      string
      required
    • to
      string
      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