Overview

Introduction Changelog Requirements Libraries Authorization Testing the Authorization Enumerables

Endpoints

Accounts Amenities Applications Availabilities Bathrooms Bedrooms Booking Discount Codes Booking Discount Code Usages Bookings Booking Comments Bookings Fees Bookings Payments Bookings Tags Bookings Taxes Change Overs Clients Contacts Destinations Fees Fees Taxes Hosts Inbox Attachments Inbox Conversations Inbox Messages Inbox Participants Inquiries Living Rooms LOS Records Me Mid Term Rate Maps Nightly Rate Maps Payment Gateways Payments Periods Photos Rates Rates Rules Rates Tables Rentals Rental Contacts Rental Agreements Rental Cancelation Policies Rental Cancelation Policy Items Rentals Amenities ! Rentals Contents Overrides Rentals Fees Rental Link Groups Rental Links Rentals Tags Rentals Taxes Rental URLs Reviews Seasons Sources Special Offers Taxes Tax Rules

Discount Code Usages

  1. Overview
  2. List Discount Code Usages
  3. Get a single Discount Code Usage

Overview

This resource represents the usage of a Discount Code which are created when the Discount Code is applied via instant booking page or booknow widget.

Parameters

Name Type Read/Write Description
id String[UUID] Read Discount Code Usage’s id.
currency String Read Currency of applied discount.
amount_in_cents Integer Read Applied amount of discount in cents.
created_at Time Read Discount Code Usage create time (discount application time)
canceled_at Time Read Discount Code Usage soft delete time

List Discount Code Usages

Returns all Discount Codes Usages for current account.

GET /booking/discount_code_usages

Response

{
  "links": {
    "discount_codes.bookings": "http://www.bookingsync.com/api/v3/bookings/{discount_codes_usages.bookings}",
    "discount_codes.discount_codes": "http://www.bookingsync.com/api/v3/booking/discount_codes/{discount_code_usages.discount_code}"
  },
  "discount_codes": [
    {
      "links": {
        "booking": 42,
        "discount_code": 512
      },
      "id": "db6c0845-6122-4de6-a9ab-7a685e2a17f0",
      "currency": "EUR",
      "amount_in_cents": 10000,
      "created_at": "2023-01-24T15:22:55Z",
      "canceled_at": null
    }
  ],
  "meta": {
  }
}

Get a single Discount Code Usage

Returns a single Discount Code Usage identified by ID.

GET /booking/discount_code_usages/:discount_code_usage_id

Response

{
  "links": {
    "discount_codes.bookings": "http://www.bookingsync.com/api/v3/bookings/{discount_codes_usages.bookings}",
    "discount_codes.discount_codes": "http://www.bookingsync.com/api/v3/booking/discount_codes/{discount_code_usages.discount_code}"
  },
  "discount_codes": [
    {
      "links": {
        "booking": 42,
        "discount_code": 512
      },
      "id": "db6c0845-6122-4de6-a9ab-7a685e2a17f0",
      "currency": "EUR",
      "amount_in_cents": 10000,
      "created_at": "2023-01-24T15:22:55Z",
      "canceled_at": null
    }
  ],
  "meta": {
  }
}