Skip to content

by Startups.Studio

Finance Subscription

Subscription.keep

POST /{namespace}/subscriptions/{subscription}/keep

Keep takes back a cancel before the period closes, so the Subscription renews on its date at the same terms.

Noun: Subscription
Mode: do
Event: Subscription.kept

You, to your agent

Keep the latest subscription.

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

import { $ } from 'startup-builder'

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

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

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

Inputs

Input	Type	Required	Description
`subscription`	Subscription	required	The ending Subscription.
`offer`	Offer		The Offer to renew on, when the Customer took the save offer.

Outputs

Output	Type	Required	Description
`subscription`	Subscription	required	The Subscription, active again.

Effects

Emits Subscription.kept.
Performed by the Billing Specialist.
Two-way: it runs at once, in the try, send and do modes.
Restores renewal on the original date.
Moves to the named Offer at the next period, when one is given.
Refuses once the period has closed; a canceled Subscription starts again as a new one.

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.keep
Once the period has closed; a canceled Subscription starts again as a new one	`refused`	Clear what the check names, then call it again.	Subscription.keep

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.get

Previous Page

Subscription.list

Next Page