Resume Subscription

POST

/api/:account_id/subscriptions/:subscription_id/resume

POST

/api/:account_id/subscriptions/:subscription_id/resume

1 curl -X POST https://app.paymentkit.com/api/account_id/subscriptions/subscription_id/resume \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{}'

1 {
2   "id": "sub_8f3a2b1c9d4e5f6a7b8c9d0e",
3   "state": "active",
4   "currency": "usd",
5   "description": "Premium monthly subscription plan",
6   "current_period_start": "2024-05-01T00:00:00Z",
7   "current_period_end": "2024-05-31T23:59:59Z",
8   "pause_at_end": false,
9   "cancel_at_period_end": false,
10   "created_at": "2023-12-15T12:00:00Z",
11   "updated_at": "2024-04-27T10:15:00Z",
12   "items": [
13     {
14       "id": "item_1234567890abcdef",
15       "price": {
16         "id": "price_9876543210fedcba",
17         "account_id": "acct_0011223344556677",
18         "product_id": "prod_abc123def456ghi789",
19         "product_name": "Premium Plan",
20         "product_description": "Access to all premium features",
21         "name": "Monthly Premium",
22         "unit_amount_atom": 99900,
23         "currency": "usd",
24         "is_active": true,
25         "unit_label": "month",
26         "pricing_type": "recurring",
27         "recurring_interval": "month",
28         "recurring_interval_count": 1,
29         "auto_renew": true,
30         "contract_term_multiple": 1,
31         "trial_days": 14,
32         "usage_type": "licensed",
33         "billing_scheme": "per_unit",
34         "tier_amount_info": {
35           "mode": "volume",
36           "amount_atoms": [
37             {
38               "unit_amount_atom": 99900,
39               "flat_amount_atom": 0
40             }
41           ]
42         },
43         "prerequisite_price_ids": [],
44         "exclusive_customer_ids": [],
45         "metadata": {},
46         "custom_fields": {},
47         "quantity_divisor": 1,
48         "created_at": "2023-11-01T08:00:00Z",
49         "updated_at": "2024-01-10T09:00:00Z"
50       },
51       "quantity": 1,
52       "is_active": true,
53       "start_at_end": false,
54       "drop_at_end": false,
55       "product_name": "Premium Plan",
56       "product_description": "Access to all premium features",
57       "available_prices": [
58         {
59           "id": "price_9876543210fedcba",
60           "account_id": "acct_0011223344556677",
61           "product_id": "prod_abc123def456ghi789",
62           "product_name": "Premium Plan",
63           "product_description": "Access to all premium features",
64           "name": "Monthly Premium",
65           "unit_amount_atom": 99900,
66           "currency": "usd",
67           "is_active": true,
68           "unit_label": "month",
69           "pricing_type": "recurring",
70           "recurring_interval": "month",
71           "recurring_interval_count": 1,
72           "auto_renew": true,
73           "contract_term_multiple": 1,
74           "trial_days": 14,
75           "usage_type": "licensed",
76           "billing_scheme": "per_unit",
77           "tier_amount_info": {
78             "mode": "volume",
79             "amount_atoms": [
80               {
81                 "unit_amount_atom": 99900,
82                 "flat_amount_atom": 0
83               }
84             ]
85           },
86           "prerequisite_price_ids": [],
87           "exclusive_customer_ids": [],
88           "metadata": {},
89           "custom_fields": {},
90           "quantity_divisor": 1,
91           "created_at": "2023-11-01T08:00:00Z",
92           "updated_at": "2024-01-10T09:00:00Z"
93         }
94       ],
95       "addons": [
96         {
97           "price": {
98             "id": "price_addon_0011223344",
99             "account_id": "acct_0011223344556677",
100             "product_id": "prod_addon_5566778899",
101             "product_name": "Extra Storage Addon",
102             "product_description": "Additional 100GB storage",
103             "name": "Storage Addon",
104             "unit_amount_atom": 5000,
105             "currency": "usd",
106             "is_active": true,
107             "unit_label": "month",
108             "pricing_type": "recurring",
109             "recurring_interval": "month",
110             "recurring_interval_count": 1,
111             "auto_renew": true,
112             "contract_term_multiple": 1,
113             "trial_days": 0,
114             "usage_type": "licensed",
115             "billing_scheme": "per_unit",
116             "tier_amount_info": {
117               "mode": "volume",
118               "amount_atoms": [
119                 {
120                   "unit_amount_atom": 5000,
121                   "flat_amount_atom": 0
122                 }
123               ]
124             },
125             "prerequisite_price_ids": [],
126             "exclusive_customer_ids": [],
127             "metadata": {},
128             "custom_fields": {},
129             "quantity_divisor": 1,
130             "created_at": "2023-12-01T10:00:00Z",
131             "updated_at": "2024-02-15T11:00:00Z"
132           },
133           "subscription_item_id": "item_1234567890abcdef",
134           "quantity": 1
135         }
136       ]
137     }
138   ],
139   "customer": {
140     "id": "cus_abcdef1234567890",
141     "name": "Acme Corporation",
142     "first_name": "John",
143     "last_name": "Doe",
144     "email": "john.doe@acmecorp.com",
145     "phone": "+1-555-123-4567",
146     "billing_email": "billing@acmecorp.com",
147     "business_name": "Acme Corporation",
148     "address": {
149       "id": "addr_001122334455",
150       "line1": "123 Main St",
151       "line2": "Suite 400",
152       "city": "San Francisco",
153       "state": "CA",
154       "zip_code": "94105",
155       "country": "US"
156     },
157     "shipping_address": {
158       "id": "addr_001122334456",
159       "line1": "123 Main St",
160       "line2": "Suite 400",
161       "city": "San Francisco",
162       "state": "CA",
163       "zip_code": "94105",
164       "country": "US"
165     },
166     "tax_ids": [
167       "TAX-123456789"
168     ],
169     "currency": "usd",
170     "language": "en",
171     "invoice_settings": {},
172     "credit_balance": {
173       "amount_atom": 1500,
174       "currency": "usd"
175     },
176     "total_spent": {
177       "amount_atom": 250000,
178       "currency": "usd"
179     },
180     "metadata": {},
181     "custom_fields": {},
182     "created_at": "2023-01-10T09:00:00Z",
183     "updated_at": "2024-04-20T14:00:00Z"
184   },
185   "collection_method": "charge_automatically",
186   "payment_method": {
187     "id": "pm_1234abcd5678efgh",
188     "account_id": "acct_0011223344556677",
189     "customer_id": "cus_abcdef1234567890",
190     "provider_type": "credit_card",
191     "name": "Visa ending in 4242",
192     "is_active": true,
193     "metadata": {},
194     "used_in_subscription": true,
195     "created_at": "2023-11-15T08:30:00Z",
196     "updated_at": "2024-04-25T09:45:00Z"
197   },
198   "discount": {
199     "id": "disc_7890abcd1234efgh",
200     "coupon_id": "coupon_spring2024",
201     "promotion_code_id": "promo_2024spring",
202     "attachment_level": "subscription",
203     "customer_id": "cus_abcdef1234567890",
204     "subscription_id": "sub_8f3a2b1c9d4e5f6a7b8c9d0e",
205     "invoice_id": "inv_20240401_0001",
206     "invoice_item_id": "invitem_20240401_0001",
207     "start_date": "2024-04-01T00:00:00Z",
208     "end_date": "2024-06-30T23:59:59Z",
209     "is_active": true,
210     "metadata": {},
211     "created_at": "2024-03-15T12:00:00Z",
212     "updated_at": "2024-04-01T12:00:00Z"
213   },
214   "last_successful_processor_id": "proc_5678efgh1234abcd",
215   "metadata": {},
216   "custom_fields": {}
217 }

Resume a paused subscription.

Clears pause fields (paused_at, resumes_at) and transitions subscription back to:

TRIALING: If trial period hasn’t expired
ACTIVE: Otherwise

Emits subscription.resumed webhook event with:

resumed_at: When the subscription was resumed
new_state: The state it transitioned to (active or trialing)

When from_workflow=true (Restate calls):

Returns ResumeSubscriptionResponse with status field
Returns “skipped” if subscription is not paused

When from_workflow=false (public API calls):

Returns SubscriptionResponse

Works for User, API Key, and Restate workflow authentication. Account access is automatically validated via endpoint dependency.

Resume a paused subscription. Clears pause fields (paused_at, resumes_at) and transitions subscription back to: - TRIALING: If trial period hasn't expired - ACTIVE: Otherwise Emits `subscription.resumed` webhook event with: - resumed_at: When the subscription was resumed - new_state: The state it transitioned to (active or trialing) When from_workflow=true (Restate calls): - Returns ResumeSubscriptionResponse with status field - Returns "skipped" if subscription is not paused When from_workflow=false (public API calls): - Returns SubscriptionResponse Works for User, API Key, and Restate workflow authentication. Account access is automatically validated via endpoint dependency.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

subscription_idstringRequired

account_idstringRequired

Query parameters

from_workflowbooleanOptionalDefaults to false

Response

Successful Response

SubscriptionResponseobject

ResumeSubscriptionResponseobject

Resume Subscription

Authentication

Path parameters

Headers

Query parameters

Response

Errors