{
  "opencollection": "1.0.0",
  "info": {
    "name": "Stripe Accounts Account Subscription Schedules API",
    "version": "2023-10-16"
  },
  "items": [
    {
      "info": {
        "name": "Subscription Schedules",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "GetSubscriptionSchedules",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.stripe.com/v1/subscription_schedules",
            "params": [
              {
                "name": "canceled_at",
                "value": "",
                "type": "query",
                "description": "Only return subscription schedules that were created canceled the given date interval."
              },
              {
                "name": "completed_at",
                "value": "",
                "type": "query",
                "description": "Only return subscription schedules that completed during the given date interval."
              },
              {
                "name": "created",
                "value": "",
                "type": "query",
                "description": "Only return subscription schedules that were created during the given date interval."
              },
              {
                "name": "customer",
                "value": "",
                "type": "query",
                "description": "Only return subscription schedules for the given customer."
              },
              {
                "name": "ending_before",
                "value": "",
                "type": "query",
                "description": "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."
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "Specifies which fields in the response should be expanded."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10."
              },
              {
                "name": "released_at",
                "value": "",
                "type": "query",
                "description": "Only return subscription schedules that were released during the given date interval."
              },
              {
                "name": "scheduled",
                "value": "",
                "type": "query",
                "description": "Only return subscription schedules that have not started yet."
              },
              {
                "name": "starting_after",
                "value": "",
                "type": "query",
                "description": "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."
              }
            ],
            "body": {
              "type": "form-urlencoded",
              "data": []
            }
          },
          "docs": "<p>Retrieves the list of your subscription schedules.</p>"
        },
        {
          "info": {
            "name": "PostSubscriptionSchedules",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.stripe.com/v1/subscription_schedules",
            "body": {
              "type": "form-urlencoded",
              "data": []
            }
          },
          "docs": "<p>Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.</p>"
        },
        {
          "info": {
            "name": "GetSubscriptionSchedulesSchedule",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.stripe.com/v1/subscription_schedules/:schedule",
            "params": [
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "Specifies which fields in the response should be expanded."
              },
              {
                "name": "schedule",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "form-urlencoded",
              "data": []
            }
          },
          "docs": "<p>Retrieves the details of an existing subscription schedule. You only need to supply the unique subscription schedule identifier that was returned upon subscription schedule creation.</p>"
        },
        {
          "info": {
            "name": "PostSubscriptionSchedulesSchedule",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.stripe.com/v1/subscription_schedules/:schedule",
            "params": [
              {
                "name": "schedule",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "form-urlencoded",
              "data": []
            }
          },
          "docs": "<p>Updates an existing subscription schedule.</p>"
        },
        {
          "info": {
            "name": "PostSubscriptionSchedulesScheduleCancel",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.stripe.com/v1/subscription_schedules/:schedule/cancel",
            "params": [
              {
                "name": "schedule",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "form-urlencoded",
              "data": []
            }
          },
          "docs": "<p>Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is <code>not_started</code> or <code>active</code>.</p>"
        },
        {
          "info": {
            "name": "PostSubscriptionSchedulesScheduleRelease",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.stripe.com/v1/subscription_schedules/:schedule/release",
            "params": [
              {
                "name": "schedule",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "form-urlencoded",
              "data": []
            }
          },
          "docs": "<p>Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is <code>not_started</code> or <code>active</code>. If the subscription schedule is currently associated with a subscription, releasing it will remove its <code>subscription</code> property and set the subscription’s ID to the <code>released_subscription</code> property.</p>"
        }
      ]
    }
  ],
  "bundled": true
}