List all promotion codes
GET {{baseUrl}}/v1/promotion_codes
Returns a list of your promotion codes.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
active | string | Filter promotion codes by whether they are active. | |
code | string | Only return promotion codes that have this case-insensitive code. | |
coupon | string | Only return promotion codes for this coupon. | |
created[gt] | string | 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. | |
created[gte] | string | 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. | |
created[lt] | string | 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. | |
created[lte] | string | 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 | string | Only return promotion codes that are restricted to this customer. | |
ending_before | string | 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. | |
expand[0] | string | Specifies which fields in the response should be expanded. | |
expand[1] | string | Specifies which fields in the response should be expanded. | |
limit | string | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. | |
starting_after | string | 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. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string |