Skip to content

by Startups.Studio

Product What you sell Offer

Offer.subscribe

POST /{namespace}/offers/{offer}/subscribe

Subscribe accepts a recurring Offer as a Subscription that renews each period until it ends.

Noun: Offer
Mode: do
Event: Offer.subscribed

You, to your agent

Subscribe a customer to the offer “Résumé review”.

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

import { $ } from 'startup-builder'

const { subscription, offer } = await $.Offer.subscribe({ offer: 'offer_1' })

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

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

Inputs

Input	Type	Required	Description
`offer`	Offer	required	The recurring Offer.
`quantity`	`integer`		Seats or units. Defaults to 1.
`promotionCode`	`string`		A promotion code the buyer typed; applies its Coupon for the Coupon’s duration.

Outputs

Output	Type	Required	Description
`subscription`	Subscription	required	The new Subscription.
`offer`	Offer	required	The Offer subscribed to.

Effects

Emits Offer.subscribed.
Performed by the Billing Specialist.
Makes the party a Customer when it is not one yet.
Grants the Entitlements the Offer includes.
Bills the first period.

Refuses when

Check	Error	Fix	Then call
The input does not match the schema of the operation.	`invalid-input`	Read the schema of the operation, then send every required field with the right type.	Offer.subscribe
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.subscribe
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.subscribe

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

Previous Page

Offer.trial

Next Page