provider GET /v1/promotion_codes
@utdk/stripe /v1/promotion_codes
List all promotion codes
<p>Returns a list of your promotion codes.</p>
active query
Filter promotion codes by whether they are active.
boolean
code query
Only return promotion codes that have this case-insensitive code.
string
coupon query
Only return promotion codes for this coupon.
string
created query
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.
customer query
Only return promotion codes that are restricted to this customer.
string
customer_account query
Only return promotion codes that are restricted to this account representing the customer.
string
ending_before query
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.
string
expand query
Specifies which fields in the response should be expanded.
array
limit query
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
integer
starting_after query
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.
string

Try it

Authentication
Configure credentials for Stripe API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

getpromotioncodes
GET/v1/promotion_codes
<p>Returns a list of your promotion codes.</p>

Filter promotion codes by whether they are active.

Only return promotion codes that have this case-insensitive code.

Only return promotion codes for this coupon.

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.

Only return promotion codes that are restricted to this customer.

Only return promotion codes that are restricted to this account representing the customer.

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.

Specifies which fields in the response should be expanded.

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

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.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import stripe from '@utdk/stripe';

await stripe.getpromotioncodes()