Promotions: vouchers commands

Reference for the `revenexx promotions-vouchers` commands — every subcommand with a runnable example.

Auto-generated. This page is generated from the revenexx CLI by tools/sync-cli-reference.mjs. Don't edit it by hand — your changes will be overwritten.

Every revenexx promotions-vouchers subcommand, with a runnable example and the flags it accepts. Each flag is an API field: its type, allowed values and meaning are in the API reference. Some flag names carry a -_ (e.g. --attribute-_values) — that is the exact token the CLI accepts, so copy them verbatim. Run revenexx promotions-vouchers <command> --help for the live options.

create

Bash
revenexx promotions-vouchers create \
    --code '' \
    --promotion-id ''

Flags: --code <code> --promotion-id <promotion-id> --batch-id <batch-id> --contact-id <contact-id> --currency <currency> --ends-at <ends-at> --metadata <metadata> --organization-id <organization-id> --reservation-limit <reservation-limit> --reservation-required [value] --residual-value <residual-value> --starts-at <starts-at> --status <status> --usage-limit <usage-limit>

delete

Bash
revenexx promotions-vouchers delete \
    --id ''

Flags: --id <id>

get

Bash
revenexx promotions-vouchers get \
    --id ''

Flags: --id <id>

list

Bash
revenexx promotions-vouchers list

Flags: --limit <limit> --offset <offset> --order <order> --id <id> --promotion-id <promotion-id> --batch-id <batch-id> --code <code> --code-key <code-key> --status <status> --usage-limit <usage-limit> --usage-count <usage-count> --currency <currency> --contact-id <contact-id> --organization-id <organization-id> --reservation-required <reservation-required> --filter <column=value>

promotions-batches-create

Bash
revenexx promotions-vouchers promotions-batches-create \
    --name '' \
    --promotion-id ''

Flags: --name <name> --promotion-id <promotion-id> --alphabet <alphabet> --metadata <metadata> --pattern <pattern> --request-ref <request-ref> --requested <requested> --status <status>

promotions-batches-delete

Bash
revenexx promotions-vouchers promotions-batches-delete \
    --id ''

Flags: --id <id>

promotions-batches-disable

Bash
revenexx promotions-vouchers promotions-batches-disable \
    --id ''

Flags: --id <id>

promotions-batches-export

Bash
revenexx promotions-vouchers promotions-batches-export \
    --id ''

Flags: --id <id>

promotions-batches-export-file

Bash
revenexx promotions-vouchers promotions-batches-export-file \
    --id ''

Flags: --id <id>

promotions-batches-generate

Bash
revenexx promotions-vouchers promotions-batches-generate \
    --id '' \
    --count 1

Flags: --id <id> --count <count> --alphabet <alphabet> --pattern <pattern> --request-ref <request-ref> --usage-limit <usage-limit>

promotions-batches-generate-for

Bash
revenexx promotions-vouchers promotions-batches-generate-for \
    --id '' \
    --recipients one two three

Flags: --id <id> --recipients [recipients...]

promotions-batches-get

Bash
revenexx promotions-vouchers promotions-batches-get \
    --id ''

Flags: --id <id>

promotions-batches-import

Bash
revenexx promotions-vouchers promotions-batches-import \
    --id '' \
    --codes one two three

Flags: --id <id> --codes [codes...] --usage-limit <usage-limit>

promotions-batches-list

Bash
revenexx promotions-vouchers promotions-batches-list

Flags: --limit <limit> --offset <offset> --order <order> --id <id> --promotion-id <promotion-id> --name <name> --pattern <pattern> --alphabet <alphabet> --requested <requested> --created-count <created-count> --redeemed-count <redeemed-count> --status <status> --request-ref <request-ref> --filter <column=value>

promotions-batches-update

Bash
revenexx promotions-vouchers promotions-batches-update \
    --id ''

Flags: --id <id> --alphabet <alphabet> --metadata <metadata> --name <name> --pattern <pattern> --promotion-id <promotion-id> --request-ref <request-ref> --requested <requested> --status <status>

promotions-voucher-reservations-create

Bash
revenexx promotions-vouchers promotions-voucher-reservations-create \
    --voucher-id ''

Flags: --voucher-id <voucher-id> --contact-id <contact-id> --expires-at <expires-at> --organization-id <organization-id>

promotions-voucher-reservations-delete

Bash
revenexx promotions-vouchers promotions-voucher-reservations-delete \
    --id ''

Flags: --id <id>

promotions-voucher-reservations-get

Bash
revenexx promotions-vouchers promotions-voucher-reservations-get \
    --id ''

Flags: --id <id>

promotions-voucher-reservations-list

Bash
revenexx promotions-vouchers promotions-voucher-reservations-list

Flags: --limit <limit> --offset <offset> --order <order> --id <id> --voucher-id <voucher-id> --contact-id <contact-id> --organization-id <organization-id> --filter <column=value>

promotions-voucher-reservations-update

Bash
revenexx promotions-vouchers promotions-voucher-reservations-update \
    --id ''

Flags: --id <id> --contact-id <contact-id> --expires-at <expires-at> --organization-id <organization-id> --voucher-id <voucher-id>

update

Bash
revenexx promotions-vouchers update \
    --id ''

Flags: --id <id> --batch-id <batch-id> --code <code> --contact-id <contact-id> --currency <currency> --ends-at <ends-at> --metadata <metadata> --organization-id <organization-id> --promotion-id <promotion-id> --reservation-limit <reservation-limit> --reservation-required [value] --residual-value <residual-value> --starts-at <starts-at> --status <status> --usage-limit <usage-limit>

Was this page helpful?