Get the sibling discount and promo codes.
Get the sibling discount and promo codes. An organization-scoped read using JSON filter arguments; requires invoices.read. Pagination cursors must be reused only with the same organization, operation and filters.
POST
/queries/get_discount_settingsAuthorization
AuthorizationBearer token (soljio_sk_<secret>) · headerrequiredOrganization-scoped service token created by an owner/admin. Scope requirements are in x-required-scopes; these are service-token grants, not OAuth scopes. Revoked, expired, unknown and suspended-organization credentials all return 401.
Request body
requiredapplication/jsoninactive_pagination_optsobjectShow propertiesHide properties
num_itemsintegerrequiredmin 1 · max 100
cursorstring | nullrequiredShow propertiesHide properties
Any of:
string
stringnull
nullend_cursorstring | nullShow propertiesHide properties
Any of:
string
stringnull
nullidnumbermaximum_rows_readnumbermaximum_bytes_readnumberResponses
200
Successful read.
dataobjectrequiredShow propertiesHide properties
inactive_next_cursorstring | nullrequiredShow propertiesHide properties
Any of:
string
stringnull
nullpromo_codesobject[]requiredShow propertiesHide properties
Array of
objectactivebooleanrequiredcodestringrequiredexpires_atstring<date-time>idstringrequiredOpaque Soljio resource ID.
min length 1
max_usesnumberprogram_namesstring[]redemption_countnumberrequiredruleobjectrequiredShow propertiesHide properties
Any of:
object
kindstringrequiredpercentnumberrequiredobject
amount_minornumberrequiredcurrencystringrequiredkindstringrequiredsibling_discountobjectShow propertiesHide properties
Any of:
object
kindstringrequiredpercentnumberrequiredobject
amount_minornumberrequiredcurrencystringrequiredkindstringrequiredrequest_idstring<uuid>required400
invalid_request
errorobjectrequiredShow propertiesHide properties
codestringrequiredAllowed:
invalid_requestmessagestringrequiredrequest_idstring<uuid>required401
unauthorized
errorobjectrequiredShow propertiesHide properties
codestringrequiredAllowed:
unauthorizedmessagestringrequiredrequest_idstring<uuid>required403
forbidden
errorobjectrequiredShow propertiesHide properties
codestringrequiredAllowed:
forbiddenmessagestringrequiredrequest_idstring<uuid>required404
not_found
errorobjectrequiredShow propertiesHide properties
codestringrequiredAllowed:
not_foundmessagestringrequiredrequest_idstring<uuid>required405
method_not_allowed
errorobjectrequiredShow propertiesHide properties
codestringrequiredAllowed:
method_not_allowedmessagestringrequiredrequest_idstring<uuid>required409
conflict, idempotency_conflict
errorobjectrequiredShow propertiesHide properties
codestringrequiredAllowed:
conflictidempotency_conflictmessagestringrequiredrequest_idstring<uuid>required413
payload_too_large
errorobjectrequiredShow propertiesHide properties
codestringrequiredAllowed:
payload_too_largemessagestringrequiredrequest_idstring<uuid>required415
unsupported_media_type
errorobjectrequiredShow propertiesHide properties
codestringrequiredAllowed:
unsupported_media_typemessagestringrequiredrequest_idstring<uuid>required429
rate_limited
errorobjectrequiredShow propertiesHide properties
codestringrequiredAllowed:
rate_limitedmessagestringrequiredrequest_idstring<uuid>required500
internal_error
errorobjectrequiredShow propertiesHide properties
codestringrequiredAllowed:
internal_errormessagestringrequiredrequest_idstring<uuid>required