Skip to content
Navigation

Pages the customer's subscriptions.

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

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    A hostname of the store.

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
  • direction
    optional
    asc
    or
    desc
  • limit
    optional
    integer
    maximum: 100 · minimum: 1
  • cursor
    optional
    string
    maxLength: 8192
  • count
    optional
    boolean

Returns

200

Pages the customer'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
    • renews_on_card
      boolean
      required

      Whether the store holds its saved card for its renewals: billed here, renewing and not set to stop.

    • actions
      object
      required

      The moves the store offers on it as of the answer, billed here and still renewing; a write still decides again.

      • cancel
        object
        required
        • period_end
          boolean
          required

          Stopping at the period's end.

        • now
          boolean
          required

          Its cancel ends it at once, every payment of it refunded.

      • resume
        boolean
        required

        Taking a stop back.

      • change_plan
        boolean
        required

        Scheduling another plan from plan_changes, or keeping the current one.

    • plan_changes
      array of
      object
      required

      The prices changeSubscriptionPlan schedules for it, ordered as offers are; empty unless actions.change_plan.

      • price_id
        string
        required
      • name
        string
        required

        The price's title, else its tier's name.

      • tier
        object
        required
        • id
          string
          required
        • product_id
          string
          required
        • rank
          number
          required
        • name
          string
          required
      • amount
        number
        required
      • currency
        string
        required
      • exponent
        required

        One of the following:

        • number
        • null
      • period
        object
        required
        • unit
          string
          required
        • multiplier
          number
          required
      • autorenew
        boolean
        required

        Whether the plan it schedules renews past its first period.

    • product
      required

      One of the following:

      • object
      • null
    • plan
      required

      One of the following:

      • object
      • null
    • current_period
      required

      Its latest paid period, whose end is when the next payment is due; null when none is paid.

      One of the following:

      • object
      • null
    • next_charge
      required

      What its next payment charges and when, a day ahead of the period's end as every renewal is, on the plan it renews on; null unless it renews. A current_period that is a lead_in makes it the first.

      One of the following:

      • object
      • null
    • instrument_id
      required

      The saved payment method its renewals charge, as getBillingProfile names it.

      One of the following:

      • string
      • null
    • renews_here
      boolean
      required

      Whether the store bills it here, so its plan and card can change.

    • 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
    • product_id
      string
      required
    • status
      string
      required
    • cancel_at_period_end
      boolean
      required
    • cancel_reason
      required

      Why it stops or stopped, in the seller's or the customer's own words; null when no one gave one.

      One of the following:

      • string
      • null
    • cancel_code
      required

      How the store stopped it, when no one gave a reason in words: refund (its payments were refunded), dispute (a payment was disputed), upgraded (an upgrade replaced it), account_erased (the customer's account was erased) or seller_ended (the seller ended it); null otherwise.

      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
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