Skip to content

by Startups.Studio

Finance Subscription

Subscription.unsubscribe

POST /{namespace}/subscriptions/{subscription}/unsubscribe

Unsubscribe ends a Subscription at the close of its current period, and the Customer keeps access until then.

Noun: Subscription
Mode: do
Event: Subscription.unsubscribed

You, to your agent

Unsubscribe the latest subscription.

curl -X POST https://api.sb/tutorloop.com/subscriptions/subscription_1/unsubscribe \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const subscription = await $.Subscription.unsubscribe({ subscription: 'subscription_1' })

npx startup-builder do Subscription.unsubscribe --json '{"subscription":"subscription_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Subscription.unsubscribe({ subscription: 'subscription_1' })"
  }
}

Inputs

Input	Type	Required	Description
`subscription`	Subscription	required	The Subscription to end.
`reason`	`text`		Why the Customer leaves.
`comment`	`text`		The Customer’s own words, kept verbatim as the Evidence quote.

Outputs

Output	Type	Required	Description
`subscription`	Subscription	required	The Subscription, ending.

Effects

Emits Subscription.unsubscribed.
Performed by the Billing Specialist.
Two-way: it runs at once, in the try, send and do modes.
Stops renewal.
Keeps the Customer: a Customer is a Customer forever.
Runs at once: no Limit, Approval or delay window stands between the Customer and the result.
Records Behavior-grade Evidence that refutes the slot its reason code tests; the stated reason alone binds as Opinion.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Subscription.unsubscribe
The record is not in a state that allows this Verb, so the call is refused.	`refused`	Read the record, run the Verb that moves it to an allowed state, then retry.	Subscription.unsubscribe

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Subscription.switch

Previous Page

Subscription.update

Next Page