Redeem credit coupon

redeemCreditCoupon(input: CreditCouponInput!): CreditCouponRedemption!

Requires account.billing.manage.

Arguments

ArgumentTypeRequired
inputCreditCouponInput!Yes

Input fields

input

CreditCouponInput

FieldTypeRequired
codeString!Yes

Response

Returns CreditCouponRedemption!. Open the type for its fields and nested types.

FieldTypeDescription
statusString!Coupon redemption result. A replay of a redeemed code returns already_redeemed.
creditsGrantedInt!
balanceCreditCouponBalance!
transactionIdID

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

graphql
mutation RedeemCreditCoupon($input: CreditCouponInput!) {
  redeemCreditCoupon(input: $input) {
    status
    creditsGranted
    transactionId
  }
}
json
{
  "input": {
    "code": "EXAMPLE100"
  }
}