# Create a special coupon ``` PUT https://api.freemius.com/v1/products/{product_id}/coupons/{coupon_id}/special/{special_id}.json ``` #### Auth:Bearer TokenSCOPE: PRODUCT Product-scoped API tokens allow you to operate on the product itself. This token usually allows read-only access to the product configuration and write access to several operations on subscriptions, customers, payments, and more. For most SaaS or app integrations, this is the token you will need. 1. Go to the [Freemius Developer Dashboard](https://dashboard.freemius.com/). 2. Open the Settings page of the relevant product. 3. Click the API & Keys tab. 4. Copy the API Bearer Authorization Token from the UI. *** Create a special coupon. ## Request[​](#request "Direct link to request") ### Path Parameters * **product\_id** integer\[](#param-property-coupons-create-special-param-path-product-id "Direct link to product_id")required The ID of the product. **Possible values:** `>= 1` **Example: **`1234` **coupon\_id** integer\[](#param-property-coupons-create-special-param-path-coupon-id "Direct link to coupon_id")required The ID of the coupon. **Possible values:** `>= 1` **Example: **`1234` **special\_id** string[](#param-property-coupons-create-special-param-path-special-id "Direct link to special_id")required The ID of the special coupon. **Possible values:** \[`affiliate`, `cart_recovery`, `subscription_cancellation`, `exit_intent`, `renewals_discount`, `manual_renewals_discount`] **Example: **`cart_recovery` ## Responses[​](#responses "Direct link to Responses") * 201 * 400 * 401 * 402 * 404 The special coupon has been created. application/json **Schema** **id**string\[](#schema-property-coupons-create-special-response-schema-id-string-int64 "Direct link to id") The unique identifier of the entity. **Possible values:** `>= 1` **Example: **`123456` **created**string\[](#schema-property-coupons-create-special-response-schema-created-string-date-time "Direct link to created") The date and time the entity was created, under UTC timezone. **Example: **`2025-01-01 00:00:00` **updated**string\[](#schema-property-coupons-create-special-response-schema-updated-string-date-time "Direct link to updated")nullable The date and time the entity was updated, under UTC timezone. If `null` then the entity was never updated since its creation. **Example: **`2025-01-01 00:00:00` **coupon\_id**number[](#schema-property-coupons-create-special-response-schema-coupon-id-number "Direct link to coupon_id") The ID of the coupon. **Example: **`12345` **entity\_id**string\[](#schema-property-coupons-create-special-response-schema-entity-id-string-int64 "Direct link to entity_id") The ID of the entity. **Possible values:** `>= 1` **Example: **`12345` **entity\_type**integer[](#schema-property-coupons-create-special-response-schema-entity-type-integer "Direct link to entity_type") The type of the entity (Usually `2` which means it is a product or `20` which means it is an affiliate). **Example: **`2` **type**string[](#schema-property-coupons-create-special-response-schema-type-string "Direct link to type") The special coupon type. **Possible values:** \[`affiliate`, `renewals_discount`, `manual_renewals_discount`, `subscription_cancellation`, `cart_recovery`, `exit_intent`] **code**string[](#schema-property-coupons-create-special-response-schema-code-string "Direct link to code") The coupon code. **Example: **`BLACKFRIDAY2024` **redemptions**integer[](#schema-property-coupons-create-special-response-schema-redemptions-integer "Direct link to redemptions") The total number of redemptions of this coupon. **discount**integer[](#schema-property-coupons-create-special-response-schema-discount-integer "Direct link to discount") The discount amount. **discount\_type**string[](#schema-property-coupons-create-special-response-schema-discount-type-string "Direct link to discount_type") The type of the discount. "percentage" means the discount is a percentage of the price, "dollar" means the discount is a fixed amount. **Possible values:** \[`dollar`, `percentage`] **discounts** object The discount amount for each currency **property name\***number\[](#schema-property-coupons-create-special-response-schema-property-name-number-int "Direct link to property name*") **has\_renewals\_discount**boolean[](#schema-property-coupons-create-special-response-schema-has-renewals-discount-boolean "Direct link to has_renewals_discount") Whether the coupon also supports discount for renewals or first payment only. Bad request. The request could not be understood by the server due to malformed syntax or arguments. application/json **Schema** **path**string[](#schema-property-coupons-create-special-response-schema-path-string "Direct link to path") The API request path. **Example: **`:/products/product_id/users.json` **error** object This object contains the error details. **type**string[](#schema-property-coupons-create-special-response-schema-type-string "Direct link to type") The type of the error encountered by the server. **Example: **`UnauthorizedAccess` **message**string[](#schema-property-coupons-create-special-response-schema-message-string "Direct link to message") The descriptive error message. **Example: **`Some error has occured.` **code**string[](#schema-property-coupons-create-special-response-schema-code-string "Direct link to code") The error code. **Example: **`unauthorized_access` **http**integer[](#schema-property-coupons-create-special-response-schema-http-integer "Direct link to http") The HTTP status code returned by the server. **Example: **`401` **timestamp**string[](#schema-property-coupons-create-special-response-schema-timestamp-string "Direct link to timestamp") Current timestamp. **Example: **`Thu, 11 May 2023 11:45:30 +0000` **request** object This object sends back the request payload as received by the server (both from path and from body or query). **property name\***any[](#schema-property-coupons-create-special-response-schema-property-name-any "Direct link to property name*") This object sends back the request payload as received by the server (both from path and from body or query). **Example: **`{"beautify":true,"format":"json"}` Unauthorized access error. The request requires [authentication](https://freemius.com/help/api/#bearer-token-authentication) but was not provided or the provided authentication does not satisfy the required permissions. application/json **Schema** **path**string[](#schema-property-coupons-create-special-response-schema-path-string "Direct link to path") The API request path. **Example: **`:/products/product_id/users.json` **error** object This object contains the error details. **type**string[](#schema-property-coupons-create-special-response-schema-type-string "Direct link to type") The type of the error encountered by the server. **Example: **`UnauthorizedAccess` **message**string[](#schema-property-coupons-create-special-response-schema-message-string "Direct link to message") The descriptive error message. **Example: **`Some error has occured.` **code**string[](#schema-property-coupons-create-special-response-schema-code-string "Direct link to code") The error code. **Example: **`unauthorized_access` **http**integer[](#schema-property-coupons-create-special-response-schema-http-integer "Direct link to http") The HTTP status code returned by the server. **Example: **`401` **timestamp**string[](#schema-property-coupons-create-special-response-schema-timestamp-string "Direct link to timestamp") Current timestamp. **Example: **`Thu, 11 May 2023 11:45:30 +0000` **request** object This object sends back the request payload as received by the server (both from path and from body or query). **property name\***any[](#schema-property-coupons-create-special-response-schema-property-name-any "Direct link to property name*") This object sends back the request payload as received by the server (both from path and from body or query). **Example: **`{"beautify":true,"format":"json"}` The request is missing the specified argument. application/json **Schema** **path**string[](#schema-property-coupons-create-special-response-schema-path-string "Direct link to path") The API request path. **Example: **`:/products/product_id/users.json` **error** object This object contains the error details. **type**string[](#schema-property-coupons-create-special-response-schema-type-string "Direct link to type") The type of the error encountered by the server. **Example: **`UnauthorizedAccess` **message**string[](#schema-property-coupons-create-special-response-schema-message-string "Direct link to message") The descriptive error message. **Example: **`Some error has occured.` **code**string[](#schema-property-coupons-create-special-response-schema-code-string "Direct link to code") The error code. **Example: **`unauthorized_access` **http**integer[](#schema-property-coupons-create-special-response-schema-http-integer "Direct link to http") The HTTP status code returned by the server. **Example: **`401` **timestamp**string[](#schema-property-coupons-create-special-response-schema-timestamp-string "Direct link to timestamp") Current timestamp. **Example: **`Thu, 11 May 2023 11:45:30 +0000` **request** object This object sends back the request payload as received by the server (both from path and from body or query). **property name\***any[](#schema-property-coupons-create-special-response-schema-property-name-any "Direct link to property name*") This object sends back the request payload as received by the server (both from path and from body or query). **Example: **`{"beautify":true,"format":"json"}` The requested resource was not found. application/json **Schema** **path**string[](#schema-property-coupons-create-special-response-schema-path-string "Direct link to path") The API request path. **Example: **`:/products/product_id/users.json` **error** object This object contains the error details. **type**string[](#schema-property-coupons-create-special-response-schema-type-string "Direct link to type") The type of the error encountered by the server. **Example: **`UnauthorizedAccess` **message**string[](#schema-property-coupons-create-special-response-schema-message-string "Direct link to message") The descriptive error message. **Example: **`Some error has occured.` **code**string[](#schema-property-coupons-create-special-response-schema-code-string "Direct link to code") The error code. **Example: **`unauthorized_access` **http**integer[](#schema-property-coupons-create-special-response-schema-http-integer "Direct link to http") The HTTP status code returned by the server. **Example: **`401` **timestamp**string[](#schema-property-coupons-create-special-response-schema-timestamp-string "Direct link to timestamp") Current timestamp. **Example: **`Thu, 11 May 2023 11:45:30 +0000` **request** object This object sends back the request payload as received by the server (both from path and from body or query). **property name\***any[](#schema-property-coupons-create-special-response-schema-property-name-any "Direct link to property name*") This object sends back the request payload as received by the server (both from path and from body or query). **Example: **`{"beautify":true,"format":"json"}`