Creates a subscription and sends a welcome email. The email will contain a link to activate the subscription in Business Portal.
\nemail is mandatory. name is optional.
Pass invitationAmount for a one-time top-up OR monthlyInvitationAmount to assign more invites every month. For monthly subscriptions, the invites are assigned on the 1st day of every month. However, if a business doesn't have any active monthly subscription when activating a new monthly subscription, they will get the invites immediately. While activating a monthly subscription, we will cancel the previous monthly subscription automatically if there is one.
Pass expiresInMonths to cancel a monthly subscription automatically after some period of time. If it is defined, expiresAt will be set to the expiration date. After expiration, the status will be set to Expired by the end of the day.
Returns a paginated list of subscriptions that match the specified filters. The list is sorted by createdAt in descending order. To retrieve the next page, send a new request with the same query parameters and nextCursorId as cursorId. If nextCursorId is null, there are no more items in the list.
How many items to return (1-100)
\n","type":"text/plain"},"key":"limit","value":"10"},{"disabled":true,"description":{"content":"Skip everything before this item (null by default)
\n","type":"text/plain"},"key":"cursorId","value":""},{"description":{"content":"Filter by status (optional). Pending or Activated
Cancels a subscription. It's only possible to cancel a pending one-time or monthly subscription, or activated monthly subscription. It is not possible to cancel an activated one-time subscription. If you cancel a monthly subscription, it will remain valid till the end of the current period. After expiration the status will be set to Expired.
Creates a subscription and sends a welcome email. The email will contain a link to activate the subscription in Personal Portal.
\nemail and plan are mandatory. plan can be Basic or Recurring. name is optional.
Pass expiresInMonths to cancel a recurring subscription automatically after some period of time. If it is defined, expiresAt will be set to the expiration date. After expiration, the status will be set to Expired by the end of the day.
Returns a paginated list of subscriptions that match the specified filters. The list is sorted by createdAt in descending order. To retrieve the next page, send a new request with the same query parameters and nextCursorId as cursorId. If nextCursorId is null, there are no more items in the list.
How many items to return (1-100)
\n","type":"text/plain"},"key":"limit","value":"10"},{"disabled":true,"description":{"content":"Skip everything before this item (null by default)
\n","type":"text/plain"},"key":"cursorId","value":""},{"description":{"content":"Filter by email (optional)
\n","type":"text/plain"},"key":"email","value":"andrew@example.com"},{"description":{"content":"Filter by status (optional). Pending or Activated
Cancels a subscription. It's only possible to cancel a pending basic or recurring subscription, or activated recurring subscription. It is not possible to cancel an activated basic subscription.
\nIf you cancel a recurring subscription, the user will be able to use the platform till the end of current period. For example, a recurring subscription was created on Mar 25 and canceled on May 5. Since the user pays monthly, they will be able to use the platform till May 25.
\n","urlObject":{"path":["api","v1","individual","subscription-cancel",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"d3207328-5e8c-4238-a1c5-e047c55dcb2f","type":"any","value":"cl2pyw7gg0047vuvpwy8c1xtc","key":"id"}]}},"response":[{"id":"3254a7e6-6099-4699-b48d-a2b554474232","name":"Cancel a subscription","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{apiKey}}","type":"text"}],"url":{"raw":"{{baseUrl}}/api/v1/individual/subscription-cancel/:id","host":["{{baseUrl}}"],"path":["api","v1","individual","subscription-cancel",":id"],"variable":[{"id":"d3207328-5e8c-4238-a1c5-e047c55dcb2f","key":"id","value":"cl2pyw7gg0047vuvpwy8c1xtc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"235"},{"key":"ETag","value":"W/\"eb-tS/+kPd8RylW0FFOJV2s6fzcIPg\""},{"key":"Date","value":"Tue, 03 May 2022 09:49:07 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"cl2pyw7gg0047vuvpwy8c1xtc\",\n \"email\": \"ruslan@oakslab.com\",\n \"status\": \"Canceled\",\n \"createdAt\": \"2022-05-03T09:47:54.687Z\",\n \"updatedAt\": \"2022-05-03T09:49:07.065Z\",\n \"activatedAt\": null,\n \"canceledAt\": \"2022-05-03T09:49:07.062Z\",\n \"plan\": \"Basic\"\n}"}],"_postman_id":"bc740b48-2f32-4297-aca7-98931ca5d296"}],"id":"65108bb7-8f79-42a1-bec7-b3cb7aff9112","_postman_id":"65108bb7-8f79-42a1-bec7-b3cb7aff9112","description":""}],"event":[{"listen":"prerequest","script":{"id":"e1a15f82-33cb-4fae-8eb8-2aad0f371b4e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"63d2b4a0-0024-472c-a0ba-ce9235d0eb80","type":"text/javascript","exec":[""]}}]}