Subscription Coupons

Here, we're referring to subscription coupon endpoints.

About subscription coupons

Subscription coupons are coupons that apply on a subscription's next renewal, or a cancelled or expired subscription's reactivation. They can be added or even removed from a subscription, because they haven't yet been applied to an order.

Note: This means they're unlike standard coupons because standard coupons have already been applied to an order (e.g. a coupon a subscriber adds to their cart while checking out), so they cannot be added or removed after the fact.

Coupons have a 1-to-many mapping to subscription coupons. Coupon ID maps to a particular coupon within a Cratejoy store, while subscription coupon IDs map to a particular coupon plus subscription. Example: a coupon code "10OFF" has a unique ID. If that code "10OFF" is applied to 3 different subscriptions, then there will be three distinct subscription_coupon IDs.

For more on how coupons generally work in Cratejoy, please refer to this help center article. For more on applying coupons to subscriptions, please refer to this help center article, Add a Coupon to an Existing Subscription.

Subscription coupon data


Field	Type	Description
`code_used`	`STRING`	The coupon code. Note that for subscription coupons, you can only apply the coupon's primary code (not additional codes, found underneath "manage additional codes" in the Cratejoy interface).
`coupon_id`	`INT`	Unique identifier for the coupon. You can find this in the Cratejoy interface for existing coupons in the coupon's URL: my.cratejoy.com/coupon/
`enabled`	`BOOLEAN`	Whether the coupon has been enabled or not.
`id`	`INT`	Unique identifier for the `subscription_coupon`
`num_renewals`	`INT`	The number of renewals that have occurred with this coupon applied.
`type`	`STRING`	Always `subscription_coupon`