Customer methods: activate, exempt
The Customer Verbs activate, exempt as typed SDK methods, with inputs, result, refusals and an example.
Reference for Customer, one group of Customer methods.
Customer.activate
Activate marks a Customer activated on an Offer once its declared activation Event reaches the count within the window. Verb page.
interface CustomerVerbs {
activate(input: CustomerActivateInput, options?: SB.CallOptions): SB.Call<Customer>
}Emits Customer.activated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
customer | Customer | required | The Customer who crossed the line. |
offer | Offer | required | The Offer whose activation was met. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
customer | Customer | required | The activated Customer. |
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 customer = await $.Customer.activate({ customer: 'cus_K1BROJhqzZ', offer: 'offer_2hzYe1ERo0' })Customer.exempt
Exempt records a Customer’s exemption or resale certificate, verifies it, and stops tax on its Orders where the certificate applies. Verb page.
interface CustomerVerbs {
exempt(input: CustomerExemptInput, options?: SB.CallOptions): SB.Call<CustomerExemptOutput>
}Emits Customer.exempted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
customer | Customer | required | The buying Customer. |
certificate | File | required | The certificate as uploaded through the Portal or received by email. |
jurisdictions | string[] | required | Where the certificate applies, such as US-TX. |
expiresOn | date | When the certificate lapses; empty when it does not. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
credential | Credential | required | The certificate, held by the Customer’s Organization. |
customer | Customer | required | The Customer, now exempt where the certificate applies. |
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 { credential, customer } = await $.Customer.exempt({ customer: 'cus_K1BROJhqzZ', certificate: 'file_V1AuhyCTsH', jurisdictions: ['US-TX'] })