Skip to content

by Startups.Studio

Product What you sell Offer

Offer.accept

POST /{namespace}/offers/{offer}/accept

Accept records that a party takes an Offer, which makes that party a Customer of the Startup.

Noun: Offer
Mode: do
Event: Offer.accepted

You, to your agent

Accept the offer “Grain-free kibble, 12 lb”.

curl -X POST https://api.sb/petpantry.shop/offers/offer_1/accept \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"party":"Lena Fischer"}'

import { $ } from 'startup-builder'

const { customer, offer } = await $.Offer.accept({ offer: 'offer_1', party: 'Lena Fischer' })

npx startup-builder do Offer.accept --json '{"offer":"offer_1","party":"Lena Fischer"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Offer.accept({ offer: 'offer_1', party: 'Lena Fischer' })"
  }
}

Inputs

Input	Type	Required	Description
`offer`	Offer	required	The Offer to accept.
`party`	`string`	required	The person or organization accepting.

Outputs

Output	Type	Required	Description
`customer`	Customer	required	The Customer the party is or becomes.
`offer`	Offer	required	The Offer accepted.

Effects

Emits Offer.accepted.
Creates a Customer when the party has none at this Startup.

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

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

A developer accepts a $0 Offer for an API key and becomes a Customer of the Startup that made it.

Offer

Previous Page

Offer.create

Next Page