Get Active Customer Discount

GET

/api/:account_id/discounts/customer/:customer_external_id/active

GET

/api/:account_id/discounts/customer/:customer_external_id/active

$ curl https://app.paymentkit.com/api/account_id/discounts/customer/customer_external_id/active \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

1 {
2   "id": "d4f8a9b2-3c7e-4f1a-9b2d-5e8f7a1c2b3d",
3   "coupon_id": "SUMMER2024",
4   "promotion_code_id": "PROMO12345",
5   "attachment_level": "customer",
6   "customer_id": "cust_987654321",
7   "subscription_id": null,
8   "invoice_id": null,
9   "invoice_item_id": null,
10   "start_date": "2024-04-01T00:00:00Z",
11   "end_date": "2024-06-30T23:59:59Z",
12   "is_active": true,
13   "metadata": {
14     "source": "email_campaign",
15     "discount_type": "percentage",
16     "percentage_off": 15
17   },
18   "created_at": "2024-03-25T12:00:00Z",
19   "updated_at": "2024-04-01T00:00:00Z"
20 }

Get the currently active customer-level discount.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

customer_external_idstringRequired

account_idstringRequired

Response

Successful Response

idstring

coupon_idstring

promotion_code_idstring or null

attachment_levelstring

customer_idstring or null

subscription_idstring or null

invoice_idstring or null

invoice_item_idstring or null

start_datedatetime

end_datedatetime or null

is_activeboolean

metadatamap from strings to any or null

created_atdatetime

updated_atdatetime

Errors

422

Unprocessable Entity Error