stream.clojure.stripe.api.invoices — stream.clojure/stripe-clojure 1.0.0-beta.1

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

create clj

(create {:keys [body]})

Create an invoice

HTTP Method: POST Endpoint: /v1/invoices

Example Usage: (create {})

create-create-preview clj

(create-create-preview {:keys [body]})

Create a preview invoice

HTTP Method: POST Endpoint: /v1/invoices/create_preview

Example Usage: (create-create-preview {})

delete-invoice clj

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

Delete a draft invoice

HTTP Method: DELETE Endpoint: /v1/invoices/{invoice-id}

Path Parameters:

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

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

list-all clj

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

List all invoices

HTTP Method: GET Endpoint: /v1/invoices

Query Parameters:

• collection-method (String): The collection method of the invoice to retrieve. Either charge_automatically or send_invoice.
• created (Unknown): Only return invoices that were created during the given date interval.
• customer (String): Only return invoices for the customer specified by this customer ID.
• customer-account (String): Only return invoices for the account representing the customer specified by this account ID.
• due-date (Unknown): The due-date parameter.
• 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 invoice, one of draft, open, paid, uncollectible, or void. Learn more
• subscription (String): Only return invoices for the subscription specified by this subscription ID.

Example Usage: (list-all {:query-params {:limit 10}})

list-all-invoice-lines clj

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

Retrieve an invoice's line items

HTTP Method: GET Endpoint: /v1/invoices/{invoice-id}/lines

Path Parameters:

• invoice-id (String): The invoice-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-invoice-lines {:invoice-id example-invoice-id :query-params {:limit 10}})

list-all-search clj

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

Search invoices

HTTP Method: GET Endpoint: /v1/invoices/search

Query Parameters:

• 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.
• page (String): A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
• query (String): The search query string. See search query language and the list of supported query fields for invoices. (required)

Example Usage: (list-all-search {:query-params {:limit 10}})

post-invoice-add-lines clj

(post-invoice-add-lines {:keys [invoice-id body]})

Bulk add invoice line items

HTTP Method: POST Endpoint: /v1/invoices/{invoice-id}/add_lines

Path Parameters:

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

Example Usage: (post-invoice-add-lines {:invoice-id example-invoice-id})

post-invoice-attach-payment clj

(post-invoice-attach-payment {:keys [invoice-id body]})

Attach a payment to an Invoice

HTTP Method: POST Endpoint: /v1/invoices/{invoice-id}/attach_payment

Path Parameters:

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

Example Usage: (post-invoice-attach-payment {:invoice-id example-invoice-id})

post-invoice-finalize clj

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

Finalize an invoice

HTTP Method: POST Endpoint: /v1/invoices/{invoice-id}/finalize

Path Parameters:

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

Example Usage: (post-invoice-finalize {:invoice-id example-invoice-id})

post-invoice-mark-uncollectible clj

(post-invoice-mark-uncollectible {:keys [invoice-id body]})

Mark an invoice as uncollectible

HTTP Method: POST Endpoint: /v1/invoices/{invoice-id}/mark_uncollectible

Path Parameters:

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

Example Usage: (post-invoice-mark-uncollectible {:invoice-id example-invoice-id})

post-invoice-pay clj

(post-invoice-pay {:keys [invoice-id body]})

Pay an invoice

HTTP Method: POST Endpoint: /v1/invoices/{invoice-id}/pay

Path Parameters:

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

Example Usage: (post-invoice-pay {:invoice-id example-invoice-id})

post-invoice-remove-lines clj

(post-invoice-remove-lines {:keys [invoice-id body]})

Bulk remove invoice line items

HTTP Method: POST Endpoint: /v1/invoices/{invoice-id}/remove_lines

Path Parameters:

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

Example Usage: (post-invoice-remove-lines {:invoice-id example-invoice-id})

post-invoice-send clj

(post-invoice-send {:keys [invoice-id body]})

Send an invoice for manual payment

HTTP Method: POST Endpoint: /v1/invoices/{invoice-id}/send

Path Parameters:

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

Example Usage: (post-invoice-send {:invoice-id example-invoice-id})

post-invoice-update-lines clj

(post-invoice-update-lines {:keys [invoice-id body]})

Bulk update invoice line items

HTTP Method: POST Endpoint: /v1/invoices/{invoice-id}/update_lines

Path Parameters:

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

Example Usage: (post-invoice-update-lines {:invoice-id example-invoice-id})

post-invoice-void clj

(post-invoice-void {:keys [invoice-id body]})

Void an invoice

HTTP Method: POST Endpoint: /v1/invoices/{invoice-id}/void

Path Parameters:

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

Example Usage: (post-invoice-void {:invoice-id example-invoice-id})

retrieve-invoice clj

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

Retrieve an invoice

HTTP Method: GET Endpoint: /v1/invoices/{invoice-id}

Path Parameters:

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

Query Parameters:

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

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

update-invoice clj

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

Update an invoice

HTTP Method: POST Endpoint: /v1/invoices/{invoice-id}

Path Parameters:

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

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

update-invoice-lines-line-item-id clj

(update-invoice-lines-line-item-id {:keys [invoice-id line-id body]})

Update an invoice's line item

HTTP Method: POST Endpoint: /v1/invoices/{invoice-id}/lines/{line-id}

Path Parameters:

• invoice-id (String): Invoice ID of line item
• line-id (String): Invoice line item ID

Example Usage: (update-invoice-lines-line-item-id {:invoice-id example-invoice-id :line-id example-line-id})