You are reading the documentation for SDK v2, which is no longer the latest version. Switch to current
removeCartCoupon
Endpoint for removing coupon code from cart. By default, it uses the updateCartDefaultQuery GraphQL query
Signature
export declare function removeCartCoupon(
context: SetupContext,
params: RemoveCartCouponParams,
discountCode: ReferenceInput,
customQuery?: CustomQuery,
responseOptions?: ResponseOptions
): Promise<RemoveCartCouponResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
context | Required | SetupContext | Automatically injected context. Refer to SetupContext |
params | Required | RemoveCartCouponParams | Cart information |
discountCode | Required | ReferenceInput | Discount code |
customQuery | Optional | CustomQuery | Custom queries included in the request |
responseOptions | Optional | ResponseOptions |
Returns
User cart information