Skip to content
Navigation

Switches the business's plan to the one a preview quoted: now, charged at once at the quoted amount and applied only once paid, or from the period's end. A charge the card holder must confirm answers what to confirm it with. Not past a plan held for good, nor to Lite over its limits. Only a member with full access switches.

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

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

Request body JSON required

  • key
    lite_monthly
    or
    lite_yearly
    or
    pro_monthly
    or
    pro_yearly
    required

    The plan to switch to, as previewed.

  • quote
    string
    required

    The quote previewPlanChange answered, whose amount is the one charged.

    maxLength: 4096

Returns

200

Switches the business's plan to the one a preview quoted: now, charged at once at the quoted amount and applied only once paid, or from the period's end. A charge the card holder must confirm answers what to confirm it with. Not past a plan held for good, nor to Lite over its limits. Only a member with full access switches.

JSON
  • plan
    required

    One of the following:

    • object
    • null
  • confirm
    required

    One of the following:

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