Skip to content
BoxBilling

Redeem a coupon code

POST
/portal/coupons/redeem

Redeem a coupon code for the authenticated customer.

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
token
required
Token
string

Request Body required

Section titled “Request Body required ”
PortalRedeemCouponRequest

Request body for portal coupon code redemption.

object
coupon_code
required
Coupon Code
string
<= 255 characters

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Successful Response

PortalAppliedCouponResponse

Response for a portal-applied coupon with user-friendly details.

object
id
required
Id
string format: uuid
coupon_code
required
Coupon Code
string
coupon_name
required
Coupon Name
string
coupon_type
required
Coupon Type
string
amount_cents
Any of:
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
amount_currency
Any of:
string
percentage_rate
Any of:
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
frequency
required
Frequency
string
frequency_duration
Any of:
integer
frequency_duration_remaining
Any of:
integer
status
required
Status
string
created_at
required
Created At
string format: date-time

400

Section titled “400 ”

Coupon is not active, expired, or already applied

401

Section titled “401 ”

Invalid or expired portal token

404

Section titled “404 ”

Coupon not found

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object