Info: This ns is auto-generated from the Stripe OpenAPI spec.
Info: This ns is auto-generated from the Stripe OpenAPI spec.
(create-promotion-codes {:keys [body]})Create a promotion code
HTTP Method: POST Endpoint: /v1/promotion_codes
Example Usage: (create-promotion-codes {})
Create a promotion code
HTTP Method: POST
Endpoint: /v1/promotion_codes
Example Usage:
(create-promotion-codes {})(list-all-promotion-codes {:keys [query-params]})List all promotion codes
HTTP Method: GET Endpoint: /v1/promotion_codes
Query Parameters:
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.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.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.Example Usage: (list-all-promotion-codes {:query-params {:limit 10}})
List all promotion codes
HTTP Method: GET
Endpoint: /v1/promotion_codes
Query Parameters:
- active (Boolean): 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 (Unknown): 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.
- customer-account (String): Only return promotion codes that are restricted to this account representing the 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 (Array): Specifies which fields in the response should be expanded.
- limit (Integer): 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.
Example Usage:
(list-all-promotion-codes {:query-params {:limit 10}})(retrieve-promotion-codes-promotion-code {:keys [promotion-code-id
query-params]})Retrieve a promotion code
HTTP Method: GET Endpoint: /v1/promotion_codes/{promotion-code-id}
Path Parameters:
Query Parameters:
Example Usage: (retrieve-promotion-codes-promotion-code {:promotion-code-id example-promotion-code-id :query-params {:limit 10}})
Retrieve a promotion code
HTTP Method: GET
Endpoint: /v1/promotion_codes/{promotion-code-id}
Path Parameters:
- promotion-code-id (String): The promotion-code-id parameter. (required)
Query Parameters:
- expand (Array): Specifies which fields in the response should be expanded.
Example Usage:
(retrieve-promotion-codes-promotion-code {:promotion-code-id example-promotion-code-id :query-params {:limit 10}})(update-promotion-codes-promotion-code {:keys [promotion-code-id body]})Update a promotion code
HTTP Method: POST Endpoint: /v1/promotion_codes/{promotion-code-id}
Path Parameters:
Example Usage: (update-promotion-codes-promotion-code {:promotion-code-id example-promotion-code-id})
Update a promotion code
HTTP Method: POST
Endpoint: /v1/promotion_codes/{promotion-code-id}
Path Parameters:
- promotion-code-id (String): The promotion-code-id parameter. (required)
Example Usage:
(update-promotion-codes-promotion-code {:promotion-code-id example-promotion-code-id})cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |