TariffBookingCredits
Get one TariffBookingCredit
Retrieve a single TariffBookingCredit record by its Id.
GET
Get one TariffBookingCredit
Plan booking credit (internally TariffBookingCredit) represents an amount of monetary credit linked to a plan (internally Tariff). The
Credit value specifies how much credit is included. The renewal time controls how often the credit expires and the allowance resets.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the TariffBookingCredit-Read role.Path Parameters
Code Examples
Response
200
List of the IDs of the products this booking credit can be used for. Applies only when IsUniversalCredit is true..
List of the IDs of the plans this booking credit can be used for. Applies only when IsUniversalCredit is true..
Whether this credit can be used to pay for bookings. Restrict to specific resource types using elegible-resource-types.
Whether this credit can be used to pay for event sign-ups. Restrict to specific categories with ElegibleResourceTypes.
List of the IDs of the event categories this booking credit can be used for. Applies only when IsUniversalCredit is true..
How often will this credit amount will expire and be issued again. Most common option is TariffMonth, which follows the plan renewal cycle.. See
eTimeSpanWeekMonth enum values: 1 = Week, 2 = CalendarMonth, 3 = TariffMonth, 4 = Year, 5 = Day.Whether this is a universal credit applicable to products, time passes and other charges. Restrict with ElegibleProducts, ElegiblePasses and AppliesToCharges; if all are empty the credit applies to all products, passes and charges.
List of the IDs of the passes this booking credit can be used for. Applies only when IsUniversalCredit is true..
Example Response