Liking cljdoc? Tell your friends :D

stream.clojure.stripe.api.quotes

Info: This ns is auto-generated from the Stripe OpenAPI spec.

Info: This ns is auto-generated from the Stripe OpenAPI spec.
raw docstring

createclj

(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 {})
sourceraw docstring

list-allclj

(list-all {:keys [query-params]})

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 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}})
sourceraw docstring

list-all-quote-computed-upfront-line-itemsclj

(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:

  • 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}})

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}})
sourceraw docstring

list-all-quote-line-itemsclj

(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:

  • 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}})

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}})
sourceraw docstring

list-all-quote-pdfclj

(list-all-quote-pdf {:keys [quote-id query-params]})

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}})

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}})
sourceraw docstring

post-quote-acceptclj

(post-quote-accept {:keys [quote-id body]})

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})

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})
sourceraw docstring

post-quote-cancelclj

(post-quote-cancel {:keys [quote-id body]})

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})

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})
sourceraw docstring

post-quote-finalizeclj

(post-quote-finalize {:keys [quote-id body]})

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})

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})
sourceraw docstring

retrieve-quoteclj

(retrieve-quote {:keys [quote-id query-params]})

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}})

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}})
sourceraw docstring

update-quoteclj

(update-quote {:keys [quote-id body]})

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})

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})
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close