List Subscription Discounts

GET

/api/:account_id/discounts/subscription/:subscription_external_id/list

GET

/api/:account_id/discounts/subscription/:subscription_external_id/list

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

1 [
2   {
3     "id": "d4f8a9b2-3c7e-4f1a-9b6d-2a7e5f8c9d12",
4     "coupon_id": "SUMMER2024",
5     "promotion_code_id": "PROMO12345",
6     "attachment_level": "subscription",
7     "customer_id": "cust_987654321",
8     "subscription_id": "sub_123456789",
9     "invoice_id": "inv_20240601_001",
10     "invoice_item_id": "item_20240601_001",
11     "start_date": "2024-06-01T00:00:00Z",
12     "end_date": "2024-12-31T23:59:59Z",
13     "is_active": true,
14     "metadata": {
15       "source": "email_campaign",
16       "discount_type": "percentage",
17       "percentage_off": 15
18     },
19     "created_at": "2024-05-15T12:00:00Z",
20     "updated_at": "2024-05-20T08:30:00Z"
21   }
22 ]

List active discounts for a subscription.

Authentication

AuthorizationBearer

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

Path parameters

subscription_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