Retrieve a coupon redemption

Retrieves a coupon redemption with a specified ID.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

ID of the resource.

Responses
200

Coupon redemption retrieved.

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

ID of the customer resource.

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.

404

Resource not found.

get/coupons-redemptions/{id}
Request samples
$couponRedemption = $client->couponsRedemptions()->load('redemptionId');
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": [
    ]
}