Update Coupon
Built with APIMatic
Advanced Billing Developer Portalv1.0Advanced Billing Developer Portalv1.0Updates a coupon.
You can restrict a coupon to only apply to specific products / components by optionally passing in hashes of restricted_products and/or restricted_components in the format:
{ "<product/component_id>": boolean_value }
The username is a Maxio Chargify API key and the password is x. Basic authentication works only with the US and EU environments, which connect to chargify.com directly. The Maxio API Gateway environment does not accept Basic authentication.
In: header
The Advanced Billing id of the product family to which the coupon belongs
The Advanced Billing id of the coupon
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
curl -X PUT \ --url 'https://subdomain.chargify.com/product_families/1/coupons/1.json' \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ACCESS_TOKEN' \ --data-raw '{ "coupon": { "name": "15% off", "code": "15OFF", "description": "15% off for life", "percentage": 15, "allow_negative_balance": false, "recurring": false, "end_date": "2012-08-29", "product_family_id": "2", "stackable": true, "compounding_strategy": "compound" }, "restricted_products": { "1": true }, "restricted_components": { "1": true, "2": false }}'An object where the keys are product IDs or handles (prefixed with 'handle:'), and the values are booleans indicating if the coupon should be applicable to the product.
An object where the keys are component IDs or handles (prefixed with 'handle:'), and the values are booleans indicating if the coupon should be applicable to the component.