Skip to main content

checkoutRemovePromoCode Mutation

Remove a gift card or a voucher from a checkout.

Triggers the following webhook events:

  • CHECKOUT_UPDATED (async): A checkout was updated.
checkoutRemovePromoCode(
  checkoutId: ID
  id: ID
  promoCode: String
  promoCodeId: ID
  token: UUID
): CheckoutRemovePromoCode
Details
type CheckoutRemovePromoCode {
  checkout: Checkout
  checkoutErrors: [CheckoutError!]! @deprecated
  errors: [CheckoutError!]!
}

Arguments​

id ● ID​

The checkout's ID.

promoCode ● String​

Gift card code or voucher code.

promoCodeId ● ID​

Gift card or voucher ID.

Show deprecatedHide deprecated

checkoutId ● ID​

DEPRECATED

Use id instead.

The ID of the checkout.

token ● UUID​

DEPRECATED

Use id instead.

Checkout token.

Type​

CheckoutRemovePromoCode​

Remove a gift card or a voucher from a checkout.

Triggers the following webhook events:

  • CHECKOUT_UPDATED (async): A checkout was updated.