Coupon methods
Every Coupon Verb as a typed SDK method, with its inputs, result, refusals and an example.
Reference for Coupon.
| Noun | System | Run by |
|---|---|---|
| Coupon | Billing | Billing Specialist |
Coupon.create
Creates a Coupon. Verb page.
interface CouponVerbs {
create(input: CouponCreateInput, options?: SB.CallOptions): SB.Call<Coupon>
}Emits Coupon.created.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
percentOff | number | The percent taken off each charge it applies to; set this or amountOff. Never randomized. | |
amountOff | money | The fixed amount taken off each charge it applies to. Never randomized. | |
duration | string | required | How long it applies: once, repeating for months, or forever. |
months | integer | How many months a repeating Coupon applies. | |
code | string | The promotion code a buyer types at checkout, when the Coupon has one. | |
redeemBy | datetime | The last moment it can be redeemed. | |
maxRedemptions | integer | How many times it can be redeemed across all Customers. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
coupon | Coupon | required | The Coupon. |
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. | None. |
Example
import { $ } from 'startup-builder'
const coupon = await $.Coupon.create({ duration: 'once' })Coupon.get
Returns one Coupon by id. Verb page.
interface CouponVerbs {
get(input: CouponGetInput, options?: SB.CallOptions): SB.Call<Coupon>
}Reads only: it emits no Event.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Coupon. |
at | string | A time or Version name: the record as it stood then. Unset: as it stands now. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
coupon | Coupon | required | The Coupon. |
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. | None. |
Example
import { $ } from 'startup-builder'
const coupon = await $.Coupon.get({ id: 'coupon_rAfxMa2HGB' })Coupon.list
Returns Coupons, newest first, one page at a time. Verb page.
interface CouponVerbs {
list(input?: CouponListInput, options?: SB.CallOptions): SB.ListCall<Coupon>
}Reads only: it emits no Event.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
limit | integer | At most this many records, up to 100. The default is 20. | |
after | string | The cursor from the previous page. | |
where | string | A filter over the properties, such as paidAt = null and total.amount > 500. | |
sort | string | Properties to sort by, comma-separated; a leading minus sorts descending. | |
total | boolean | True adds the match count as meta.total, exact up to 10,000 matches and estimated above. | |
facets | string | Properties to count by value, comma-separated, returned as meta.facets. | |
fields | string | Properties to return on each record, comma-separated; $id and $type always return. | |
include | string | Related records to embed in place of their URLs, comma-separated. | |
depth | integer | How many levels of related records to embed. The default is 1. | |
q | string | Words to match across the text properties, ranked by relevance. | |
match | string | Ranks the search by words, or meaning; words is the default. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
coupons | list of Coupon | required | One page of Coupons. |
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. | None. |
Example
import { $ } from 'startup-builder'
const coupons = await $.Coupon.list({ limit: 20 })Coupon.update
Changes the given properties of a Coupon. Verb page.
interface CouponVerbs {
update(input: CouponUpdateInput, options?: SB.CallOptions): SB.Call<Coupon>
}Emits Coupon.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Coupon. |
percentOff | number | The percent taken off each charge it applies to; set this or amountOff. Never randomized. | |
amountOff | money | The fixed amount taken off each charge it applies to. Never randomized. | |
duration | string | How long it applies: once, repeating for months, or forever. | |
months | integer | How many months a repeating Coupon applies. | |
code | string | The promotion code a buyer types at checkout, when the Coupon has one. | |
redeemBy | datetime | The last moment it can be redeemed. | |
maxRedemptions | integer | How many times it can be redeemed across all Customers. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
coupon | Coupon | required | The Coupon. |
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. | None. |
Example
import { $ } from 'startup-builder'
const coupon = await $.Coupon.update({ id: 'coupon_rAfxMa2HGB', percentOff: 1 })