Liking cljdoc? Tell your friends :D

stream.clojure.stripe.api.linked-accounts

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

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

list-all-linked-accountsclj

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

List Accounts

HTTP Method: GET Endpoint: /v1/linked_accounts

Query Parameters:

  • account-holder (Object): If present, only return accounts that belong to the specified account holder. account_holder[customer] and account_holder[account] are mutually exclusive.
  • 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.
  • session (String): If present, only return accounts that were collected as part of the given session.
  • 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-linked-accounts {:query-params {:limit 10}})

List Accounts

HTTP Method: GET
Endpoint: /v1/linked_accounts

Query Parameters:
  - account-holder (Object): If present, only return accounts that belong to the specified account holder. `account_holder[customer]` and `account_holder[account]` are mutually exclusive.
  - 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.
  - session (String): If present, only return accounts that were collected as part of the given session.
  - 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-linked-accounts {:query-params {:limit 10}})
sourceraw docstring

list-all-linked-accounts-account-ownersclj

(list-all-linked-accounts-account-owners {:keys [linked-account-id
                                                 query-params]})

List Account Owners

HTTP Method: GET Endpoint: /v1/linked_accounts/{linked-account-id}/owners

Path Parameters:

  • linked-account-id (String): The linked-account-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.
  • ownership (String): The ID of the ownership object to fetch owners from. (required)
  • 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-linked-accounts-account-owners {:linked-account-id example-linked-account-id :query-params {:limit 10}})

List Account Owners

HTTP Method: GET
Endpoint: /v1/linked_accounts/{linked-account-id}/owners

Path Parameters:
  - linked-account-id (String): The linked-account-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.
  - ownership (String): The ID of the ownership object to fetch owners from. (required)
  - 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-linked-accounts-account-owners {:linked-account-id example-linked-account-id :query-params {:limit 10}})
sourceraw docstring

post-linked-accounts-account-disconnectclj

(post-linked-accounts-account-disconnect {:keys [linked-account-id body]})

Disconnect an Account

HTTP Method: POST Endpoint: /v1/linked_accounts/{linked-account-id}/disconnect

Path Parameters:

  • linked-account-id (String): The linked-account-id parameter. (required)

Example Usage: (post-linked-accounts-account-disconnect {:linked-account-id example-linked-account-id})

Disconnect an Account

HTTP Method: POST
Endpoint: /v1/linked_accounts/{linked-account-id}/disconnect

Path Parameters:
  - linked-account-id (String): The linked-account-id parameter. (required)

Example Usage:
  (post-linked-accounts-account-disconnect {:linked-account-id example-linked-account-id})
sourceraw docstring

post-linked-accounts-account-refreshclj

(post-linked-accounts-account-refresh {:keys [linked-account-id body]})

Refresh Account data

HTTP Method: POST Endpoint: /v1/linked_accounts/{linked-account-id}/refresh

Path Parameters:

  • linked-account-id (String): The linked-account-id parameter. (required)

Example Usage: (post-linked-accounts-account-refresh {:linked-account-id example-linked-account-id})

Refresh Account data

HTTP Method: POST
Endpoint: /v1/linked_accounts/{linked-account-id}/refresh

Path Parameters:
  - linked-account-id (String): The linked-account-id parameter. (required)

Example Usage:
  (post-linked-accounts-account-refresh {:linked-account-id example-linked-account-id})
sourceraw docstring

retrieve-linked-accounts-accountclj

(retrieve-linked-accounts-account {:keys [linked-account-id query-params]})

Retrieve an Account

HTTP Method: GET Endpoint: /v1/linked_accounts/{linked-account-id}

Path Parameters:

  • linked-account-id (String): The linked-account-id parameter. (required)

Query Parameters:

  • expand (Array): Specifies which fields in the response should be expanded.

Example Usage: (retrieve-linked-accounts-account {:linked-account-id example-linked-account-id :query-params {:limit 10}})

Retrieve an Account

HTTP Method: GET
Endpoint: /v1/linked_accounts/{linked-account-id}

Path Parameters:
  - linked-account-id (String): The linked-account-id parameter. (required)

Query Parameters:
  - expand (Array): Specifies which fields in the response should be expanded.

Example Usage:
  (retrieve-linked-accounts-account {:linked-account-id example-linked-account-id :query-params {:limit 10}})
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