3.5 KiB
3.5 KiB
name, description
| name | description |
|---|---|
| subscriptions-routes | Handle 9 OpenAPI operation(s) under /v1/subscriptions for the subscriptions route group. |
subscriptions API Routes
Handle 9 OpenAPI operation(s) under /v1/subscriptions for the subscriptions route group.
Use the generated operation tools to make real API calls. Do not invent API responses. If a tool reports missing setup, return the exact setup field name to the caller. For write, update, or delete operations, state the intended action before calling the tool.
Operations
get_subscriptions
- Operation ID:
get_subscriptions - Route:
GET /v1/subscriptions - Mode: READ
- Summary: List subscriptions
- Parameters:
automatic_taxinquerycollection_methodinquerycreatedinquerycurrent_period_endinquerycurrent_period_startinquerycustomerinquerycustomer_accountinqueryending_beforeinqueryexpandinquerylimitinquerypriceinquerystarting_afterinquerystatusinquerytest_clockinquery
- Body: JSON request body accepted.
post_subscriptions
- Operation ID:
post_subscriptions - Route:
POST /v1/subscriptions - Mode: WRITE
- Summary: Create a subscription
- Body: JSON request body accepted.
get_subscriptions_search
- Operation ID:
get_subscriptions_search - Route:
GET /v1/subscriptions/search - Mode: READ
- Summary: Search subscriptions
- Parameters:
expandinquerylimitinquerypageinqueryqueryinqueryrequired
- Body: JSON request body accepted.
delete_subscriptions_subscription_exposed_id
- Operation ID:
delete_subscriptions_subscription_exposed_id - Route:
DELETE /v1/subscriptions/{subscription_exposed_id} - Mode: WRITE
- Summary: Cancel a subscription
- Parameters:
subscription_exposed_idinpathrequired
- Body: JSON request body accepted.
get_subscriptions_subscription_exposed_id
- Operation ID:
get_subscriptions_subscription_exposed_id - Route:
GET /v1/subscriptions/{subscription_exposed_id} - Mode: READ
- Summary: Retrieve a subscription
- Parameters:
expandinquerysubscription_exposed_idinpathrequired
- Body: JSON request body accepted.
post_subscriptions_subscription_exposed_id
- Operation ID:
post_subscriptions_subscription_exposed_id - Route:
POST /v1/subscriptions/{subscription_exposed_id} - Mode: WRITE
- Summary: Update a subscription
- Parameters:
subscription_exposed_idinpathrequired
- Body: JSON request body accepted.
delete_subscriptions_subscription_exposed_id_discount
- Operation ID:
delete_subscriptions_subscription_exposed_id_discount - Route:
DELETE /v1/subscriptions/{subscription_exposed_id}/discount - Mode: WRITE
- Summary: Delete a subscription discount
- Parameters:
subscription_exposed_idinpathrequired
- Body: JSON request body accepted.
post_subscriptions_subscription_migrate
- Operation ID:
post_subscriptions_subscription_migrate - Route:
POST /v1/subscriptions/{subscription}/migrate - Mode: WRITE
- Summary: Migrate a subscription
- Parameters:
subscriptioninpathrequired
- Body: JSON request body accepted.
post_subscriptions_subscription_resume
- Operation ID:
post_subscriptions_subscription_resume - Route:
POST /v1/subscriptions/{subscription}/resume - Mode: WRITE
- Summary: Resume a subscription
- Parameters:
subscriptioninpathrequired
- Body: JSON request body accepted.