Developer docs
/
Rebilly API
/
Coupons
/
Retrieve a coupon redemption

Retrieve a coupon redemption

Retrieves a coupon redemption with a specified ID.

SecurityAPI Key: SecretApiKey or HTTP: JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

ID of the resource.

get
/coupons-redemptions/{id}
Request samples
$couponRedemption = $client->couponsRedemptions()->load('redemptionId');
Responses

200

Coupon redemption retrieved.

Response Schema: application/json
id
string <= 50 characters

Unique resource ID.

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.

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 or null <date-time>

Date and time when the coupon is canceled.

Array of objects

Related links.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

Response samples
application/json
{
"id": "cpn_rdm_0YVCNKF81GD778N4YNVGDJK558",
"couponId": "cpn_0YVCNKF81GD778N4YNVGDJK558",
"customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF",
"additionalRestrictions": [

],
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z",
"canceledTime": "2019-08-24T14:15:22Z",
"_links": [

]
}