Skip to content
Navigation

Reads the store's plan, with the day it ends when set to cancel and whether it can still be resumed, and the plan billed once its period ends (a scheduled change up or down, or the base plan a cancelled one lapses into), and every limit it sets each store, with what the store uses of it: storage, transcription minutes, customers (with where the countdown past the cap stands), pages, menu items and redirects (with how many are kept inactive past what the store applies), features, the add-on blocks of storage and AI media minutes the store holds, where the business stands against its plan, what keeps it from moving to Lite and the plan change last called off for it (over its limits, or a move to the plan it holds for good or under it), and the marketing emails it may send a month, whose use is not reported yet.

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

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

Returns

200

Reads the store's plan, with the day it ends when set to cancel and whether it can still be resumed, and the plan billed once its period ends (a scheduled change up or down, or the base plan a cancelled one lapses into), and every limit it sets each store, with what the store uses of it: storage, transcription minutes, customers (with where the countdown past the cap stands), pages, menu items and redirects (with how many are kept inactive past what the store applies), features, the add-on blocks of storage and AI media minutes the store holds, where the business stands against its plan, what keeps it from moving to Lite and the plan change last called off for it (over its limits, or a move to the plan it holds for good or under it), and the marketing emails it may send a month, whose use is not reported yet.

JSON
  • plan
    required

    One of the following:

    • object
    • null
  • metered
    object
    required
    • storage
      object
      required
      • used_bytes
        number
        required

        The files' size in bytes, as they count against the store's storage.

      • allowance_bytes
        number
        required
    • transcription
      object
      required
      • used_minutes
        number
        required
      • allowance_minutes
        number
        required
      • renews_at
        required

        One of the following:

        • string
        • null
    • marketing_emails
      object
      required
      • used
        required

        One of the following:

        • number
        • null
      • allowance
        required

        One of the following:

        • number
        • null
  • add_ons
    object
    required
    • storage
      number
      required
    • minutes
      number
      required
  • auto_upgrade
    boolean
    required
  • within_lite
    boolean
    required
  • over_lite
    array of
    string
    required
  • change_refusal
    required

    One of the following:

    • object
    • null
  • standing
    required

    One of the following:

    • object
    • null
  • counts
    object
    required
    • customers
      object
      required
      • used
        number
        required
      • limit
        required

        One of the following:

        • number
        • null
      • standing
        required

        One of the following:

        • object
        • object
        • null
    • pages
      object
      required
      • used
        number
        required
      • limit
        number
        required
      • inactive
        number
        required
    • menu
      object
      required
      • used
        number
        required
      • limit
        number
        required
      • inactive
        number
        required
    • internal_redirects
      object
      required
      • used
        number
        required
      • limit
        number
        required
      • inactive
        number
        required
    • external_redirects
      object
      required
      • used
        number
        required
      • limit
        number
        required
      • inactive
        number
        required
  • features
    object
    required
    • domain
      boolean
      required
    • unbranded
      boolean
      required
    • stylesheet
      boolean
      required
    • learning
      boolean
      required
    • self_hosted
      boolean
      required
    • ai
      boolean
      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