Skip to content
Navigation

Pages the store's subscriptions.

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

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

Query parameters

  • filter
    optional
    object

    filter[<field>]=<value> is an equality, filter[<field>][<op>]=<value> names the operator; in repeats the parameter.

  • sort
    optional
    created
    or
    ended
    or
    status
    or
    tier
    or
    amount

    Sorted by ended, rows without a value come last either way.

  • direction
    optional
    asc
    or
    desc
  • limit
    optional
    integer
    maximum: 100 · minimum: 1
  • cursor
    optional
    string
    maxLength: 8192
  • count
    optional
    boolean
  • search
    optional
    string
    maxLength: 200 · minLength: 1
  • facets
    optional
    array of
    string

Returns

200

Pages the store's subscriptions.

JSON
  • items
    array of
    object
    required
    • display_status
      string
      required

      Its status as people read it: cancelling while it bills and is set to stop.

    • next_event
      required

      What happens at the end of its latest paid period, as of the answer; null when nothing is ahead.

      One of the following:

      • object
      • null
    • actions
      object
      required

      The moves the store offers on it as of the answer; a write still decides again.

      • cancel
        object
        required
        • period_end
          boolean
          required

          Stopping at the period's end: it bills, is not set to stop, and its period has not ended or is not known yet.

        • now
          boolean
          required

          Ending it now, revoking what it paid for.

      • resume
        boolean
        required

        Taking a stop back: it still bills and is set to stop.

    • period_end
      required

      When its period ends, as a cancel reads it; null for none, or once a period was refunded and none is paid.

      One of the following:

      • string
      • null
    • customer
      required

      One of the following:

      • object
      • null
    • product
      required

      One of the following:

      • object
      • null
    • plan
      required

      One of the following:

      • object
      • null
    • periods
      object
      required
      • items
        array of
        object
        required
        • id
          string
          required
        • subscription_id
          string
          required
        • starts_at
          required

          One of the following:

          • string
          • null
        • ends_at
          required

          One of the following:

          • string
          • null
        • status
          string
          required
        • lead_in
          boolean
          required

          A first period the customer's own grant covered, charged nothing; the plan's first charge pays the next.

        • settlement_id
          required

          One of the following:

          • string
          • null
        • grant_id
          required

          One of the following:

          • string
          • null
        • currency
          required

          One of the following:

          • string
          • null
        • exponent
          required

          One of the following:

          • number
          • null
        • amount
          required

          One of the following:

          • number
          • null
        • order
          required

          One of the following:

          • object
          • null
      • total
        number
        required
    • scheduled_change
      required

      The plan it renews on from effective_at, the end of its paid run, as the customer scheduled; null for none.

      One of the following:

      • object
      • null
    • id
      string
      required
    • customer_id
      string
      required
    • product_id
      string
      required
    • plan_id
      string
      required
    • processor
      required

      One of the following:

      • string
      • null
    • external_ref
      required

      One of the following:

      • string
      • null
    • account_ref
      required

      One of the following:

      • string
      • null
    • status
      string
      required
    • cancel_at_period_end
      boolean
      required
    • instrument_ref
      required

      One of the following:

      • string
      • null
    • cancel_reason
      required

      One of the following:

      • string
      • null
    • created_at
      required

      One of the following:

      • string
      • null
    • ended_at
      required

      One of the following:

      • string
      • null
  • cursor
    required

    One of the following:

    • string
    • null
  • total
    optional
    number
  • facets
    optional
    map of
    map<number>
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