Skip to content
Soljio Docs
Esc
↑↓navigate↵open⌘Jpreview

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_settings
Authorization
AuthorizationBearer token (soljio_sk_<secret>) · headerrequired

Organization-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/json
inactive_pagination_optsobject
Show properties
num_itemsintegerrequired
min 1 · max 100
cursorstring | nullrequired
Show properties
Any of:
string
string
null
null
end_cursorstring | null
Show properties
Any of:
string
string
null
null
idnumber
maximum_rows_readnumber
maximum_bytes_readnumber
Responses
200

Successful read.

dataobjectrequired
Show properties
inactive_next_cursorstring | nullrequired
Show properties
Any of:
string
string
null
null
promo_codesobject[]required
Show properties
Array of object
activebooleanrequired
codestringrequired
expires_atstring<date-time>
idstringrequired

Opaque Soljio resource ID.

min length 1
max_usesnumber
program_namesstring[]
redemption_countnumberrequired
ruleobjectrequired
Show properties
Any of:
object
kindstringrequired
percentnumberrequired
object
amount_minornumberrequired
currencystringrequired
kindstringrequired
sibling_discountobject
Show properties
Any of:
object
kindstringrequired
percentnumberrequired
object
amount_minornumberrequired
currencystringrequired
kindstringrequired
request_idstring<uuid>required
400

invalid_request

errorobjectrequired
Show properties
codestringrequired
Allowed:invalid_request
messagestringrequired
request_idstring<uuid>required
401

unauthorized

errorobjectrequired
Show properties
codestringrequired
Allowed:unauthorized
messagestringrequired
request_idstring<uuid>required
403

forbidden

errorobjectrequired
Show properties
codestringrequired
Allowed:forbidden
messagestringrequired
request_idstring<uuid>required
404

not_found

errorobjectrequired
Show properties
codestringrequired
Allowed:not_found
messagestringrequired
request_idstring<uuid>required
405

method_not_allowed

errorobjectrequired
Show properties
codestringrequired
Allowed:method_not_allowed
messagestringrequired
request_idstring<uuid>required
409

conflict, idempotency_conflict

errorobjectrequired
Show properties
codestringrequired
Allowed:conflictidempotency_conflict
messagestringrequired
request_idstring<uuid>required
413

payload_too_large

errorobjectrequired
Show properties
codestringrequired
Allowed:payload_too_large
messagestringrequired
request_idstring<uuid>required
415

unsupported_media_type

errorobjectrequired
Show properties
codestringrequired
Allowed:unsupported_media_type
messagestringrequired
request_idstring<uuid>required
429

rate_limited

errorobjectrequired
Show properties
codestringrequired
Allowed:rate_limited
messagestringrequired
request_idstring<uuid>required
500

internal_error

errorobjectrequired
Show properties
codestringrequired
Allowed:internal_error
messagestringrequired
request_idstring<uuid>required
Try it
Server
Authorization
Bodyapplication/json
Request
curl -X POST 'https://api.soljio.com/v0/queries/get_discount_settings' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "inactive_pagination_opts": {
    "num_items": 1,
    "cursor": "string",
    "end_cursor": "string",
    "id": 0,
    "maximum_rows_read": 0,
    "maximum_bytes_read": 0
  }
}'
Response
{
  "data": {
    "inactive_next_cursor": "string",
    "promo_codes": [
      {
        "active": true,
        "code": "string",
        "expires_at": "2019-08-24T14:15:22Z",
        "id": "string",
        "max_uses": 0,
        "program_names": [
          "string"
        ],
        "redemption_count": 0,
        "rule": {
          "kind": "percent",
          "percent": 0
        }
      }
    ],
    "sibling_discount": {
      "kind": "percent",
      "percent": 0
    }
  },
  "request_id": "266ea41d-adf5-480b-af50-15b940c2b846"
}