/api/administrator/subscriptions/charges (GET)
Account information like email addresses is generated with faker-js it is not real user information.
await global.api.administrator.subscriptions.Charges.get(req)Returns array
[
{
"chargeid": "ch_3LEOEqHHqepMFuCX0aV8aEK5",
"accountid": "acct_64315f6dd65984a6",
"subscriptionid": "sub_1LEOEqHHqepMFuCXw5gnis64",
"customerid": "cus_LwGmIkXV9Ttuvl",
"paymentmethodid": null,
"invoiceid": "in_1LEOEqHHqepMFuCX4qlC0fSh",
"refundRequested": null,
"refundReason": null,
"refundDenied": null,
"refundDeniedReason": null,
"object": "charge",
"stripeObject": {
"id": "ch_3LEOEqHHqepMFuCX0aV8aEK5",
"object": "charge",
"amount": 1000,
"amount_captured": 1000,
"amount_refunded": 0,
"application": null,
"application_fee": null,
"application_fee_amount": null,
"balance_transaction": "txn_3LEOEqHHqepMFuCX0BAMN4Ml",
"billing_details": {
"address": {
"city": "New York",
"country": "US",
"line1": "285 Fulton St",
"line2": "Apt 893",
"postal_code": "10007",
"state": "NY"
},
"email": null,
"name": "Nicholas Grimes",
"phone": null
},
"calculated_statement_descriptor": "PRODUCT135 DESCRIPTION",
"captured": true,
"created": 1656122205,
"currency": "usd",
"customer": "cus_LwGmIkXV9Ttuvl",
"description": "Subscription creation",
"destination": null,
"dispute": null,
"disputed": false,
"failure_balance_transaction": null,
"failure_code": null,
"failure_message": null,
"fraud_details": {},
"invoice": "in_1LEOEqHHqepMFuCX4qlC0fSh",
"livemode": false,
"metadata": {},
"on_behalf_of": null,
"order": null,
"outcome": {
"network_status": "approved_by_network",
"reason": null,
"risk_level": "normal",
"risk_score": 44,
"seller_message": "Payment complete.",
"type": "authorized"
},
"paid": true,
"payment_intent": "pi_3LEOEqHHqepMFuCX0RiCfHgV",
"payment_method": "pm_1LEOEnHHqepMFuCXXvxA1lL7",
"payment_method_details": {
"card": {
"brand": "visa",
"checks": {
"address_line1_check": "pass",
"address_postal_code_check": "pass",
"cvc_check": "pass"
},
"country": "US",
"exp_month": 1,
"exp_year": 2023,
"fingerprint": "IRcdqfBUCskmPkNV",
"funding": "credit",
"installments": null,
"last4": "1111",
"mandate": null,
"network": "visa",
"three_d_secure": null,
"wallet": null
},
"type": "card"
},
"receipt_email": null,
"receipt_number": null,
"receipt_url": "https://pay.stripe.com/receipts/acct_1KhiP8HHqepMFuCX/ch_3LEOEqHHqepMFuCX0aV8aEK5/rcpt_LwGmI9TN1cXQusJAbeTna3GqshnpfLe",
"refunded": false,
"refunds": {
"object": "list",
"data": [],
"has_more": false,
"total_count": 0,
"url": "/v1/charges/ch_3LEOEqHHqepMFuCX0aV8aEK5/refunds"
},
"review": null,
"shipping": null,
"source": null,
"source_transfer": null,
"statement_descriptor": "product135 description",
"statement_descriptor_suffix": null,
"status": "succeeded",
"transfer_data": null,
"transfer_group": null
},
"appid": "tests_1656122178",
"createdAt": "2022-06-25T01:56:47.553Z",
"updatedAt": "2022-06-25T01:56:47.701Z"
},
{
"chargeid": "ch_3LEOEjHHqepMFuCX10w059UH",
"accountid": "acct_db2a7d744f453644",
"subscriptionid": "sub_1LEOEiHHqepMFuCXH477WXeB",
"customerid": "cus_LwGm3eq344rKR9",
"paymentmethodid": null,
"invoiceid": "in_1LEOEiHHqepMFuCXBWcTZeQr",
"refundRequested": null,
"refundReason": null,
"refundDenied": null,
"refundDeniedReason": null,
"object": "charge",
"stripeObject": {
"id": "ch_3LEOEjHHqepMFuCX10w059UH",
"object": "charge",
"amount": 1000,
"amount_captured": 1000,
"amount_refunded": 0,
"application": null,
"application_fee": null,
"application_fee_amount": null,
"balance_transaction": "txn_3LEOEjHHqepMFuCX1olUkMwU",
"billing_details": {
"address": {
"city": "New York",
"country": "US",
"line1": "285 Fulton St",
"line2": "Apt 893",
"postal_code": "10007",
"state": "NY"
},
"email": null,
"name": "Bethany D'Amore",
"phone": null
},
"calculated_statement_descriptor": "PRODUCT135 DESCRIPTION",
"captured": true,
"created": 1656122197,
"currency": "usd",
"customer": "cus_LwGm3eq344rKR9",
"description": "Subscription creation",
"destination": null,
"dispute": null,
"disputed": false,
"failure_balance_transaction": null,
"failure_code": null,
"failure_message": null,
"fraud_details": {},
"invoice": "in_1LEOEiHHqepMFuCXBWcTZeQr",
"livemode": false,
"metadata": {},
"on_behalf_of": null,
"order": null,
"outcome": {
"network_status": "approved_by_network",
"reason": null,
"risk_level": "normal",
"risk_score": 60,
"seller_message": "Payment complete.",
"type": "authorized"
},
"paid": true,
"payment_intent": "pi_3LEOEjHHqepMFuCX1ebUSnDL",
"payment_method": "pm_1LEOEfHHqepMFuCXtyIQyU7F",
"payment_method_details": {
"card": {
"brand": "visa",
"checks": {
"address_line1_check": "pass",
"address_postal_code_check": "pass",
"cvc_check": "pass"
},
"country": "US",
"exp_month": 1,
"exp_year": 2023,
"fingerprint": "IRcdqfBUCskmPkNV",
"funding": "credit",
"installments": null,
"last4": "1111",
"mandate": null,
"network": "visa",
"three_d_secure": null,
"wallet": null
},
"type": "card"
},
"receipt_email": null,
"receipt_number": null,
"receipt_url": "https://pay.stripe.com/receipts/acct_1KhiP8HHqepMFuCX/ch_3LEOEjHHqepMFuCX10w059UH/rcpt_LwGmOR46cm9c2egzl22v7P92IM81PzT",
"refunded": false,
"refunds": {
"object": "list",
"data": [],
"has_more": false,
"total_count": 0,
"url": "/v1/charges/ch_3LEOEjHHqepMFuCX10w059UH/refunds"
},
"review": null,
"shipping": null,
"source": null,
"source_transfer": null,
"statement_descriptor": "product135 description",
"statement_descriptor_suffix": null,
"status": "succeeded",
"transfer_data": null,
"transfer_group": null
},
"appid": "tests_1656122178",
"createdAt": "2022-06-25T01:56:40.245Z",
"updatedAt": "2022-06-25T01:56:40.587Z"
},
{
"chargeid": "ch_3LEOEbHHqepMFuCX0iS5JWZu",
"accountid": "acct_6df3eaf4afdc974f",
"subscriptionid": "sub_1LEOEbHHqepMFuCX5H8XFzH4",
"customerid": "cus_LwGmGoQGug71hA",
"paymentmethodid": null,
"invoiceid": "in_1LEOEbHHqepMFuCXiV11nSEA",
"refundRequested": null,
"refundReason": null,
"refundDenied": null,
"refundDeniedReason": null,
"object": "charge",
"stripeObject": {
"id": "ch_3LEOEbHHqepMFuCX0iS5JWZu",
"object": "charge",
"amount": 1000,
"amount_captured": 1000,
"amount_refunded": 0,
"application": null,
"application_fee": null,
"application_fee_amount": null,
"balance_transaction": "txn_3LEOEbHHqepMFuCX0J9tpvGw",
"billing_details": {
"address": {
"city": "New York",
"country": "US",
"line1": "285 Fulton St",
"line2": "Apt 893",
"postal_code": "10007",
"state": "NY"
},
"email": null,
"name": "Myrtle Jast",
"phone": null
},
"calculated_statement_descriptor": "PRODUCT135 DESCRIPTION",
"captured": true,
"created": 1656122190,
"currency": "usd",
"customer": "cus_LwGmGoQGug71hA",
"description": "Subscription creation",
"destination": null,
"dispute": null,
"disputed": false,
"failure_balance_transaction": null,
"failure_code": null,
"failure_message": null,
"fraud_details": {},
"invoice": "in_1LEOEbHHqepMFuCXiV11nSEA",
"livemode": false,
"metadata": {},
"on_behalf_of": null,
"order": null,
"outcome": {
"network_status": "approved_by_network",
"reason": null,
"risk_level": "normal",
"risk_score": 50,
"seller_message": "Payment complete.",
"type": "authorized"
},
"paid": true,
"payment_intent": "pi_3LEOEbHHqepMFuCX0Ni6fgXf",
"payment_method": "pm_1LEOEYHHqepMFuCXDg7XVZw8",
"payment_method_details": {
"card": {
"brand": "visa",
"checks": {
"address_line1_check": "pass",
"address_postal_code_check": "pass",
"cvc_check": "pass"
},
"country": "US",
"exp_month": 1,
"exp_year": 2023,
"fingerprint": "IRcdqfBUCskmPkNV",
"funding": "credit",
"installments": null,
"last4": "1111",
"mandate": null,
"network": "visa",
"three_d_secure": null,
"wallet": null
},
"type": "card"
},
"receipt_email": null,
"receipt_number": null,
"receipt_url": "https://pay.stripe.com/receipts/invoices/CAcaFwoVYWNjdF8xS2hpUDhISHFlcE1GdUNYKNDW2ZUGMgbHztiWMvw6LBZCOQkXeOZZScllNFLtqIWIMF2ghDXDpVdEI5Hl_G7hkBbFG0WdbnwOsPCY?s=ap",
"refunded": false,
"refunds": {
"object": "list",
"data": [],
"has_more": false,
"total_count": 0,
"url": "/v1/charges/ch_3LEOEbHHqepMFuCX0iS5JWZu/refunds"
},
"review": null,
"shipping": null,
"source": null,
"source_transfer": null,
"statement_descriptor": "product135 description",
"statement_descriptor_suffix": null,
"status": "succeeded",
"transfer_data": null,
"transfer_group": null
},
"appid": "tests_1656122178",
"createdAt": "2022-06-25T01:56:32.829Z",
"updatedAt": "2022-06-25T01:56:33.162Z"
}
]Receives
API routes may receive parameters from the URL and POST supporting simple and multipart:
| Field | Value | Required | Type |
|---|---|---|---|
| all | boolean | optional | URL |
| limit | integer | optional | URL |
| offset | integer | optional | URL |
NodeJS source (view on github)
const subscriptions = require('../../../../../index.js')
module.exports = {
get: async (req) => {
req.query = req.query || {}
const where = {
appid: req.appid || global.appid
}
let chargeids
if (req.query.all) {
chargeids = await subscriptions.Storage.Charge.findAll({
where,
attributes: ['chargeid'],
order: [
['createdAt', 'DESC']
]
})
} else {
const offset = req.query.offset ? parseInt(req.query.offset, 10) : 0
const limit = req.query.limit ? parseInt(req.query.limit, 10) : global.pageSize
chargeids = await subscriptions.Storage.Charge.findAll({
where,
attributes: ['chargeid'],
offset,
limit,
order: [
['createdAt', 'DESC']
]
})
}
if (!chargeids || !chargeids.length) {
return null
}
const items = []
for (const chargeInfo of chargeids) {
req.query.chargeid = chargeInfo.dataValues.chargeid
const charge = await global.api.administrator.subscriptions.Charge.get(req)
items.push(charge)
}
return items
}
}
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/charges', function () {
before(TestHelper.disableMetrics)
after(TestHelper.enableMetrics)
let cachedResponses, cachedCharges
async function bundledData (retryNumber) {
if (retryNumber > 0) {
cachedResponses = {}
}
if (cachedResponses && cachedResponses.finished) {
return
}
cachedResponses = {}
cachedCharges = []
await TestHelper.setupBefore()
await DashboardTestHelper.setupBeforeEach()
await TestHelper.setupBeforeEach()
const administrator = await TestStripeAccounts.createOwnerWithPrice()
for (let i = 0, len = global.pageSize + 2; i < len; i++) {
const user = await TestStripeAccounts.createUserWithPaidSubscription(administrator.price)
cachedCharges.unshift(user.charge.chargeid)
}
const req = TestHelper.createRequest('/api/administrator/subscriptions/charges?offset=1')
req.account = administrator.account
req.session = administrator.session
cachedResponses.offset = await req.get()
const req2 = TestHelper.createRequest('/api/administrator/subscriptions/charges?limit=1')
req2.account = administrator.account
req2.session = administrator.session
cachedResponses.limit = await req2.get()
const req3 = TestHelper.createRequest('/api/administrator/subscriptions/charges?all=true')
req3.account = administrator.account
req3.session = administrator.session
cachedResponses.all = await req3.get()
const req4 = TestHelper.createRequest('/api/administrator/subscriptions/charges')
req4.account = administrator.account
req4.session = administrator.session
req4.filename = __filename
req4.saveResponse = true
cachedResponses.returns = await req4.get()
global.pageSize = 3
cachedResponses.pageSize = await req4.get()
global.pageSize = 2
cachedResponses.finished = true
}
describe('receives', () => {
it('optional querystring offset (integer)', async function () {
await bundledData(this.test.currentRetry())
const offset = 1
const chargesNow = cachedResponses.offset
for (let i = 0, len = global.pageSize; i < len; i++) {
assert.strictEqual(chargesNow[i].chargeid, cachedCharges[offset + i])
}
})
it('optional querystring limit (integer)', async function () {
await bundledData(this.test.currentRetry())
const limit = 1
const chargesNow = cachedResponses.limit
assert.strictEqual(chargesNow.length, limit)
})
it('optional querystring all (boolean)', async () => {
const chargesNow = cachedResponses.all
assert.strictEqual(chargesNow.length, cachedCharges.length)
})
})
describe('returns', () => {
it('array', async () => {
const chargesNow = cachedResponses.returns
assert.strictEqual(chargesNow.length, global.pageSize)
})
})
describe('configuration', () => {
it('environment PAGE_SIZE', async () => {
const chargesNow = cachedResponses.pageSize
assert.strictEqual(chargesNow.length, global.pageSize + 1)
})
})
})