HEhelloasso
discount resource

Create discount resource

post/v1/organizers/{organizerId}/events/{eventId}/discounts

Request

  • Base URL
    https://api.plusbilletterie.helloasso.com
  • URL
    https://api.plusbilletterie.helloasso.com/v1/organizers/{organizerId}/events/{eventId}/discounts
  • Auth
    API key in header X-API-KEY

Path parameters

organizerIdstring objectId required

Resource identifier.

eventIdstring objectId required

Resource identifier.

Request body

amountnumber

Montant de la réduction, il s'agit d'un pourcentage entre 0 et 1 si le type est 'ratio' ou d'un montant fixe en centime si le type est 'fixed'.

status'enabled' | 'disabled' nullable
type'ratio' | 'fixed' nullable
maxCountinteger nullable

Nombre maximal de fois où le discount peut être utilisé. Null si illimité

Example request

{
  "name": "x",
  "status": "enabled",
  "type": "ratio",
  "rules": [
    {
      "scope": "optional"
    }
  ],
  "maxCount": -9007199254740991
}

Response

Success

amountnumber required

Montant de la réduction, il s'agit d'un pourcentage entre 0 et 1 si le type est 'ratio' ou d'un montant fixe en centime si le type est 'fixed'.

status'enabled' | 'disabled' nullable
type'ratio' | 'fixed' nullable
maxCountinteger nullable

Nombre maximal de fois où le discount peut être utilisé. Null si illimité

_idstring objectId required
_createdAtstring date-time required
_updatedAtstring date-time nullable
_referencestring nullable

Example response

{
  "name": "x",
  "status": "enabled",
  "type": "ratio",
  "rules": [
    {
      "scope": "optional"
    }
  ],
  "maxCount": -9007199254740991,
  "_id": "64b7f8b6f23a4a4f3d0a9b12",
  "_createdAt": "2024-01-01T00:00:00.000Z",
  "_updatedAt": "2024-01-01T00:00:00.000Z",
  "_reference": "string"
}

Changes

No recorded changes to this operation across all 1 revision of this API.