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

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

create-alerts clj

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

Create a billing alert

HTTP Method: POST Endpoint: /v1/billing/alerts

Example Usage: (create-alerts {})

create-credit-grants clj

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

Create a credit grant

HTTP Method: POST Endpoint: /v1/billing/credit_grants

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

create-meter-event-adjustments clj

(create-meter-event-adjustments {:keys [body]})

Create a billing meter event adjustment

HTTP Method: POST Endpoint: /v1/billing/meter_event_adjustments

Example Usage: (create-meter-event-adjustments {})

create-meter-events clj

(create-meter-events {:keys [body]})

Create a billing meter event

HTTP Method: POST Endpoint: /v1/billing/meter_events

Example Usage: (create-meter-events {})

create-meters clj

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

Create a billing meter

HTTP Method: POST Endpoint: /v1/billing/meters

Example Usage: (create-meters {})

list-all-alerts clj

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

List billing alerts

HTTP Method: GET Endpoint: /v1/billing/alerts

Query Parameters:

• alert-type (String): Filter results to only include this type of alert.
• 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.
• meter (String): Filter results to only include alerts with the given meter.
• 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-alerts {:query-params {:limit 10}})

list-all-credit-balance-summary clj

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

Retrieve the credit balance summary for a customer

HTTP Method: GET Endpoint: /v1/billing/credit_balance_summary

Query Parameters:

• customer (String): The customer whose credit balance summary you're retrieving.
• customer-account (String): The account representing the customer whose credit balance summary you're retrieving.
• expand (Array): Specifies which fields in the response should be expanded.
• filter (Object): The filter criteria for the credit balance summary. (required)

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

list-all-credit-balance-transactions clj

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

List credit balance transactions

HTTP Method: GET Endpoint: /v1/billing/credit_balance_transactions

Query Parameters:

• credit-grant (String): The credit grant for which to fetch credit balance transactions.
• customer (String): The customer whose credit balance transactions you're retrieving.
• customer-account (String): The account representing the customer whose credit balance transactions you're retrieving.
• 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-balance-transactions {:query-params {:limit 10}})

list-all-credit-grants clj

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

List credit grants

HTTP Method: GET Endpoint: /v1/billing/credit_grants

Query Parameters:

• customer (String): Only return credit grants for this customer.
• customer-account (String): Only return credit grants for this account representing the customer.
• 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-grants {:query-params {:limit 10}})

list-all-meters clj

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

List billing meters

HTTP Method: GET Endpoint: /v1/billing/meters

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.
• status (String): Filter results to only include meters with the given status.

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

list-all-meters-id-event-summaries clj

(list-all-meters-id-event-summaries {:keys [meter-id query-params]})

List billing meter event summaries

HTTP Method: GET Endpoint: /v1/billing/meters/{meter-id}/event_summaries

Path Parameters:

• meter-id (String): Unique identifier for the object.

Query Parameters:

• customer (String): The customer for which to fetch event summaries. (required)
• end-time (Integer): The timestamp from when to stop aggregating meter events (exclusive). Must be aligned with minute boundaries. (required)
• 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.
• start-time (Integer): The timestamp from when to start aggregating meter events (inclusive). Must be aligned with minute boundaries. (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.
• value-grouping-window (String): Specifies what granularity to use when generating event summaries. If not specified, a single event summary would be returned for the specified time range. For hourly granularity, start and end times must align with hour boundaries (e.g., 00:00, 01:00, ..., 23:00). For daily granularity, start and end times must align with UTC day boundaries (00:00 UTC).

Example Usage: (list-all-meters-id-event-summaries {:meter-id example-meter-id :query-params {:limit 10}})

post-alerts-id-activate clj

(post-alerts-id-activate {:keys [alert-id body]})

Activate a billing alert

HTTP Method: POST Endpoint: /v1/billing/alerts/{alert-id}/activate

Path Parameters:

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

Example Usage: (post-alerts-id-activate {:alert-id example-alert-id})

post-alerts-id-archive clj

(post-alerts-id-archive {:keys [alert-id body]})

Archive a billing alert

HTTP Method: POST Endpoint: /v1/billing/alerts/{alert-id}/archive

Path Parameters:

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

Example Usage: (post-alerts-id-archive {:alert-id example-alert-id})

post-alerts-id-deactivate clj

(post-alerts-id-deactivate {:keys [alert-id body]})

Deactivate a billing alert

HTTP Method: POST Endpoint: /v1/billing/alerts/{alert-id}/deactivate

Path Parameters:

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

Example Usage: (post-alerts-id-deactivate {:alert-id example-alert-id})

post-credit-grants-id-expire clj

(post-credit-grants-id-expire {:keys [credit-grant-id body]})

Expire a credit grant

HTTP Method: POST Endpoint: /v1/billing/credit_grants/{credit-grant-id}/expire

Path Parameters:

• credit-grant-id (String): Unique identifier for the object.

Example Usage: (post-credit-grants-id-expire {:credit-grant-id example-credit-grant-id})

post-credit-grants-id-void clj

(post-credit-grants-id-void {:keys [credit-grant-id body]})

Void a credit grant

HTTP Method: POST Endpoint: /v1/billing/credit_grants/{credit-grant-id}/void

Path Parameters:

• credit-grant-id (String): Unique identifier for the object.

Example Usage: (post-credit-grants-id-void {:credit-grant-id example-credit-grant-id})

post-meters-id-deactivate clj

(post-meters-id-deactivate {:keys [meter-id body]})

Deactivate a billing meter

HTTP Method: POST Endpoint: /v1/billing/meters/{meter-id}/deactivate

Path Parameters:

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

Example Usage: (post-meters-id-deactivate {:meter-id example-meter-id})

post-meters-id-reactivate clj

(post-meters-id-reactivate {:keys [meter-id body]})

Reactivate a billing meter

HTTP Method: POST Endpoint: /v1/billing/meters/{meter-id}/reactivate

Path Parameters:

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

Example Usage: (post-meters-id-reactivate {:meter-id example-meter-id})

retrieve-alerts-id clj

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

Retrieve a billing alert

HTTP Method: GET Endpoint: /v1/billing/alerts/{alert-id}

Path Parameters:

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

Query Parameters:

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

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

retrieve-credit-balance-transactions-id clj

(retrieve-credit-balance-transactions-id {:keys [credit-balance-transaction-id
                                                 query-params]})

Retrieve a credit balance transaction

HTTP Method: GET Endpoint: /v1/billing/credit_balance_transactions/{credit-balance-transaction-id}

Path Parameters:

• credit-balance-transaction-id (String): Unique identifier for the object.

Query Parameters:

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

Example Usage: (retrieve-credit-balance-transactions-id {:credit-balance-transaction-id example-credit-balance-transaction-id :query-params {:limit 10}})

retrieve-credit-grants-id clj

(retrieve-credit-grants-id {:keys [credit-grant-id query-params]})

Retrieve a credit grant

HTTP Method: GET Endpoint: /v1/billing/credit_grants/{credit-grant-id}

Path Parameters:

• credit-grant-id (String): Unique identifier for the object.

Query Parameters:

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

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

retrieve-meters-id clj

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

Retrieve a billing meter

HTTP Method: GET Endpoint: /v1/billing/meters/{meter-id}

Path Parameters:

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

Query Parameters:

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

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

update-credit-grants-id clj

(update-credit-grants-id {:keys [credit-grant-id body]})

Update a credit grant

HTTP Method: POST Endpoint: /v1/billing/credit_grants/{credit-grant-id}

Path Parameters:

• credit-grant-id (String): Unique identifier for the object.

Example Usage: (update-credit-grants-id {:credit-grant-id example-credit-grant-id})

update-meters-id clj

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

Update a billing meter

HTTP Method: POST Endpoint: /v1/billing/meters/{meter-id}

Path Parameters:

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

Example Usage: (update-meters-id {:meter-id example-meter-id})