Skip to content

by Startups.Studio

Finance Subscription

Subscription.renew

POST /{namespace}/subscriptions/{subscription}/renew

Renew starts a Subscription’s next period and bills it at the Offer Version the Customer accepted.

Noun: Subscription
Mode: do
Event: Subscription.renewed

You, to your agent

Renew the latest subscription.

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

import { $ } from 'startup-builder'

const { invoice, subscription } = await $.Subscription.renew({ subscription: 'subscription_1' })

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

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

Inputs

Input	Type	Required	Description
`subscription`	Subscription	required	The Subscription to renew.

Outputs

Output	Type	Required	Description
`invoice`	Invoice	required	The Invoice for the new period.
`subscription`	Subscription	required	The Subscription in its new period.

Effects

Emits Subscription.renewed.
Performed by the Billing Specialist.
Two-way: it runs at once, in the try, send and do modes.
Runs on the period boundary with no caller.
Suspends Entitlements when payment fails after every retry.

Refuses when

Check	Error	Fix	Then call
The operation is part of an Offer the caller has not accepted or paid for.	`payment-required`	Accept the Offer named in the response, then retry the call.	Offer.accept
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.renew

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

Previous Page

Subscription.resize

Next Page