Skip to content
Navigation

Previews switching the business's plan to another tier or billing period: when it takes effect, what it charges now and what it renews at, with a quote that holds the amount for 5 minutes. It takes effect now, prorated, when the tier doesn't drop and the period doesn't shorten; any other switch from the period's end.

GET
https://api.sherpo.io/merchant/v1/stores/{store}/organization/plan/change/preview

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

Query parameters

  • key
    lite_monthly
    or
    lite_yearly
    or
    pro_monthly
    or
    pro_yearly
    required

    The plan to switch to, by its price's key: its tier and how often it bills.

Returns

200

Previews switching the business's plan to another tier or billing period: when it takes effect, what it charges now and what it renews at, with a quote that holds the amount for 5 minutes. It takes effect now, prorated, when the tier doesn't drop and the period doesn't shorten; any other switch from the period's end.

JSON
  • quote
    string
    required
  • effective
    string
    required
  • effective_at
    string
    required
  • expires_at
    string
    required
  • currency
    string
    required
  • exponent
    number
    required
  • amount_due
    number
    required
  • tax
    number
    required
  • charge
    number
    required
  • credit
    number
    required
  • other
    number
    required
  • renewal_amount
    number
    required
  • renewal_tax
    number
    required
  • renews_at
    string
    required
  • plan
    object
    required
    • key
      string
      required
    • name
      required

      One of the following:

      • string
      • null
    • tier
      string
      required
    • interval
      string
      required
    • quantity
      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