stream.clojure.stripe.api.credit-notes — stream.clojure/stripe-clojure 1.0.0-beta.1

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

create-credit-notes clj

(create-credit-notes {:keys [body]})

Create a credit note

HTTP Method: POST Endpoint: /v1/credit_notes

Example Usage: (create-credit-notes {})

list-all-credit-notes clj

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

List all credit notes

HTTP Method: GET Endpoint: /v1/credit_notes

Query Parameters:

• created (Unknown): Only return credit notes that were created during the given date interval.
• customer (String): Only return credit notes for the customer specified by this customer ID.
• customer-account (String): Only return credit notes for the account representing the customer specified by this account 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.
• invoice (String): Only return credit notes for the invoice specified by this invoice ID.
• 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-credit-notes {:query-params {:limit 10}})

list-all-credit-notes-credit-note-lines clj

(list-all-credit-notes-credit-note-lines {:keys [credit-note-id query-params]})

Retrieve a credit note's line items

HTTP Method: GET Endpoint: /v1/credit_notes/{credit-note-id}/lines

Path Parameters:

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

list-all-credit-notes-preview clj

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

Preview a credit note

HTTP Method: GET Endpoint: /v1/credit_notes/preview

Query Parameters:

• amount (Integer): The integer amount in cents (or local equivalent) representing the total amount of the credit note. One of amount, lines, or shipping_cost must be provided.
• credit-amount (Integer): The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
• effective-at (Integer): The date when this credit note is in effect. Same as created unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
• email-type (String): Type of email to send to the customer, one of credit_note or none and the default is credit_note.
• expand (Array): Specifies which fields in the response should be expanded.
• invoice (String): ID of the invoice. (required)
• lines (Array): Line items that make up the credit note. One of amount, lines, or shipping_cost must be provided.
• memo (String): The credit note's memo appears on the credit note PDF.
• metadata (Object): Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
• out-of-band-amount (Integer): The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.
• reason (String): Reason for issuing this credit note, one of duplicate, fraudulent, order_change, or product_unsatisfactory
• refund-amount (Integer): The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
• refunds (Array): Refunds to link to this credit note.
• shipping-cost (Object): When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. One of amount, lines, or shipping_cost must be provided.

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

list-all-credit-notes-preview-lines clj

(list-all-credit-notes-preview-lines {:keys [query-params]})

Retrieve a credit note preview's line items

HTTP Method: GET Endpoint: /v1/credit_notes/preview/lines

Query Parameters:

• amount (Integer): The integer amount in cents (or local equivalent) representing the total amount of the credit note. One of amount, lines, or shipping_cost must be provided.
• credit-amount (Integer): The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
• effective-at (Integer): The date when this credit note is in effect. Same as created unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
• email-type (String): Type of email to send to the customer, one of credit_note or none and the default is credit_note.
• 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): ID of the invoice. (required)
• limit (Integer): A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
• lines (Array): Line items that make up the credit note. One of amount, lines, or shipping_cost must be provided.
• memo (String): The credit note's memo appears on the credit note PDF.
• metadata (Object): Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
• out-of-band-amount (Integer): The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.
• reason (String): Reason for issuing this credit note, one of duplicate, fraudulent, order_change, or product_unsatisfactory
• refund-amount (Integer): The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
• refunds (Array): Refunds to link to this credit note.
• shipping-cost (Object): When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. One of amount, lines, or shipping_cost must be provided.
• 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-credit-notes-preview-lines {:query-params {:limit 10}})

post-credit-notes-id-void clj

(post-credit-notes-id-void {:keys [credit-note-id body]})

Void a credit note

HTTP Method: POST Endpoint: /v1/credit_notes/{credit-note-id}/void

Path Parameters:

• credit-note-id (String): The credit-note-id parameter. (required)

Example Usage: (post-credit-notes-id-void {:credit-note-id example-credit-note-id})

retrieve-credit-notes-id clj

(retrieve-credit-notes-id {:keys [credit-note-id query-params]})

Retrieve a credit note

HTTP Method: GET Endpoint: /v1/credit_notes/{credit-note-id}

Path Parameters:

• credit-note-id (String): The credit-note-id parameter. (required)

Query Parameters:

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

Example Usage: (retrieve-credit-notes-id {:credit-note-id example-credit-note-id :query-params {:limit 10}})

update-credit-notes-id clj

(update-credit-notes-id {:keys [credit-note-id body]})

Update a credit note

HTTP Method: POST Endpoint: /v1/credit_notes/{credit-note-id}

Path Parameters:

• credit-note-id (String): The credit-note-id parameter. (required)

Example Usage: (update-credit-notes-id {:credit-note-id example-credit-note-id})