Discount

Gets the details for a specific discount on a customer account

• POST/account/reseller/{uuid}/discount

  Creates a discount on a customer account

  Back to top

  Request Details

  Response Details

  Request Details

  This command has no URL/Query String parameters

  POST body

  • Name

  • Type

  • Required

  • • action

    • String

    • True

    The action to apply this discount to. Must be one of `all`, `create`, `update`, `delete`, `renew`, `restore`, `transfer` or `backorder`.

  • • discount_type

    • String

    • True

    The type of discount to apply. Must be one of `amount`, `percent` or `override`

  • • discount_value

    • Integer

    • True

    The value of discount to apply, depending on the discount type.If the type is amount, this value is in pence.If the type is percent, this value must be between 1-100.If the type is override, this value must be greater than or equal to 0

  JSON all-fields example:

  {
      "action" : "renew",
      "discount_type" : "percent",
      "discount_value" : 80
  }

  Response Details

  201 Response

  {
      "result" : {
          "action" : "renew",
          "discount_type" : "percent",
          "discount_value" : 80
      },
      "status_code" : 201,
      "status_message" : "Created"
  }

  400 Response

  {
      "result" : {},
      "status_code" : 400,
      "status_message" : "Bad Request"
  }

• PUT/account/reseller/{uuid}/discount/{discount_uuid}

  Update a customer discount

  Back to top

  Request Details

  Response Details

  Request Details

  URL and Query String Parameters

  • Name

  • Type

  • Required

  • • discount_uuid

    • String

    • True

    The UUID of the discount to be updated

  PUT body

  • Name

  • Type

  • Required

  • • action

    • String

    • True

    The action to apply this discount to. Must be one of `all`, `create`, `update`, `delete`, `renew`, `restore`, `transfer` or `backorder`.

  • • discount_type

    • String

    • True

    The type of discount to apply. Must be one of `amount`, `percent` or `override`

  • • discount_value

    • Integer

    • True

    The value of discount to apply, depending on the discount type.If the type is amount, this value is in pence.If the type is percent, this value must be between 1-100.If the type is override, this value must be greater than or equal to 0

  JSON all-fields example:

  {
      "action" : "renew",
      "discount_type" : "percent",
      "discount_value" : 80
  }

  Response Details

  200 Response

  {
      "result" : {
          "action" : "renew",
          "discount_type" : "percent",
          "discount_value" : 80
      },
      "status_code" : 200,
      "status_message" : "OK"
  }

  400 Response

  {
      "result" : {},
      "status_code" : 400,
      "status_message" : "Bad Request"
  }

  404 Response

  {
      "result" : {},
      "status_code" : 404,
      "status_message" : "Not Found"
  }

• DELETE/account/reseller/{uuid}/discount/{discount_uuid}

  Delete a discount from a customer account

  Back to top

  Request Details

  Response Details

  Request Details

  URL and Query String Parameters

  • Name

  • Type

  • Required

  • • uuid

    • String

    • True

    The UUID of the discount to be deleted

  Response Details

  204 Response

  {
      "result" : {},
      "status_code" : 204,
      "status_message" : "No Content"
  }

  404 Response

  {
      "result" : {},
      "status_code" : 404,
      "status_message" : "Not Found"
  }