Skip to content

by Startups.Studio

Product What you sell Offer

Offer.withdraw

POST /{namespace}/offers/{offer}/withdraw

Withdraw closes a published Offer to new Customers and leaves every existing Order and Subscription in force.

Noun: Offer
Mode: do
Event: Offer.withdrawn

You, to your agent

Withdraw the offer “Algebra session”.

curl -X POST https://api.sb/tutorloop.com/offers/offer_1/withdraw \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const offer = await $.Offer.withdraw({ offer: 'offer_1' })

npx startup-builder do Offer.withdraw --json '{"offer":"offer_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Offer.withdraw({ offer: 'offer_1' })"
  }
}

Inputs

Input	Type	Required	Description
`offer`	Offer	required	The Offer to withdraw.

Outputs

Output	Type	Required	Description
`offer`	Offer	required	The Offer, closed to new acceptance.

Effects

Emits Offer.withdrawn.
Performed by the Product Lead.

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.	Offer.withdraw
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.	Offer.withdraw

When it waits

Gate	Default
Decision class	Medium: two-way, visible
Delay window	1 business hour, in which a watcher can pause, redirect or cancel it; then it runs.
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`.

Offer.update

Previous Page

Outcome Contract

Next Page