Skip to content
Navigation

Cancels an event: it stops selling, its sessions ahead come off the schedule, and every attendee is told and refunded in full.

POST
https://api.sherpo.io/merchant/v1/stores/{store}/products/{product}/cancel

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

  • product
    string
    required

    An id, or slug:<slug>.

    minLength: 1

Header parameters

  • Idempotency-Key
    optional
    string

    Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.

    maxLength: 255 · minLength: 1 · pattern: ^[\x21-\x7E]+$

Request body JSON optional

Returns

200

Cancels an event: it stops selling, its sessions ahead come off the schedule, and every attendee is told and refunded in full.

JSON
  • product_id
    string
    required
  • canceled_at
    string
    required
  • subscriptions
    integer
    required

    Subscriptions to the event it stops billing.

    minimum: 0
  • finished_at
    required

    When every holder had lost their access and was owed their mail and refunds; null while that runs.

    One of the following:

    • string
    • null
  • removed
    array of
    object
    required

    The sessions ahead it took off the schedule.

    • id
      string
      required

      The session's id, which a calendar knows it by.

    • starts_at
      string
      required
    • ends_at
      string
      required
    • time_zone
      string
      required
    • venue
      required

      One of the following:

      • string
      • null
    • online_label
      required

      One of the following:

      • string
      • null
  • refunds
    object
    required
    • pending
      number
      required
    • failed
      number
      required
    • manual
      number
      required
    • refunded
      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