/api/administrator/subscriptions/set-subscription-default-tax-rates (PATCH)
Account information like email addresses is generated with faker-js it is not real user information.
await global.api.administrator.subscriptions.SetSubscriptionDefaultTaxRates.patch(req)Returns object
{
"subscriptionid": "sub_1LEOThHHqepMFuCXx819cWCp",
"object": "subscription",
"stripeObject": {
"id": "sub_1LEOThHHqepMFuCXx819cWCp",
"object": "subscription",
"application": null,
"application_fee_percent": null,
"automatic_tax": {
"enabled": false
},
"billing_cycle_anchor": 1656123125,
"billing_thresholds": null,
"cancel_at": null,
"cancel_at_period_end": false,
"canceled_at": null,
"collection_method": "charge_automatically",
"created": 1656123125,
"current_period_end": 1658715125,
"current_period_start": 1656123125,
"customer": "cus_LwH1ji83S8ugql",
"days_until_due": null,
"default_payment_method": "pm_1LEOTeHHqepMFuCX1nwsXrcI",
"default_source": null,
"default_tax_rates": [
{
"id": "txr_1LEOTlHHqepMFuCXFmf4vJtS",
"object": "tax_rate",
"active": true,
"country": "US",
"created": 1656123129,
"description": "Sales tax in NY",
"display_name": "NY Sales Tax",
"inclusive": true,
"jurisdiction": "US",
"livemode": false,
"metadata": {},
"percentage": 17.5,
"state": "NY",
"tax_type": "sales_tax"
},
{
"id": "txr_1LEOTlHHqepMFuCXnbeyzFNv",
"object": "tax_rate",
"active": true,
"country": "US",
"created": 1656123129,
"description": "Sales tax in NY",
"display_name": "NY Sales Tax",
"inclusive": true,
"jurisdiction": "US",
"livemode": false,
"metadata": {},
"percentage": 17.5,
"state": "NY",
"tax_type": "sales_tax"
}
],
"description": null,
"discount": null,
"ended_at": null,
"items": {
"object": "list",
"data": [
{
"id": "si_LwH1daPIfASdWE",
"object": "subscription_item",
"billing_thresholds": null,
"created": 1656123125,
"metadata": {},
"plan": {
"id": "price_1LEOTdHHqepMFuCXDx5t7uxP",
"object": "plan",
"active": true,
"aggregate_usage": null,
"amount": 1000,
"amount_decimal": "1000",
"billing_scheme": "per_unit",
"created": 1656123121,
"currency": "usd",
"interval": "month",
"interval_count": 1,
"livemode": false,
"metadata": {},
"nickname": null,
"product": "prod_LwH1DVjNbVxg2x",
"tiers_mode": null,
"transform_usage": null,
"trial_period_days": null,
"usage_type": "licensed"
},
"price": {
"id": "price_1LEOTdHHqepMFuCXDx5t7uxP",
"object": "price",
"active": true,
"billing_scheme": "per_unit",
"created": 1656123121,
"currency": "usd",
"custom_unit_amount": null,
"livemode": false,
"lookup_key": null,
"metadata": {},
"nickname": null,
"product": "prod_LwH1DVjNbVxg2x",
"recurring": {
"aggregate_usage": null,
"interval": "month",
"interval_count": 1,
"trial_period_days": null,
"usage_type": "licensed"
},
"tax_behavior": "inclusive",
"tiers_mode": null,
"transform_quantity": null,
"type": "recurring",
"unit_amount": 1000,
"unit_amount_decimal": "1000"
},
"quantity": 1,
"subscription": "sub_1LEOThHHqepMFuCXx819cWCp",
"tax_rates": []
}
],
"has_more": false,
"total_count": 1,
"url": "/v1/subscription_items?subscription=sub_1LEOThHHqepMFuCXx819cWCp"
},
"latest_invoice": "in_1LEOThHHqepMFuCXyTfGagW9",
"livemode": false,
"metadata": {},
"next_pending_invoice_item_invoice": null,
"pause_collection": null,
"payment_settings": {
"payment_method_options": null,
"payment_method_types": null,
"save_default_payment_method": "off"
},
"pending_invoice_item_interval": null,
"pending_setup_intent": null,
"pending_update": null,
"plan": {
"id": "price_1LEOTdHHqepMFuCXDx5t7uxP",
"object": "plan",
"active": true,
"aggregate_usage": null,
"amount": 1000,
"amount_decimal": "1000",
"billing_scheme": "per_unit",
"created": 1656123121,
"currency": "usd",
"interval": "month",
"interval_count": 1,
"livemode": false,
"metadata": {},
"nickname": null,
"product": "prod_LwH1DVjNbVxg2x",
"tiers_mode": null,
"transform_usage": null,
"trial_period_days": null,
"usage_type": "licensed"
},
"quantity": 1,
"schedule": null,
"start_date": 1656123125,
"status": "active",
"test_clock": null,
"transfer_data": null,
"trial_end": null,
"trial_start": null
},
"customerid": "cus_LwH1ji83S8ugql",
"accountid": "acct_88763ed51e0d6307",
"paymentmethodid": null,
"productid": null,
"priceids": [
"price_1LEOTdHHqepMFuCXDx5t7uxP"
],
"couponid": null,
"appid": "tests_1656123120",
"createdAt": "2022-06-25T02:12:07.872Z",
"updatedAt": "2022-06-25T02:12:11.014Z"
}
Exceptions
These exceptions are thrown (NodeJS) or returned as JSON (HTTP) if you provide incorrect data or do not meet the requirements:
Exception | Circumstances |
---|---|
invalid-subscriptionid | missing querystring subscriptionid |
invalid querystring subscriptionid | |
invalid-tax-rate | invalid posted tax-rate |
invalid-taxrateid | invalid posted taxrateid |
invalid-taxrateids | missing posted taxrateids |
NodeJS source (view on github)
const dashboard = require('@layeredapps/dashboard')
const subscriptions = require('../../../../../index.js')
const stripeCache = require('../../../../stripe-cache.js')
module.exports = {
patch: async (req) => {
if (!req.query || !req.query.subscriptionid) {
throw new Error('invalid-subscriptionid')
}
const subscription = await global.api.administrator.subscriptions.Subscription.get(req)
if (!subscription || (subscription.stripeObject.status !== 'active' && subscription.stripeObject.status !== 'trialing')) {
throw new Error('invalid-subscription')
}
if (!req.body || !req.body.taxrateids) {
throw new Error('invalid-taxrateids')
}
const taxRates = req.body.taxrateids.split(',')
for (const taxrateid of taxRates) {
req.query.taxrateid = taxrateid
const taxRate = await global.api.administrator.subscriptions.TaxRate.get(req)
if (!taxRate) {
throw new Error('invalid-taxrateid')
}
if (!taxRate.stripeObject.active) {
throw new Error('invalid-tax-rate')
}
}
const subscriptionNow = await stripeCache.execute('subscriptions', 'update', req.query.subscriptionid, {
default_tax_rates: taxRates
}, req.stripeKey)
await subscriptions.Storage.Subscription.update({
stripeObject: subscriptionNow
}, {
where: {
subscriptionid: subscriptionNow.id
}
})
await dashboard.StorageCache.remove(subscriptionNow.id)
return global.api.administrator.subscriptions.Subscription.get(req)
}
}
Test source (view on github)
/* eslint-env mocha */
const assert = require('assert')
const TestHelper = require('../../../../../test-helper.js')
const TestStripeAccounts = require('../../../../../test-stripe-accounts.js')
const DashboardTestHelper = require('@layeredapps/dashboard/test-helper.js')
describe('/api/administrator/subscriptions/set-subscription-default-tax-rates', function () {
before(TestHelper.disableMetrics)
after(TestHelper.enableMetrics)
let cachedResponses
async function bundledData (retryNumber) {
if (retryNumber > 0) {
cachedResponses = {}
}
if (cachedResponses && cachedResponses.finished) {
return
}
cachedResponses = {}
await TestHelper.setupBefore()
await DashboardTestHelper.setupBeforeEach()
await TestHelper.setupBeforeEach()
const administrator = await TestStripeAccounts.createOwnerWithPrice()
const user = await TestStripeAccounts.createUserWithPaidSubscription(administrator.price)
const taxRate1 = await TestHelper.createTaxRate(administrator)
const taxRate2 = await TestHelper.createTaxRate(administrator)
const taxRate3 = await TestHelper.createTaxRate(administrator, {
active: 'false'
})
// missing and invalid id
let req = TestHelper.createRequest('/api/administrator/subscriptions/set-subscription-default-tax-rates')
req.account = administrator.account
req.session = administrator.session
req.body = {
taxrateids: `${taxRate1.taxrateid},${taxRate2.taxrateid}`
}
try {
await req.patch()
} catch (error) {
cachedResponses.missing = error.message
}
req = TestHelper.createRequest('/api/administrator/subscriptions/set-subscription-default-tax-rates?subscriptionid=invalid')
req.account = administrator.account
req.session = administrator.session
req.body = {
taxrateids: `${taxRate1.taxrateid},${taxRate2.taxrateid}`
}
try {
await req.patch()
} catch (error) {
cachedResponses.invalid = error.message
}
// invalid taxrateid
req = TestHelper.createRequest(`/api/administrator/subscriptions/set-subscription-default-tax-rates?subscriptionid=${user.subscription.subscriptionid}`)
req.account = administrator.account
req.session = administrator.session
req.body = {
taxrateids: ''
}
try {
await req.patch()
} catch (error) {
cachedResponses.missingTaxRateIds = error.message
}
req = TestHelper.createRequest(`/api/administrator/subscriptions/set-subscription-default-tax-rates?subscriptionid=${user.subscription.subscriptionid}`)
req.account = administrator.account
req.session = administrator.session
req.body = {
taxrateids: 'invalid'
}
try {
await req.patch()
} catch (error) {
cachedResponses.invalidTaxRateIds = error.message
}
// invalid tax rate
req = TestHelper.createRequest(`/api/administrator/subscriptions/set-subscription-default-tax-rates?subscriptionid=${user.subscription.subscriptionid}`)
req.account = administrator.account
req.session = administrator.session
req.body = {
taxrateids: taxRate3.taxrateid
}
try {
await req.patch()
} catch (error) {
cachedResponses.invalidTaxRate = error.message
}
// returns
req = TestHelper.createRequest(`/api/administrator/subscriptions/set-subscription-default-tax-rates?subscriptionid=${user.subscription.subscriptionid}`)
req.account = administrator.account
req.session = administrator.session
req.body = {
taxrateids: `${taxRate1.taxrateid},${taxRate2.taxrateid}`
}
req.filename = __filename
req.saveResponse = true
cachedResponses.returns = await req.patch()
cachedResponses.finished = true
}
describe('exceptions', () => {
describe('invalid-subscriptionid', () => {
it('missing querystring subscriptionid', async function () {
await bundledData(this.test.currentRetry())
const errorMessage = cachedResponses.missing
assert.strictEqual(errorMessage, 'invalid-subscriptionid')
})
it('invalid querystring subscriptionid', async function () {
await bundledData(this.test.currentRetry())
const errorMessage = cachedResponses.invalid
assert.strictEqual(errorMessage, 'invalid-subscriptionid')
})
})
describe('invalid-taxrateids', () => {
it('missing posted taxrateids', async function () {
await bundledData(this.test.currentRetry())
const errorMessage = cachedResponses.missingTaxRateIds
assert.strictEqual(errorMessage, 'invalid-taxrateids')
})
})
describe('invalid-taxrateid', () => {
it('invalid posted taxrateid', async function () {
await bundledData(this.test.currentRetry())
const errorMessage = cachedResponses.invalidTaxRateIds
assert.strictEqual(errorMessage, 'invalid-taxrateid')
})
})
describe('invalid-tax-rate', () => {
it('invalid posted tax-rate', async function () {
await bundledData(this.test.currentRetry())
const errorMessage = cachedResponses.invalidTaxRate
assert.strictEqual(errorMessage, 'invalid-tax-rate')
})
})
})
describe('returns', () => {
it('object', async () => {
const subscriptionNow = cachedResponses.returns
assert.strictEqual(subscriptionNow.stripeObject.default_tax_rates.length, 2)
})
})
})