Redeem a coupon on an existing customer's account to apply to their next invoice.

Redeeming Multiple Coupons

If you have Multiple Coupons Per Account enabled in Coupon Settings, you can have multiple active redemptions on an account. Call this redeem endpoint multiple times to redeem more than one coupon.

Maxed Out Error

If a coupon can only be redeemed on an account a specific number of times and you have already redeemed the coupon that number of times on the account, you will see a maxed out error letting you know the coupon can no longer be redeemed on the account.

<errors>
    <error field="coupon.base" symbol="maxed_out_for_account">Coupon has reached max redemptions for this account</error>
</errors>

The only way you would be able to redeem this coupon again on the account would be to update the main coupon campaign to allow more redemptions per account.

Subscription-Level Redemption

If the coupon is subscription-level, meaning it has a redemption_resource of "subscription", you must specify the subscription_uuid of an existing subscription on the account that you want to tie the redemption to. Otherwise you will get this error:

<errors>
    <error field="coupon.subscription" symbol="must_be_present">must be redeemed on a subscription</error>
</errors>

If the subscription_uuid you provide is for a subscription with a plan not eligible for the coupon, you will see this error:

<errors>
    <error field="coupon.subscription_uuid" symbol="not_valid_for_redemption">not valid for this coupon</error>
</errors>