POST /v1/coupons/{coupon}
Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.
Servers
- https://api.stripe.com/
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
coupon |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/x-www-form-urlencoded" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
name |
String | No |
Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the |
expand[] |
Array | No |
Specifies which fields in the response should be expanded. |
currency_options |
Object | No |
Coupons defined in each available currency option (only supported if the coupon is amount-based). Each key must be a three-letter ISO currency code and a supported currency. |
currency_options.name |
Object | No | |
currency_options.name.amount_off |
Integer | Yes | |
metadata |
No |
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.