Redeem a coupon

Redeem a coupon.

SecuritySecretApiKey or JWT
Request
Request Body schema: application/json

Redeem a coupon.

couponId
string <= 50 characters

Coupon's ID.

customerId
string (CustomerId) <= 50 characters

The customer resource ID. Defaults to UUID v4.

Array of objects (RedemptionRestriction)

Additional restrictions for coupon's redemptions.

Array
type
required
string

Coupon's restriction type.

quantity
required
integer

Restriction quantity.

Responses
201

Coupon was redeemed.

Response Headers
Location
string <uri>

The location of the related resource.

Example: "https://api.rebilly.com/example"
Response Schema: application/json
id
string <= 50 characters

The resource ID. Defaults to UUID v4.

couponId
string <= 50 characters

Coupon's ID.

customerId
string (CustomerId) <= 50 characters

The customer resource ID. Defaults to UUID v4.

Array of objects (RedemptionRestriction)

Additional restrictions for coupon's redemptions.

Array
type
required
string

Coupon's restriction type.

quantity
required
integer

Restriction quantity.

createdTime
string <date-time>

Coupon redeem time.

canceledTime
string <date-time>

Coupon redemption canceled time.

Array of objects (Self) non-empty

The links related to resource.

Array (non-empty)
href
required
string

The link URL.

rel
required
string

The link type.

Value: "self"
401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

422

Invalid data was sent.

post/coupons-redemptions
Request samples
application/json
{
  • "couponId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "additionalRestrictions": [
    ]
}
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "couponId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "additionalRestrictions": [
    ],
  • "createdTime": "2019-08-24T14:15:22Z",
  • "canceledTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}