Redeem a coupon

Redeems a coupon.

SecuritySecretApiKey or JWT
Request
Request Body schema: application/json

Coupon resource.

couponId
string <= 50 characters

ID of the coupon.

customerId
string (CustomerId) <= 50 characters

Customer resource ID.

Array of objects (RedemptionRestriction)

Additional coupon redemption restrictions.

Array
type
required
string

Coupon restriction type.

quantity
required
integer

Restriction quantity.

Responses
201

Coupon redeemed.

Response Headers
Location
string <uri>

Location of the related resource.

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

Unique resource ID. Defaults to UUID v4.

couponId
string <= 50 characters

ID of the coupon.

customerId
string (CustomerId) <= 50 characters

Customer resource ID.

Array of objects (RedemptionRestriction)

Additional coupon redemption restrictions.

Array
type
required
string

Coupon restriction type.

quantity
required
integer

Restriction quantity.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

canceledTime
string <date-time>

Date and time when the coupon is canceled.

Array of objects (SelfLink)

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

422

Invalid data sent.

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