Attach Discount To Subscription

POST

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

POST

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

$ curl -X POST https://app.paymentkit.com/api/account_id/discounts/subscription/subscription_external_id \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "coupon_id": "cpn_9f8d7a6b5c4e3d2f1a0b"
> }'

1 {
2   "id": "dsc_1234567890abcdef",
3   "coupon_id": "cpn_9f8d7a6b5c4e3d2f1a0b",
4   "promotion_code_id": "prm_abcdef1234567890",
5   "attachment_level": "subscription",
6   "customer_id": "cus_9876543210fedcba",
7   "subscription_id": "sub_1122334455667788",
8   "invoice_id": "inv_556677889900aabb",
9   "invoice_item_id": "ii_9988776655443322",
10   "start_date": "2024-01-15T09:30:00Z",
11   "end_date": "2024-04-15T09:30:00Z",
12   "is_active": true,
13   "metadata": {},
14   "created_at": "2024-01-15T09:30:00Z",
15   "updated_at": "2024-01-15T09:30:00Z"
16 }

Attach a discount to a subscription.

This will remove any existing subscription-level discount before attaching the new one.

Authentication

AuthorizationBearer

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

Path parameters

subscription_external_idstringRequired

account_idstringRequired

Request

This endpoint expects an object.

coupon_idstringRequired

ID of the coupon to apply

promotion_codestring or nullOptional

Optional promotion code used to apply this coupon

start_datedatetime or nullOptional

When the discount becomes active (defaults to now)

end_datedatetime or nullOptional

When the discount expires (based on coupon duration if not set)

metadatamap from strings to any or nullOptional

Arbitrary metadata

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