Skip to content
Navigation

Finishes a plan switch whose charge waited on its card holder, charging nothing more: the plan once paid, or the charge voided when it was not confirmed. Only a member with full access finishes it.

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

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

Request body JSON optional

  • key
    optional
    lite_monthly
    or
    lite_yearly
    or
    pro_monthly
    or
    pro_yearly

    The plan the switch waiting moves to, checked against it; any switch waiting when left out.

  • confirmed
    optional
    boolean

    False when the card holder didn't confirm, so a charge still waiting is voided; true by default.

Returns

200

Finishes a plan switch whose charge waited on its card holder, charging nothing more: the plan once paid, or the charge voided when it was not confirmed. Only a member with full access finishes it.

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