POST /v1/promotion_codes/{promotion_code}
Updates the specified promotion code by setting the values of the parameters passed. Most fields are, by design, not editable.
Servers
- https://api.stripe.com/
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
promotion_code |
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 |
|---|---|---|---|
restrictions |
Object | No |
Settings that restrict the redemption of the promotion code. |
restrictions.currency_options |
Object | No | |
restrictions.currency_options.name |
Object | No | |
restrictions.currency_options.name.minimum_amount |
Integer | No | |
active |
Boolean | No |
Whether the promotion code is currently active. A promotion code can only be reactivated when the coupon is still valid and the promotion code is otherwise redeemable. |
expand[] |
Array | No |
Specifies which fields in the response should be expanded. |
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.