Liking cljdoc? Tell your friends :D

stream.clojure.stripe.api.invoiceitems

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 an invoice item

HTTP Method: POST Endpoint: /v1/invoiceitems

Example Usage: (create {})

Create an invoice item

HTTP Method: POST
Endpoint: /v1/invoiceitems

Example Usage:
  (create {})
sourceraw docstring

delete-invoiceitemclj

(delete-invoiceitem {:keys [invoiceitem-id]})

Delete an invoice item

HTTP Method: DELETE Endpoint: /v1/invoiceitems/{invoiceitem-id}

Path Parameters:

  • invoiceitem-id (String): The invoiceitem-id parameter. (required)

Example Usage: (delete-invoiceitem {:invoiceitem-id example-invoiceitem-id})

Delete an invoice item

HTTP Method: DELETE
Endpoint: /v1/invoiceitems/{invoiceitem-id}

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

Example Usage:
  (delete-invoiceitem {:invoiceitem-id example-invoiceitem-id})
sourceraw docstring

list-allclj

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

List all invoice items

HTTP Method: GET Endpoint: /v1/invoiceitems

Query Parameters:

  • created (Unknown): Only return invoice items that were created during the given date interval.
  • customer (String): The identifier of the customer whose invoice items to return. If none is provided, returns all invoice items.
  • customer-account (String): The identifier of the account representing the customer whose invoice items to return. If none is provided, returns all invoice items.
  • 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.
  • invoice (String): Only return invoice items belonging to this invoice. If none is provided, all invoice items will be returned. If specifying an invoice, no customer identifier is needed.
  • limit (Integer): A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
  • pending (Boolean): Set to true to only show pending invoice items, which are not yet attached to any invoices. Set to false to only show invoice items already attached to invoices. If unspecified, no filter is applied.
  • 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 {:query-params {:limit 10}})

List all invoice items

HTTP Method: GET
Endpoint: /v1/invoiceitems

Query Parameters:
  - created (Unknown): Only return invoice items that were created during the given date interval.
  - customer (String): The identifier of the customer whose invoice items to return. If none is provided, returns all invoice items.
  - customer-account (String): The identifier of the account representing the customer whose invoice items to return. If none is provided, returns all invoice items.
  - 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.
  - invoice (String): Only return invoice items belonging to this invoice. If none is provided, all invoice items will be returned. If specifying an invoice, no customer identifier is needed.
  - limit (Integer): A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
  - pending (Boolean): Set to `true` to only show pending invoice items, which are not yet attached to any invoices. Set to `false` to only show invoice items already attached to invoices. If unspecified, no filter is applied.
  - 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 {:query-params {:limit 10}})
sourceraw docstring

retrieve-invoiceitemclj

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

Retrieve an invoice item

HTTP Method: GET Endpoint: /v1/invoiceitems/{invoiceitem-id}

Path Parameters:

  • invoiceitem-id (String): The invoiceitem-id parameter. (required)

Query Parameters:

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

Example Usage: (retrieve-invoiceitem {:invoiceitem-id example-invoiceitem-id :query-params {:limit 10}})

Retrieve an invoice item

HTTP Method: GET
Endpoint: /v1/invoiceitems/{invoiceitem-id}

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

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

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

update-invoiceitemclj

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

Update an invoice item

HTTP Method: POST Endpoint: /v1/invoiceitems/{invoiceitem-id}

Path Parameters:

  • invoiceitem-id (String): The invoiceitem-id parameter. (required)

Example Usage: (update-invoiceitem {:invoiceitem-id example-invoiceitem-id})

Update an invoice item

HTTP Method: POST
Endpoint: /v1/invoiceitems/{invoiceitem-id}

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

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