Developer docs
/
Rebilly API
/
Coupons
/
Retrieve coupon redemptions

Retrieve coupon redemptions

Retrieves a list of coupon redemptions.

SecurityAPI Key: SecretApiKey or HTTP: JWT
Request
query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer [ 0 .. 1000 ]

Specifies the starting point within the collection of items to be returned.

filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

q
string

Use this field to perform a partial search of text fields.

sort
Array of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -. Multiple fields can be sorted by separating each with ,.

get
/coupons-redemptions
Request samples
$couponRedemptions = $client->couponsRedemptions()->search([
    'filter' => 'customerId:testCustomer',
]);
Responses

200

List of coupon redemptions retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
Array
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.

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

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

}
]