Archive Coupon
Archives a coupon, making it unavailable for future use while remaining active on existing subscriptions.
Archiving makes that Coupon unavailable for future use, but allows it to remain attached and functional on existing Subscriptions that are using it.
The archived_at date and time will be assigned.
Authorization
BasicAuth The username is a Maxio Chargify API key. The password is x.
In: header
Path Parameters
The Advanced Billing id of the product family to which the coupon belongs
The Advanced Billing id of the coupon
Response Body
application/json
curl -X DELETE "https://example.com/product_families/0/coupons/0.json"{ "coupon": { "id": 67, "name": "Foo Bar", "code": "YEPPER99934", "description": "my cool coupon", "amount_in_cents": 10000, "product_family_id": 4, "created_at": "2017-11-08T10:01:15-05:00", "updated_at": "2017-11-08T10:01:15-05:00", "start_date": "2017-11-08T10:01:15-05:00", "end_date": null, "percentage": null, "recurring": false, "duration_period_count": null, "duration_interval": null, "duration_interval_unit": null, "allow_negative_balance": false, "archived_at": "2016-12-02T13:09:33-05:00", "conversion_limit": null, "stackable": true, "compounding_strategy": "compound" }}Read Coupon GET
Returns a coupon by its system-assigned ID. You must identify the Coupon in this call by the ID parameter assigned to it. If instead you would like to find a Coupon using a Coupon code, use the [Find Coupon](https://maxio-test-wp.pages.dev/api/openapi/coupons/findCoupon) endpoint. If the coupon is set to `use_site_exchange_rate: true`, it returns pricing based on the current exchange rate. If the flag is set to false, it returns all of the defined prices for each currency.
Update Coupon PUT
Updates 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 }`