Skip to content

by Startups.Studio

Growth Customer

Customer.exempt

POST /{namespace}/customers/{customer}/exempt

Exempt records a Customer’s exemption or resale certificate, verifies it, and stops tax on its Orders where the certificate applies.

Noun: Customer
Mode: do
Event: Customer.exempted

You, to your agent

Exempt the latest customer with a file.

curl -X POST https://api.sb/ledgerlark.com/customers/customer_1/exempt \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"certificate":"file_1","jurisdictions":["US-TX"]}'

import { $ } from 'startup-builder'

const { credential, customer } = await $.Customer.exempt({ customer: 'customer_1', certificate: 'file_1', jurisdictions: ['US-TX'] })

npx startup-builder do Customer.exempt --json '{"customer":"customer_1","certificate":"file_1","jurisdictions":["US-TX"]}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Customer.exempt({ customer: 'customer_1', certificate: 'file_1', jurisdictions: ['US-TX'] })"
  }
}

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.

Outputs

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.

Effects

Emits Customer.exempted.
Performed by the Finance Lead.
Two-way: it runs at once, in the try, send and do modes.
Verifies the certificate number with the issuing authority where it offers a lookup.
Every exempt Order carries the Credential in taxExemption.
Asks the Customer for a new certificate 30 days before it lapses.

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.	Customer.exempt

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

Customer.delete

Previous Page

Customer.get

Next Page