Liking cljdoc? Tell your friends :D

stream.clojure.stripe.api.setup-intents

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

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

create-setup-intentsclj

(create-setup-intents {:keys [body]})

Create a SetupIntent

HTTP Method: POST Endpoint: /v1/setup_intents

Example Usage: (create-setup-intents {})

Create a SetupIntent

HTTP Method: POST
Endpoint: /v1/setup_intents

Example Usage:
  (create-setup-intents {})
sourceraw docstring

list-all-setup-intentsclj

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

List all SetupIntents

HTTP Method: GET Endpoint: /v1/setup_intents

Query Parameters: - attach-to-self (Boolean): If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.

It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer. - 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 SetupIntents for the customer specified by this customer ID. - customer-account (String): Only return SetupIntents for the account specified by this customer ID. - 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. - payment-method (String): Only return SetupIntents that associate with the specified payment method. - 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-setup-intents {:query-params {:limit 10}})

List all SetupIntents

  HTTP Method: GET
  Endpoint: /v1/setup_intents

  Query Parameters:
    - attach-to-self (Boolean): If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.

It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.
    - 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 SetupIntents for the customer specified by this customer ID.
    - customer-account (String): Only return SetupIntents for the account specified by this customer ID.
    - 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.
    - payment-method (String): Only return SetupIntents that associate with the specified payment method.
    - 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-setup-intents {:query-params {:limit 10}})
sourceraw docstring

post-setup-intents-intent-cancelclj

(post-setup-intents-intent-cancel {:keys [setup-intent-id body]})

Cancel a SetupIntent

HTTP Method: POST Endpoint: /v1/setup_intents/{setup-intent-id}/cancel

Path Parameters:

  • setup-intent-id (String): The setup-intent-id parameter. (required)

Example Usage: (post-setup-intents-intent-cancel {:setup-intent-id example-setup-intent-id})

Cancel a SetupIntent

HTTP Method: POST
Endpoint: /v1/setup_intents/{setup-intent-id}/cancel

Path Parameters:
  - setup-intent-id (String): The setup-intent-id parameter. (required)

Example Usage:
  (post-setup-intents-intent-cancel {:setup-intent-id example-setup-intent-id})
sourceraw docstring

post-setup-intents-intent-confirmclj

(post-setup-intents-intent-confirm {:keys [setup-intent-id body]})

Confirm a SetupIntent

HTTP Method: POST Endpoint: /v1/setup_intents/{setup-intent-id}/confirm

Path Parameters:

  • setup-intent-id (String): The setup-intent-id parameter. (required)

Example Usage: (post-setup-intents-intent-confirm {:setup-intent-id example-setup-intent-id})

Confirm a SetupIntent

HTTP Method: POST
Endpoint: /v1/setup_intents/{setup-intent-id}/confirm

Path Parameters:
  - setup-intent-id (String): The setup-intent-id parameter. (required)

Example Usage:
  (post-setup-intents-intent-confirm {:setup-intent-id example-setup-intent-id})
sourceraw docstring

post-setup-intents-intent-verify-microdepositsclj

(post-setup-intents-intent-verify-microdeposits {:keys [setup-intent-id body]})

Verify microdeposits on a SetupIntent

HTTP Method: POST Endpoint: /v1/setup_intents/{setup-intent-id}/verify_microdeposits

Path Parameters:

  • setup-intent-id (String): The setup-intent-id parameter. (required)

Example Usage: (post-setup-intents-intent-verify-microdeposits {:setup-intent-id example-setup-intent-id})

Verify microdeposits on a SetupIntent

HTTP Method: POST
Endpoint: /v1/setup_intents/{setup-intent-id}/verify_microdeposits

Path Parameters:
  - setup-intent-id (String): The setup-intent-id parameter. (required)

Example Usage:
  (post-setup-intents-intent-verify-microdeposits {:setup-intent-id example-setup-intent-id})
sourceraw docstring

retrieve-setup-intents-intentclj

(retrieve-setup-intents-intent {:keys [setup-intent-id query-params]})

Retrieve a SetupIntent

HTTP Method: GET Endpoint: /v1/setup_intents/{setup-intent-id}

Path Parameters:

  • setup-intent-id (String): The setup-intent-id parameter. (required)

Query Parameters:

  • client-secret (String): The client secret of the SetupIntent. We require this string if you use a publishable key to retrieve the SetupIntent.
  • expand (Array): Specifies which fields in the response should be expanded.

Example Usage: (retrieve-setup-intents-intent {:setup-intent-id example-setup-intent-id :query-params {:limit 10}})

Retrieve a SetupIntent

HTTP Method: GET
Endpoint: /v1/setup_intents/{setup-intent-id}

Path Parameters:
  - setup-intent-id (String): The setup-intent-id parameter. (required)

Query Parameters:
  - client-secret (String): The client secret of the SetupIntent. We require this string if you use a publishable key to retrieve the SetupIntent.
  - expand (Array): Specifies which fields in the response should be expanded.

Example Usage:
  (retrieve-setup-intents-intent {:setup-intent-id example-setup-intent-id :query-params {:limit 10}})
sourceraw docstring

update-setup-intents-intentclj

(update-setup-intents-intent {:keys [setup-intent-id body]})

Update a SetupIntent

HTTP Method: POST Endpoint: /v1/setup_intents/{setup-intent-id}

Path Parameters:

  • setup-intent-id (String): The setup-intent-id parameter. (required)

Example Usage: (update-setup-intents-intent {:setup-intent-id example-setup-intent-id})

Update a SetupIntent

HTTP Method: POST
Endpoint: /v1/setup_intents/{setup-intent-id}

Path Parameters:
  - setup-intent-id (String): The setup-intent-id parameter. (required)

Example Usage:
  (update-setup-intents-intent {:setup-intent-id example-setup-intent-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