Info: This ns is auto-generated from the Stripe OpenAPI spec.
Info: This ns is auto-generated from the Stripe OpenAPI spec.
(create {:keys [body]})Create a quote
HTTP Method: POST Endpoint: /v1/quotes
Example Usage: (create {})
Create a quote
HTTP Method: POST
Endpoint: /v1/quotes
Example Usage:
(create {})(list-all {:keys [query-params]})List all quotes
HTTP Method: GET Endpoint: /v1/quotes
Query Parameters:
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 {:query-params {:limit 10}})
List all quotes
HTTP Method: GET
Endpoint: /v1/quotes
Query Parameters:
- customer (String): The ID of the customer whose quotes you're retrieving.
- customer-account (String): The ID of the account representing the customer whose quotes you're retrieving.
- 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.
- status (String): The status of the quote.
- test-clock (String): Provides a list of quotes that are associated with the specified test clock. The response will not include quotes with test clocks if this and the customer parameter is not set.
Example Usage:
(list-all {:query-params {:limit 10}})(list-all-quote-computed-upfront-line-items {:keys [quote-id query-params]})Retrieve a quote's upfront line items
HTTP Method: GET Endpoint: /v1/quotes/{quote-id}/computed_upfront_line_items
Path Parameters:
Query Parameters:
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-quote-computed-upfront-line-items {:quote-id example-quote-id :query-params {:limit 10}})
Retrieve a quote's upfront line items
HTTP Method: GET
Endpoint: /v1/quotes/{quote-id}/computed_upfront_line_items
Path Parameters:
- quote-id (String): The quote-id parameter. (required)
Query Parameters:
- 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-quote-computed-upfront-line-items {:quote-id example-quote-id :query-params {:limit 10}})(list-all-quote-line-items {:keys [quote-id query-params]})Retrieve a quote's line items
HTTP Method: GET Endpoint: /v1/quotes/{quote-id}/line_items
Path Parameters:
Query Parameters:
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-quote-line-items {:quote-id example-quote-id :query-params {:limit 10}})
Retrieve a quote's line items
HTTP Method: GET
Endpoint: /v1/quotes/{quote-id}/line_items
Path Parameters:
- quote-id (String): The quote-id parameter. (required)
Query Parameters:
- 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-quote-line-items {:quote-id example-quote-id :query-params {:limit 10}})(list-all-quote-pdf {:keys [quote-id query-params]})Download quote PDF
HTTP Method: GET Endpoint: /v1/quotes/{quote-id}/pdf
Path Parameters:
Query Parameters:
Example Usage: (list-all-quote-pdf {:quote-id example-quote-id :query-params {:limit 10}})
Download quote PDF
HTTP Method: GET
Endpoint: /v1/quotes/{quote-id}/pdf
Path Parameters:
- quote-id (String): The quote-id parameter. (required)
Query Parameters:
- expand (Array): Specifies which fields in the response should be expanded.
Example Usage:
(list-all-quote-pdf {:quote-id example-quote-id :query-params {:limit 10}})(post-quote-accept {:keys [quote-id body]})Accept a quote
HTTP Method: POST Endpoint: /v1/quotes/{quote-id}/accept
Path Parameters:
Example Usage: (post-quote-accept {:quote-id example-quote-id})
Accept a quote
HTTP Method: POST
Endpoint: /v1/quotes/{quote-id}/accept
Path Parameters:
- quote-id (String): The quote-id parameter. (required)
Example Usage:
(post-quote-accept {:quote-id example-quote-id})(post-quote-cancel {:keys [quote-id body]})Cancel a quote
HTTP Method: POST Endpoint: /v1/quotes/{quote-id}/cancel
Path Parameters:
Example Usage: (post-quote-cancel {:quote-id example-quote-id})
Cancel a quote
HTTP Method: POST
Endpoint: /v1/quotes/{quote-id}/cancel
Path Parameters:
- quote-id (String): The quote-id parameter. (required)
Example Usage:
(post-quote-cancel {:quote-id example-quote-id})(post-quote-finalize {:keys [quote-id body]})Finalize a quote
HTTP Method: POST Endpoint: /v1/quotes/{quote-id}/finalize
Path Parameters:
Example Usage: (post-quote-finalize {:quote-id example-quote-id})
Finalize a quote
HTTP Method: POST
Endpoint: /v1/quotes/{quote-id}/finalize
Path Parameters:
- quote-id (String): The quote-id parameter. (required)
Example Usage:
(post-quote-finalize {:quote-id example-quote-id})(retrieve-quote {:keys [quote-id query-params]})Retrieve a quote
HTTP Method: GET Endpoint: /v1/quotes/{quote-id}
Path Parameters:
Query Parameters:
Example Usage: (retrieve-quote {:quote-id example-quote-id :query-params {:limit 10}})
Retrieve a quote
HTTP Method: GET
Endpoint: /v1/quotes/{quote-id}
Path Parameters:
- quote-id (String): The quote-id parameter. (required)
Query Parameters:
- expand (Array): Specifies which fields in the response should be expanded.
Example Usage:
(retrieve-quote {:quote-id example-quote-id :query-params {:limit 10}})(update-quote {:keys [quote-id body]})Update a quote
HTTP Method: POST Endpoint: /v1/quotes/{quote-id}
Path Parameters:
Example Usage: (update-quote {:quote-id example-quote-id})
Update a quote
HTTP Method: POST
Endpoint: /v1/quotes/{quote-id}
Path Parameters:
- quote-id (String): The quote-id parameter. (required)
Example Usage:
(update-quote {:quote-id example-quote-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 |