Skip to content
Navigation

Previews what one more store on the business's plan charges now and bills from its next renewal.

POST
https://api.sherpo.io/merchant/v1/stores/{store}/plan_store/preview/query

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

Request body JSON required

  • price
    required

    The plan as the seller saw it, so a plan changed since is never previewed.

    One of the following:

    • string
    • null
  • quantity
    integer
    required

    Stores the plan bills before the one added.

    maximum: 10 · minimum: 1

Returns

200

Previews what one more store on the business's plan charges now and bills from its next renewal.

JSON
  • quote
    string
    required
  • proration_date
    string
    required
  • expires_at
    string
    required
  • currency
    string
    required
  • exponent
    number
    required
  • amount_due
    number
    required
  • tax
    number
    required
  • renewal_amount
    number
    required
  • renewal_tax
    number
    required
  • renews_at
    string
    required
  • trial_ends_at
    required

    One of the following:

    • string
    • null
  • plan
    object
    required
    • name
      required

      One of the following:

      • string
      • null
    • tier
      string
      required
    • interval
      required

      One of the following:

      • string
      • null
    • interval_count
      number
      required
    • quantity
      number
      required
    • limits
      object
      required
      • storage_bytes
        number
        required
      • customers
        required

        One of the following:

        • number
        • number
        • null
      • marketing_emails
        required

        One of the following:

        • number
        • number
        • number
      • members
        required

        One of the following:

        • number
        • number
      • pages
        required

        One of the following:

        • number
        • number
      • unbranded
        boolean
        required
      • domain
        boolean
        required
      • learning
        boolean
        required
      • self_hosted
        boolean
        required
      • ai
        boolean
        required
      • transcription_minutes
        number
        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