Skip to content

by Startups.Studio

Product What you sell Offer

Offer.trial

POST /{namespace}/offers/{offer}/trial

Trial starts a Customer on an Offer free for a set number of days, with or without a card, converting or ending by its terms.

Noun: Offer
Mode: do
Event: Offer.trialed

You, to your agent

Trial the offer “Résumé review” with a customer.

curl -X POST https://api.sb/quietcopy.com/offers/offer_1/trial \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"customer":"customer_1","days":1}'

import { $ } from 'startup-builder'

const { subscription, offer } = await $.Offer.trial({ offer: 'offer_1', customer: 'customer_1', days: 1 })

npx startup-builder do Offer.trial --json '{"offer":"offer_1","customer":"customer_1","days":1}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Offer.trial({ offer: 'offer_1', customer: 'customer_1', days: 1 })"
  }
}

Inputs

Input	Type	Required	Description
`offer`	Offer	required	The Offer to try.
`customer`	Customer	required	The Customer who tries it.
`days`	`integer`	required	How long the trial runs. Never randomized.
`card`	`boolean`		True to take a card up front and charge it when the trial ends.

Outputs

Output	Type	Required	Description
`subscription`	Subscription	required	The Subscription, free until the trial ends.
`offer`	Offer	required	The Offer the trial is on.

Effects

Emits Offer.trialed.
Performed by the Billing Specialist.
Two-way: it runs at once, in the try, send and do modes.
With a card on file, converts to a paid Subscription at the end unless canceled first.
Without a card, ends at the end and opens a conversion Task for the Success Manager.

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

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

Offer.subscribe

Previous Page

Offer.update

Next Page