Skip to content
Navigation

Pages what the customer may reach.

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

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

Returns

200

Pages what the customer may reach.

JSON
  • items
    array of
    object
    required
    • product_id
      string
      required
    • tier_rank
      number
      required
    • tier_expires_at
      required

      One of the following:

      • string
      • null
    • expires_at
      required

      One of the following:

      • string
      • null
    • held
      boolean
      required
    • order
      required

      The caller's order behind the highest standing grant that came from one; null when none did, as with a grant by hand.

      One of the following:

      • object
      • null
    • renews_at
      required

      When a subscription of the product next renews; null when none will.

      One of the following:

      • string
      • null
    • given_by
      required

      For an event ticket someone else bought the caller as their guest: who; null otherwise.

      One of the following:

      • object
      • null
    • attending
      boolean
      required

      Whether the caller is going to the event, a ticket with no tier included; false for any other product.

    • ticket
      required

      The caller's ticket to the event as its grants read now: whether it lets them in, why not, and its type; null for any other product, and for a moment after a first ticket while it is listed, even with attending already true.

      One of the following:

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