POST /v1/subscriptions/{subscription}/resume
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.
Servers
- https://api.stripe.com/
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
subscription |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/x-www-form-urlencoded" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
proration_date |
Integer | No |
If set, prorations will be calculated as though the subscription was resumed at the given time. This can be used to apply exactly the same prorations that were previewed with the create preview endpoint. |
expand[] |
Array | No |
Specifies which fields in the response should be expanded. |
billing_cycle_anchor |
String | No |
The billing cycle anchor that applies when the subscription is resumed. Either Possible values:
|
proration_behavior |
String | No |
Determines how to handle prorations resulting from the Possible values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.