Info: This ns is auto-generated from the Stripe OpenAPI spec.
Info: This ns is auto-generated from the Stripe OpenAPI spec.
(create-subscription-schedules {:keys [body]})Create a schedule
HTTP Method: POST Endpoint: /v1/subscription_schedules
Example Usage: (create-subscription-schedules {})
Create a schedule
HTTP Method: POST
Endpoint: /v1/subscription_schedules
Example Usage:
(create-subscription-schedules {})(list-all-subscription-schedules {:keys [query-params]})List all schedules
HTTP Method: GET Endpoint: /v1/subscription_schedules
Query Parameters:
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.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-subscription-schedules {:query-params {:limit 10}})
List all schedules
HTTP Method: GET
Endpoint: /v1/subscription_schedules
Query Parameters:
- canceled-at (Unknown): Only return subscription schedules that were created canceled the given date interval.
- completed-at (Unknown): Only return subscription schedules that completed during the given date interval.
- created (Unknown): Only return subscription schedules that were created during the given date interval.
- customer (String): Only return subscription schedules for the given customer.
- customer-account (String): Only return subscription schedules for the given account.
- 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.
- released-at (Unknown): Only return subscription schedules that were released during the given date interval.
- scheduled (Boolean): Only return subscription schedules that have not started yet.
- 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-subscription-schedules {:query-params {:limit 10}})(post-subscription-schedules-schedule-cancel {:keys [subscription-schedule-id
body]})Cancel a schedule
HTTP Method: POST Endpoint: /v1/subscription_schedules/{subscription-schedule-id}/cancel
Path Parameters:
Example Usage: (post-subscription-schedules-schedule-cancel {:subscription-schedule-id example-subscription-schedule-id})
Cancel a schedule
HTTP Method: POST
Endpoint: /v1/subscription_schedules/{subscription-schedule-id}/cancel
Path Parameters:
- subscription-schedule-id (String): The subscription-schedule-id parameter. (required)
Example Usage:
(post-subscription-schedules-schedule-cancel {:subscription-schedule-id example-subscription-schedule-id})(post-subscription-schedules-schedule-release {:keys [subscription-schedule-id
body]})Release a schedule
HTTP Method: POST Endpoint: /v1/subscription_schedules/{subscription-schedule-id}/release
Path Parameters:
Example Usage: (post-subscription-schedules-schedule-release {:subscription-schedule-id example-subscription-schedule-id})
Release a schedule
HTTP Method: POST
Endpoint: /v1/subscription_schedules/{subscription-schedule-id}/release
Path Parameters:
- subscription-schedule-id (String): The subscription-schedule-id parameter. (required)
Example Usage:
(post-subscription-schedules-schedule-release {:subscription-schedule-id example-subscription-schedule-id})(retrieve-subscription-schedules-schedule {:keys [subscription-schedule-id
query-params]})Retrieve a schedule
HTTP Method: GET Endpoint: /v1/subscription_schedules/{subscription-schedule-id}
Path Parameters:
Query Parameters:
Example Usage: (retrieve-subscription-schedules-schedule {:subscription-schedule-id example-subscription-schedule-id :query-params {:limit 10}})
Retrieve a schedule
HTTP Method: GET
Endpoint: /v1/subscription_schedules/{subscription-schedule-id}
Path Parameters:
- subscription-schedule-id (String): The subscription-schedule-id parameter. (required)
Query Parameters:
- expand (Array): Specifies which fields in the response should be expanded.
Example Usage:
(retrieve-subscription-schedules-schedule {:subscription-schedule-id example-subscription-schedule-id :query-params {:limit 10}})(update-subscription-schedules-schedule {:keys [subscription-schedule-id body]})Update a schedule
HTTP Method: POST Endpoint: /v1/subscription_schedules/{subscription-schedule-id}
Path Parameters:
Example Usage: (update-subscription-schedules-schedule {:subscription-schedule-id example-subscription-schedule-id})
Update a schedule
HTTP Method: POST
Endpoint: /v1/subscription_schedules/{subscription-schedule-id}
Path Parameters:
- subscription-schedule-id (String): The subscription-schedule-id parameter. (required)
Example Usage:
(update-subscription-schedules-schedule {:subscription-schedule-id example-subscription-schedule-id})cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |