latestOpenAPI 3.0.12026-07-243686491.1 MB
517e18f11015
Promotion Codes
Retrieve a list of promotion codes
Required scope: promotion-codes:read </br>Organization authorization: supported
get/api/v1/promotion-codes
Query parameters
pageinteger
page number to retrieve (starts with 0)
perPageinteger
number of items per page (between 1 and 100, default 10)
operatorIdinteger nullable
Allows filtering promotion codes by operatorId.</br>*Note:*The operatorId must be in the consumer’s operatorIds or, if empty, belong to the organization’s sub-operators.
Example:1
type'CREDIT' | 'ONGOING_CHARGE_DISCOUNT_PERCENTAGE' | 'CHARGE_PACKAGE_DISCOUNT_PERCENTAGE'
includeDeletedboolean
Includes deleted resources in the response
Example:true
Response
Promotion codes retrieved successfully
OffsetBasedResponse19 required— unresolved $ref