GET /v1/promotion_codes

Returns a list of your promotion codes.

Servers

https://api.stripe.com/

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/x-www-form-urlencoded"

Query parameters

Name	Type	Required	Description
`customer`	String	No	Only return promotion codes that are restricted to this customer.
`created`		No	A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
`limit`	Integer	No	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
`active`	Boolean	No	Filter promotion codes by whether they are active.
`starting_after`	String	No	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
`expand[]`	Array	No	Specifies which fields in the response should be expanded.
`coupon`	String	No	Only return promotion codes for this coupon.
`ending_before`	String	No	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
`code`	String	No	Only return promotion codes that have this case-insensitive code.

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.