CLI: promo-code

farthershore promo-code#

Usage: farthershore promo-code [options] [command]

Manage API-controlled checkout promo codes

Options:
  -h, --help                                         display help for command

Commands:
  list [businessIdOrSlug]                            List API-managed promo codes for checkout
  create [options] [businessIdOrSlug]                Create an API-managed checkout promo code
  update [options] [businessIdOrSlug] [promoCodeId]  Update an API-managed checkout promo code
  archive [businessIdOrSlug] [promoCodeId]           Archive a checkout promo code
  reactivate [businessIdOrSlug] [promoCodeId]        Reactivate an archived checkout promo code
  help [command]                                     display help for command

farthershore promo-code list#

Usage: farthershore promo-code list [options] [businessIdOrSlug]

List API-managed promo codes for checkout

Options:
  -h, --help  display help for command

farthershore promo-code create#

Usage: farthershore promo-code create [options] [businessIdOrSlug]

Create an API-managed checkout promo code

Options:
  --code <code>            Customer-entered promo code.
  --kind <kind>            percent_off, amount_off, or free_months.
  --percent <n>            Percent discount for percent_off promos.
  --amount-cents <cents>   Fixed discount in cents for amount_off promos.
  --duration-months <n>    Discount duration in months.
  --max-redemptions <n>    Optional maximum redemption count.
  --active-from <iso>      Optional ISO-8601 activation timestamp.
  --active-until <iso>     Optional ISO-8601 expiration timestamp.
  --plan <planId>          Limit to a plan id. Repeatable. Omit for all launch
                           plans; use --all-plans on update to clear scoped
                           plans. (default: [])
  --idempotency-key <key>  Required for this mutation. Generate it once and
                           reuse the exact value on retry.
  -h, --help               display help for command

farthershore promo-code update#

Usage: farthershore promo-code update [options] [businessIdOrSlug] <promoCodeId>

Update an API-managed checkout promo code

Options:
  --code <code>            Replacement customer-entered promo code.
  --kind <kind>            percent_off, amount_off, or free_months.
  --percent <n>            Percent discount for percent_off promos.
  --amount-cents <cents>   Fixed discount in cents for amount_off promos.
  --duration-months <n>    Discount duration in months.
  --max-redemptions <n>    Set maximum redemption count.
  --clear-max-redemptions  Clear the maximum redemption count.
  --active-from <iso>      Set ISO-8601 activation timestamp.
  --clear-active-from      Clear activation timestamp.
  --active-until <iso>     Set ISO-8601 expiration timestamp.
  --clear-active-until     Clear expiration timestamp.
  --plan <planId>          Limit to a plan id. Repeatable. Omit for all launch
                           plans; use --all-plans on update to clear scoped
                           plans. (default: [])
  --all-plans              Clear plan scoping so the promo applies to all launch
                           plans.
  --idempotency-key <key>  Required for this mutation. Generate it once and
                           reuse the exact value on retry.
  -h, --help               display help for command

farthershore promo-code archive#

Usage: farthershore promo-code archive [options] [businessIdOrSlug] <promoCodeId>

Archive a checkout promo code

Options:
  -h, --help  display help for command

farthershore promo-code reactivate#

Usage: farthershore promo-code reactivate [options] [businessIdOrSlug] <promoCodeId>

Reactivate an archived checkout promo code

Options:
  -h, --help  display help for command