You can see a list of the customer’s active subscriptions. Note that the 10 most recent active subscriptions are always available by default on the customer object. If you need more than those 10, you can use the limit and starting_after parameters to page through additional subscriptions.
" }, { "info": { "name": "Stripe Post Customers Customer Subscriptions", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/customers/:customer/subscriptions", "params": [ { "name": "customer", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Creates a new subscription on an existing customer.
" }, { "info": { "name": "Stripe Get Customers Customer Subscriptions Subscription Exposed Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/customers/:customer/subscriptions/:subscription_exposed_id", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "subscription_exposed_id", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Retrieves the subscription with the given ID.
" }, { "info": { "name": "Stripe Post Customers Customer Subscriptions Subscription Exposed Id", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/customers/:customer/subscriptions/:subscription_exposed_id", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "subscription_exposed_id", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Updates an existing subscription on a customer to match the specified parameters. When changing plans or quantities, we will optionally prorate the price we charge next month to make up for any price changes. To preview how the proration will be calculated, use the upcoming invoice endpoint.
" }, { "info": { "name": "Stripe Delete Customers Customer Subscriptions Subscription Exposed Id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.stripe.com/v1/customers/:customer/subscriptions/:subscription_exposed_id", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "subscription_exposed_id", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Cancels a customer’s subscription. If you set the at_period_end parameter to true, the subscription will remain active until the end of the period, at which point it will be canceled and not renewed. Otherwise, with the default false value, the subscription is terminated immediately. In either case, the customer will not be charged again for the subscription.
Note, however, that any pending invoice items that you’ve created will still be charged " }, { "info": { "name": "Stripe Get Customers Customer Subscriptions Subscription Exposed Id Discount", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/customers/:customer/subscriptions/:subscription_exposed_id/discount", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "subscription_exposed_id", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Stripe Get Customers Customer Subscriptions Subscription Exposed Id Discount" }, { "info": { "name": "Stripe Delete Customers Customer Subscriptions Subscription Exposed Id Discount", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.stripe.com/v1/customers/:customer/subscriptions/:subscription_exposed_id/discount", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "subscription_exposed_id", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "
Removes the currently applied discount on a customer.
" }, { "info": { "name": "GetSubscriptions", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/subscriptions", "params": [ { "name": "automatic_tax", "value": "", "type": "query", "description": "Filter subscriptions by their automatic tax settings." }, { "name": "collection_method", "value": "", "type": "query", "description": "The collection method of the subscriptions to retrieve. Either `charge_automatically` or `send_invoice`." }, { "name": "created", "value": "", "type": "query" }, { "name": "current_period_end", "value": "", "type": "query" }, { "name": "current_period_start", "value": "", "type": "query" }, { "name": "customer", "value": "", "type": "query", "description": "The ID of the customer whose subscriptions will be retrieved." }, { "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": "price", "value": "", "type": "query", "description": "Filter for subscriptions that contain this recurring price ID." }, { "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." }, { "name": "status", "value": "", "type": "query", "description": "The status of the subscriptions to retrieve. Passing in a value of `canceled` will return all canceled subscriptions, including those belonging to deleted customers. Pass `ended` to find subscriptions that are canceled and subscriptions that are expired due to [incomplete payment](https://stripe.com/docs/billing/subscriptions/overview#subscription-statuses). Passing in a value of `all` will return subscriptions of all statuses. If no value is supplied, all subscriptions that have not been canceled are returned." }, { "name": "test_clock", "value": "", "type": "query", "description": "Filter for subscriptions that are associated with the specified test clock. The response will not include subscriptions with test clocks if this and the customer parameter is not set." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.
Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.
\n\nWhen you create a subscription with collection_method=charge_automatically, the first invoice is finalized as part of the request.\nThe payment_behavior parameter determines the exact behavior of the initial payment.
To start subscriptions where the first invoice always begins in a draft status, use Search for subscriptions you’ve previously created using Stripe’s Search Query Language.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.
Retrieves the subscription with the given ID.
" }, { "info": { "name": "PostSubscriptionsSubscriptionExposedId", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/subscriptions/:subscription_exposed_id", "params": [ { "name": "subscription_exposed_id", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Updates an existing subscription to match the specified parameters.\nWhen changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes.\nTo preview how the proration is calculated, use the upcoming invoice endpoint.
\n\nBy default, we prorate subscription changes. For example, if a customer signs up on May 1 for a
Cancels a customer’s subscription immediately. The customer will not be charged again for the subscription.
\n\nNote, however, that any pending invoice items that you’ve created will still be charged for at the end of the period, unless manually deleted. If you’ve set the subscription to cancel at the end of the period, any pending prorations will also be left in place and collected at the end of the period. But if the subscription is set to cancel immedi" }, { "info": { "name": "DeleteSubscriptionsSubscriptionExposedIdDiscount", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.stripe.com/v1/subscriptions/:subscription_exposed_id/discount", "params": [ { "name": "subscription_exposed_id", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "
Removes the currently applied discount on a subscription.
" }, { "info": { "name": "PostSubscriptionsSubscriptionResume", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/subscriptions/:subscription/resume", "params": [ { "name": "subscription", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If a resumption invoice is generated, it must be paid or marked uncollectible before the subscription will be unpaused. If payment succeeds the subscription will become active, and if payment fails the subscription will be past_due. The resumption invoice will void automatically if not paid by the expiration date.